v8
Forguncy API Namespace Forguncy Forguncy API 名前空間

Forguncy 名前空間

Forguncyで使用可能なクラスやメソッドが含まれています。一部のメソッドは、プラグイン開発でのみ利用可能です。

変数

定数 CommandHelper

CommandHelper: ForguncyCommandHelper

定数 Helper

定数 Page

ForguncyPageのインスタンスを表します。

メソッド

ConvertDateToOADate

  • ConvertDateToOADate(date: Date): number
  • DateTimeオブジェクトを日付のシリアル値(OADate)に変換します。

    使用例
    // 現在の日時を取得する。
    var date = new Date();
    // DateTimeをOADateに変換する。
    var oaDate = Forguncy.ConvertDateToOADate(date);
    // 変換後のOADateをダイアログボックスに表示する。
    alert(oaDate);

    引数

    • date: Date

      変換したい日付のDateTimeオブジェクト

    戻り値 number

ConvertOADateToDate

  • ConvertOADateToDate(oadate: number): Date
  • 日付のシリアル値(OADate)からDateTimeオブジェクトに変換します。

    使用例
    // 本サンプルコードでは、ConvertOADateToDateメソッドをOADateの値をDateTimeオブジェクトへと変換する例を示します。
    // OADate値を取得する。
    var oaDate = 40000;
    // OADateをDateTimeに変換する。
    var date = Forguncy.ConvertOADateToDate(oaDate);
    // 変換後の日付をダイアログボックスに表示する。
    alert(date);

    引数

    • oadate: number

      変換したい日付のシリアル値(OADate)

    戻り値 Date

ConvertToCssColor

  • ConvertToCssColor(color: string): string
  • 指定された色のテキストを、CSSで使用可能な16進値に変換します。

    使用例
    // 本サンプルコードでは、ConvertToCssColorメソッドを使用して、Forguncy Builderのパレット上にある指定した色情報をCSSで使用可能な16進数のカラーコードに変換します。
    // 指定した色を変換する。
    var color = Forguncy.ConvertToCssColor("Accent 2 60 255");
    // 変換されたCSSカラーコードをダイアログボックスに表示する。
    alert(color);

    引数

    • color: string

      Forguncy Builderのパレット上に色情報を指定する文字列。文字列は次の4つの情報を空白文字で区切って表します。「色の名前(要下記の対比表参照)」、「色の番号」、「明るさ(白)/暗さ(黒)のパーセンテージ(暗い場合にはマイナス値)」、「透明度(0~255)」。「透明度」は省略可能で、省略した場合には255となります。

      パラメーターに指定する文字列 Forguncy Builderのパレット上の色の名前
      Background 背景
      Text テキスト
      Accent アクセント

      たとえば、「アクセント 1、白 + 基本色 40%」の色を指定したい場合、「Accent 1 40」をパラメーターとして指定します。

    戻り値 string

SendMail

  • SendMail(from: string, to: string, title: string, content: string, successCallBack: Function, failCallBack: Function): any
  • SendMail(to: string, title: string, content: string, successCallBack: Function, failCallBack: Function): any
  • SendMail(message: FgcMailMessage, successCallBack: Function, failCallBack: Function): any
  • 送信元と送信先、メールのタイトル、本文を指定してメールを送信します。本メソッドの使用にはメールサーバーの設定が必要です。

    使用例
    // プレーンテキストのメールを送信
    Forguncy.SendMail("example3@example.com", "example1@example.com", "発注警告メール", "在庫数が少なくなっています。在庫数が残りわずかとなりました。発注処理をこなってください。");
    
    // 複数の宛先にメールを送信
    Forguncy.SendMail("example3@example.com", "example1@example.com,example2@example.com", "発注警告メール", "在庫数が少なくなっています。在庫数が残りわずかとなりました。発注処理をこなってください。");
    
    // 本文にHTMLタグを含むメールの送信
    Forguncy.SendMail("example3@example.com", "example1@example.com", "発注警告メール", "<h1>在庫数が少なくなっています</h1><p>在庫数が残りわずかとなりました。発注処理をこなってください。</p>");
    
    // メール送信の成功の可否をコールバック関数で受け取る
    Forguncy.SendMail("example3@example.com", "example1@example.com", "title", "message",
        // 送信が成功すると、ダイアログボックスが表示され、メールが正常に送信されたことを示します。
        function(){
           alert("メールは正常に送信されました。");
        },
        // 送信が失敗すると、ダイアログボックスにエラーメッセージが表示されます。
        function(errorMessage){
           alert(errorMessage);
        }
    );

    引数

    • from: string

      送信元(差出人)のメールアドレスを指定。

    • to: string

      送信先(宛先)のメールアドレスを指定。カンマ区切りで複数の送信先を指定することができます。

    • title: string

      メールのタイトルを指定。

    • content: string

      メールの本文を指定。プレーンなテキストのほか、HTMLタグを含む文字列を指定することもできます。

    • successCallBack: Function

      メールの送信が成功したときに実行するコールバック関数を指定します。引数にはリクエスト結果が渡されます。このパラメーターは省略可能です。

    • failCallBack: Function

      メールの送信が失敗したときに実行するコールバック関数を指定します。 引数にエラーメッセージが渡されます。このパラメーターは省略可能です。

    戻り値 any

  • 送信先とメールのタイトル、本文を指定してメールを送信します。送信元は、その時アプリケーションにログインしているユーザーのメールアドレスが自動的に使用されます。そのため、ログインしていない状態やメールアドレスを持たないユーザーの場合には、このメソッドを使用できません。また、メールサーバーの設定が必要です。

    使用例
    // プレーンテキストのメールを送信
    Forguncy.SendMail("example1@example.com", "発注警告メール", "在庫数が少なくなっています。在庫数が残りわずかとなりました。発注処理をこなってください。");
    
    // 複数の宛先にメールを送信
    Forguncy.SendMail("example1@example.com,example2@example.com", "発注警告メール", "在庫数が少なくなっています。在庫数が残りわずかとなりました。発注処理をこなってください。");
    
    // 本文にHTMLタグを含むメールの送信
    Forguncy.SendMail("example1@example.com", "発注警告メール", "<h1>在庫数が少なくなっています</h1><p>在庫数が残りわずかとなりました。発注処理をこなってください。</p>");
    
    // メール送信の成功の可否をコールバック関数で受け取る
    Forguncy.SendMail("example1@example.com", "title", "message",
        // 送信が成功すると、ダイアログボックスが表示され、メールが正常に送信されたことを示します。
        function(){
           alert("メールは正常に送信されました。");
        },
        // 送信が失敗すると、ダイアログボックスにエラーメッセージが表示されます。
        function(errorMessage){
           alert(errorMessage);
        }
    );

    引数

    • to: string

      送信先(宛先)のメールアドレスを指定。カンマ区切りで複数の送信先を指定することができます。

    • title: string

      メールのタイトルを指定。

    • content: string

      メールの本文を指定。プレーンなテキストのほか、HTMLタグを含む文字列を指定することもできます。

    • successCallBack: Function

      メールの送信が成功したときに実行するコールバック関数を指定します。引数にはリクエスト結果が渡されます。このパラメーターは省略可能です。

    • failCallBack: Function

      メールの送信が失敗したときに実行するコールバック関数を指定します。引数にエラーメッセージが渡されます。このパラメーターは省略可能です。

    戻り値 any

  • FgcMailMessageオブジェクトを指定してメールを送信します。CCやBCC、添付ファイルなどより詳細な設定が必要なメールを送信したい場合に本メソッドを使用します。本メソッドを使用するためには、メールサーバーの設定が必要です。

    使用例
    // プレーンテキストのメールを送信
    var message = {
        From: "example3@example.com",
        To:"example1@example.com",
        CC: "cc1@example.com, cc2@example.com",
        BCC: "bcc1@example.com, bcc2@example.com",
        Attachments: Forguncy.Page.getCell("attachment").getValue(),
        Title:"発注警告メール",
        Content:"在庫数が少なくなっています。在庫数が残りわずかとなりました。発注処理をこなってください。",
        Priority: "High",
        SendAsPlainText: true
    }
    Forguncy.SendMail(message);
    
    // 複数の宛先にメールを送信
    var message = {
        To:"example1@example.com,example2@example.com",
        Title:"発注警告メール",
        Content:"在庫数が少なくなっています。在庫数が残りわずかとなりました。発注処理をこなってください。"
    }
    Forguncy.SendMail(message);
    
    // 本文にHTMLタグを含むメールの送信
    var message = {
        To:"example1@example.com",
        Title:"発注警告メール",
        Content:"<h1>在庫数が少なくなっています</h1><p>在庫数が残りわずかとなりました。発注処理をこなってください。</p>"
    }
    Forguncy.SendMail(message);
    
    // メール送信の成功の可否をコールバック関数で受け取る
    var message = {
        To:"example1@example.com",
        Title:"title",
        Content:, "message"
    }
    Forguncy.SendMail(message,
        // 送信が成功すると、ダイアログボックスが表示され、メールが正常に送信されたことを示します。
        function(){
           alert("メールは正常に送信されました。");
        },
        // 送信が失敗すると、ダイアログボックスにエラーメッセージが表示されます。
        function(errorMessage){
           alert(errorMessage);
        }
    );

    引数

    • message: FgcMailMessage

      FgcMailMessageオブジェクト。送信するメールの内容を設定します。

    • successCallBack: Function

      メールの送信が成功したときに実行するコールバック関数を指定します。引数にはリクエスト結果が渡されます。このパラメーターは省略可能です。

    • failCallBack: Function

      メールの送信が失敗したときに実行するコールバック関数を指定します。引数にエラーメッセージが渡されます。このパラメーターは省略可能です。

    戻り値 any

addTableData

  • addTableData(tableName: string, newValue: Object, callback: Function, errorCallback: Function): void
  • 指定したテーブルに対して追加したいレコードのフィールド名と値を指定し、1件のレコードを追加します。

    使用例
    // 本サンプルコードでは、addTableDataメソッドを使用して指定したテーブルにデータを追加する例を示します。
    Forguncy.addTableData("テーブル1",
        {
            // フィールド名と値を指定する。
            名前: "山田太郎",
            生年月日:"1993/3/1",
            部門: "開発部"
        },
        function (data) {
            // レコードの追加に成功した場合
            alert("レコードが1件追加されました。");
        },
        function (errorMessage) {
            // レコードの追加に失敗した場合
        }
    );

    引数

    • tableName: string

      追加したいデータが格納されているテーブルの名前。

    • newValue: Object

      追加したいレコードのフィールド名と値を指定。プロパティ名にフィールド名、値にそのフィールドの値を持つオブジェクトを指定します。すべてのフィールドを含めることは必要はなく、追加したいフィールドのみを含めることができます。

    • callback: Function

      レコードの追加が成功したときに実行するコールバック関数を指定します。引数には追加するオブジェクト(newValueパラメーターに指定した値)が渡されます。

    • errorCallback: Function

      レコードの追加が失敗したときに実行するコールバック関数を指定します。 引数にエラーメッセージが渡されます。なお、テーブル名の指定に誤りがあるなどのデータベースアクセスにおける構文エラーについては、本コールバック関数を使用してエラーをハンドルすることはできません。そのような場合のエラー内容については、HTTP応答ヘッダーの内容を確認する必要があります。

    戻り値 void

addUser

  • addUser(userName: string, password: string | Function, displayName: string | Function, email: string | Function, successCallback: Function, errorCallback: Function): void
  • このメソッドを使用して、フォーム認証、およびWindows認証におけるユーザーを追加します。

    使用例
    // 本サンプルコードでは、addUserメソッドを使用してユーザーを追加します。
    // フォーム認証のユーザーを追加する。
    Forguncy.addUser("taro", "123456", "山田太郎", "taro@example.com",
        function () {
            alert("ユーザーが追加されました。")
        },
        function (error) {
            alert(error)
        });
    // Windows認証のユーザーを追加する。
    Forguncy.addUser("taro",
        function () {
            alert("ユーザーが追加されました。")
        },
        function (error) {
            alert(error)
        });

    引数

    • userName: string

      追加したいユーザーのユーザー名。

    • password: string | Function

      追加したいユーザーのパスワード。Windows認証のユーザーを追加する場合、このパラメーターは指定しません。

    • displayName: string | Function

      追加したいユーザーの氏名。Windows認証のユーザーを追加する場合、このパラメーターは指定しません。

    • email: string | Function

      追加したいユーザーのメールアドレス。Windows認証のユーザーを追加する場合、このパラメーターは指定しません。

    • successCallback: Function

      ユーザーの追加が成功したときに実行するコールバック関数を指定します。

    • errorCallback: Function

      ユーザーの追加が失敗したときに実行するコールバック関数を指定します。 引数にエラーメッセージが渡されます。

    戻り値 void

addUserToRole

  • addUserToRole(userName: string, roleName: string, successCallback: Function, errorCallback: Function): void
  • ロールを指定してユーザーを追加します。ユーザーはすでに存在しているユーザーである必要があります。フォーム認証のユーザーとWindows認証のユーザーのどちらのユーザーでも指定可能です。

    使用例
    // 本サンプルコードでは、addUserToRoleメソッドを使用して指定されたユーザーを指定されたロールに追加します。
    Forguncy.addUserToRole("user1", "マネージャー",
        function () {
            alert("ロールにユーザーが追加されました。");
        },
        function (errorMessage) {
            alert(errorMessage);
        }
    );

    引数

    • userName: string

      ロールへ追加したいユーザーのユーザー名。

    • roleName: string

      追加したいロールの名称。

    • successCallback: Function

      ロールへのユーザーの追加が成功したときに実行するコールバック関数を指定します。

    • errorCallback: Function

      ロールへのユーザーの追加が失敗したときに実行するコールバック関数を指定します。 引数にエラーメッセージが渡されます。

    戻り値 void

deleteTableData

  • deleteTableData(tableName: string, primaryKey: Object, callback: Function, errorCallback: Function): void
  • 指定したテーブルに対してレコードが一意になるフィールド名と値を指定し、1件のレコード内容を削除します。

    使用例
    // 本サンプルコードでは、deleteTableDataメソッドを使用して指定した一意のレコードを削除する例を示します。
    Forguncy.deleteTableData("テーブル1", { "ID": 2 },
        function () {
            // レコードの削除に成功した場合
            alert("レコードが1件削除されました。");
        },
        function (errorMessage) {
            // レコードの削除に失敗した場合
            alert(errorMessage);
        }
    );
    // 複数のフィールドを組み合わせて一意なレコードを特定する場合、以下のようなコードを使用します。
    Forguncy.deleteTableData("テーブル1", { "ID": 2, "名前" : "山田太郎"  },
        function () {
            // レコードの削除に成功した場合
            alert("レコードが1件削除されました。");
        },
        function (errorMessage) {
            // レコードの削除に失敗した場合
            alert(errorMessage);
        }
    );

    引数

    • tableName: string

      削除したいデータが格納されているテーブルの名前。

    • primaryKey: Object

      削除対象のレコードにおいて一意となるフィールド名と値を指定。プロパティ名にフィールド名、値にそのフィールドの値を持つオブジェクトを指定します。指定するフィールドが必ずしもデータベース上で一意制約を持つフィールドである必要はありません。

    • callback: Function

      レコードの削除が成功したときに実行するコールバック関数を指定します。

    • errorCallback: Function

      レコードの削除が失敗したときに実行するコールバック関数を指定します。 引数にエラーメッセージが渡されます。なお、テーブル名の指定に誤りがあるなどのデータベースアクセスにおける構文エラーについては、本コールバック関数を使用してエラーをハンドルすることはできません。そのような場合のエラー内容については、HTTP応答ヘッダーの内容を確認する必要があります。

    戻り値 void

deleteUser

  • deleteUser(userName: string, successCallback: Function, errorCallback: Function): void
  • ユーザー名を指定して、ユーザーを削除します。フォーム認証のユーザーとWindows認証のユーザーのどちらのユーザーも削除できます。

    使用例
    // 本サンプルコードでは、deleteUserメソッドを使用して指定したユーザーを削除します。
    Forguncy.deleteUser("user1",
        function () {
            alert("ユーザーが削除されました。");
        },
        function (errorMessage) {
            alert(errorMessage);
        }
    );

    引数

    • userName: string

      削除したいユーザーのユーザー名。

    • successCallback: Function

      ユーザーの削除が成功したときに実行するコールバック関数を指定します。

    • errorCallback: Function

      ユーザーの削除が失敗したときに実行するコールバック関数を指定します。 引数にエラーメッセージが渡されます。

    戻り値 void

deleteUserFromRole

  • deleteUserFromRole(userName: string, roleName: string, successCallback: Function, errorCallback: Function): void
  • ロールを指定してユーザーを削除します。ユーザーはすでに指定したロールのメンバーである必要があります。フォーム認証のユーザーとWindows認証のユーザーのどちらのユーザーでも指定可能です。

    使用例
    // 本サンプルコードでは、deleteUserFromRoleメソッドを使用して指定したユーザーを指定したロールから削除します。
    Forguncy.deleteUserFromRole("user1", "マネージャー",
        function () {
            alert("ユーザーがロールから削除されました。");
        },
        function (errorMessage) {
            alert(errorMessage);
        }
    );

    引数

    • userName: string

      ロールから削除したいユーザーのユーザー名。

    • roleName: string

      ユーザーをロールから削除したい場合のそのロールの名称。

    • successCallback: Function

      ロールからユーザーの削除が成功したときに実行するコールバック関数を指定します。

    • errorCallback: Function

      ロールからユーザーの削除が失敗したときに実行するコールバック関数を指定します。 引数にエラーメッセージが渡されます。

    戻り値 void

forceSyncTableData

  • forceSyncTableData(tableName: string, callback: Function): void
  • コピーテーブルの同期処理を行いデータを最新状態にします。

    使用例
    Forguncy.forceSyncTableData("コピーテーブル1", function(data){
        if(data){
             if(data.Success){
                 alert("同期処理が正常に完了しました。");
             } else{
                 alert("同期処理が失敗しました。エラーメッセージ:" + data.ErrorMessage);
             }
         }
      });

    引数

    • tableName: string

      対象のコピーテーブルの名前

    • callback: Function

      同期処理が行われた後のコールバック関数。

    戻り値 void

getTableData

  • getTableData(tableName: string, primaryKey: Object, callback: Function, errorCallback: Function): void
  • 指定したテーブルに対してレコードが一意になるフィールド名と値を指定し、1件のレコード内容を取得します。

    使用例
    // 本サンプルコードでは、getTableDataメソッドを使用してテーブルのデータを取得する例を示します。
    Forguncy.getTableData("テーブル1", {"ID":2},
        function(data){
            Forguncy.Page.getCell("textBoxCell1").setValue(data.フィールド1);
        },
        function(errorMessage){
            alert(errorMessage);
        }
    );
    // テーブルが複数の列を使用して一意の行を識別する必要がある場合、サンプルコードは次のとおりです。
    Forguncy.getTableData("テーブル1", { "ID1": 2, "名前" : "山田太郎"  },
        function(data){
            Forguncy.Page.getCell("textBoxCell1").setValue(data.フィールド1);
        },
        function(errorMessage){
            alert(errorMessage);
        }
    );

    引数

    • tableName: string

      取得したいデータが格納されているテーブルの名前。

    • primaryKey: Object

      取得対象のレコードにおいて一意となるフィールド名と値を指定。プロパティ名にフィールド名、値にそのフィールドの値を持つオブジェクトを指定します。指定するフィールドが必ずしもデータベース上で一意制約を持つフィールドである必要はありません。

    • callback: Function

      レコードの取得が成功したときに実行するコールバック関数を指定します。引数にはリクエスト結果が渡されます。

    • errorCallback: Function

      レコードの取得が失敗したときに実行するコールバック関数を指定します。 引数にエラーメッセージが渡されます。なお、テーブル名の指定に誤りがあるなどのデータベースアクセスにおける構文エラーについては、本コールバック関数を使用してエラーをハンドルすることはできません。そのような場合のエラー内容については、HTTP応答ヘッダーの内容を確認する必要があります。

    戻り値 void

getTableDataByCondition

  • テーブルまたはビューのデータを条件を基に取得します。本メソッドはプラグイン開発のために用意されており、通常のカスタムJavaScriptコード内で使用することはできません。

    使用例
    // 本サンプルコードでは、getTableDataByConditionメソッドを使用してテーブルのデータを取得する例を示します。
    // データのパラメーターを取得する。
    var param = {
        TableName: "テーブル1",   // テーブル名
        Columns: ["ID", "名前"],    // 取得したいフィールド名の配列
        QueryCondition: ISqlCondition,    // Forguncy Builderで設定したクエリ条件
        QueryPolicy: {
            Distinct: true,
            QueryNullPolicy: Forguncy.QueryNullPolicy.QueryAllItemsWhenValueIsNull,
            IgnoreCache: false
        },
        SortCondition: ISqlCondition    // Forguncy Builderで設定された並べ替え条件
    };
    
    var formulaCalcContext = {
        IsInMasterPage: false    // 数式で参照されているセルまたはセル範囲がマスターページにあるかどうか
    };
    
    // テーブルのデータを取得する。
    Forguncy.getTableDataByCondition(param, formulaCalcContext, function(dataStr){
        var tableData = JSON.parse(dataStr);
    }, true);

    引数

    • condition: GetTableDataByConditionParams

      データの取得方法に関するパラメータ。

    • formulaCalcContext: FormulaCalcContext

      数式によって計算されたコンテキスト情報。取得されたパラメーターのクエリー条件に数式が含まれている場合、数式によって計算された結果が使用されます。

    • callBack: Function

      レコードの取得が成功したときに実行するコールバック関数を指定します。引数にはリクエスト結果が渡されます。

    • オプション async: boolean

      リクエストを非同期にするかどうか設定します。デフォルトはtrue(非同期)です。

    戻り値 void

getTableDataByOData

  • getTableDataByOData(odataParam: string, callback: Function, errorCallback: Function, async?: boolean): void
  • 指定したODataのリソースパスを使用して、レコード内容を取得します。

    使用例
    // 本サンプルコードでは、getTableDataByODataメソッドを使用して「Caterories」テーブルのレコード数を取得し、「countLabel」という名前が付いたセルに値として設定する例を示します。
    Forguncy.getTableDataByOData("Categories/$count",
        // 成功した場合のコールバック処理
        function (data) {//データ型 Type:object
            Forguncy.Page.getCell("countLabel").setValue(data);
        },
        // エラー時のコールバック処理
        function (e) {
            alert(e);
        });
    // 本サンプルコードでは、getTableDataByODataメソッドを使用して「Caterories」テーブルの全レコードを取得し、表示に適切な内容に整形したうえで「resultLabel」という名前が付いたセルに値として設定する例を示します。
    Forguncy.getTableDataByOData("Categories",
        // 成功した場合のコールバック処理
        function (data) {//データ型 Type:List&lt;Dictionary&lt;string, object&gt;&gt;
            var str = "";
            for (var index = 0; index < data.length; index++) {
            var rowData = data[index];
            str += "ID:" + rowData["Category ID"] + "\r\n" +
                "カテゴリ名:" + rowData["Category Name"] + "\r\n" +
                "説明:" + rowData["Description"] + "\r\n\r\n"
            }
            Forguncy.Page.getCell("resultLabel").setValue(str);
        },
        // エラー時のコールバック処理
        function (e) {
            alert(e);
        });
    // 本サンプルコードでは、getTableDataByODataメソッドを使用して「テーブル1」テーブルの指定したレコードを取得する例を示します。
    Forguncy.getTableDataByOData("テーブル1?$select=*&$filter=ID gt 5",
        // 取得に成功した場合の処理
        function(data){
            for(var i = 0; i < data.length; i++)
            {
                var id = data[i]["ID"];
                var name = data[i]["名前"];
                console.log("ID=" + id + "; Name=" + name);
            }
        },
        // 取得に失敗した場合の処理
        function(errorMessage){
            alert(errorMessage);
        }
    );

    引数

    • odataParam: string

      ODataのリソースパスを指定します。ルートURIは含めず、リソースパス以降を指定してください。

    • callback: Function

      レコードの取得が成功したときに実行するコールバック関数を指定します。引数にはリクエスト結果が渡されます。

    • errorCallback: Function

      レコードの取得が失敗したときに実行するコールバック関数を指定します。 引数にエラーメッセージが渡されます。なお、テーブル名の指定に誤りがあるなどのデータベースアクセスにおける構文エラーについては、本コールバック関数を使用してエラーをハンドルすることはできません。そのような場合のエラー内容については、HTTP応答ヘッダーの内容を確認する必要があります。

    • オプション async: boolean

      リクエストを非同期にするかどうか指定します。デフォルトはtrue(非同期)です。

    戻り値 void

logIn

  • logIn(username: string, password: string, rememberMe?: boolean, successCallback?: Function, errorCallback?: Function): any
  • 指定したユーザー名とそのパスワードでログインします。本メソッドは、認証モードが「フォーム認証」の場合にのみ使用可能です。

    引数

    • username: string

      ユーザー名

    • password: string

      パスワード

    • オプション rememberMe: boolean

      [ログインしたままにする]チェックオプションを有効にするかどうかを指定します。既定値は「false」です。

    • オプション successCallback: Function

      ログイン要求が成功した場合に実行されるコールバック関数。コールバック関数を指定しない場合、Webブラウザー上のページはすぐに更新されます。

    • オプション errorCallback: Function

      ログイン要求が失敗した場合に実行されるコールバック関数。

    戻り値 any

logOut

  • logOut(navigateToHomePage?: boolean): any
  • 現在のユーザーをログアウトします。本メソッドは、認証モードが「フォーム認証」の場合、または「SAML 2.0用認証プロバイダー」を使用している場合にのみ使用可能です。

    引数

    • オプション navigateToHomePage: boolean

      ログアウト後、スタートページに戻るかどうかを指定します。値を指定しない、もしくは「false」を指定した場合、Webブラウザー上のページはすぐに更新されます。

    戻り値 any

modifyTablesData

  • modifyTablesData(modifyData: Object, callback: Function, errorCallback: Function): void
  • 指定した更新レコード情報に基づき、複数レコードを一括更新します。更新は新規追加、編集、削除の3つの処理すべてを含むことが可能です。
    たとえば、addTableDataメソッドを使用してデータを1,000行追加する場合、サーバーに対して1,000件のリクエストが送信されます。この方法の場合、大量のリクエストが発生するだけでなく、そのうちの1回が失敗した場合であってもすべてをキャンセルできないという問題があります。本メソッドを使用することで、そのような問題を回避できます。

    使用例
    // テーブル1とテーブル2にレコードを追加します。
    Forguncy.modifyTablesData({
        テーブル1: {
            addRows: [
                {
                    名前: "山田太郎",
                    部門: "開発部"
                },
                {
                    名前: "鈴木花子",
                    部門: "総務部"
                },
            ]
        },
        テーブル2: {
            addRows: [
                {
                    名前: "佐々木一郎",
                    部門: "マーケティング部"
                },
                {
                    名前: "斎藤次郎",
                    部門: "マーケティング部"
                },
            ]
        }
    });
    // テーブル1とテーブル2からそれぞれ2レコードずつ削除します。
    Forguncy.modifyTablesData({
        テーブル1: {
            deleteRows: [
                {
                    ID: 2
                },
                {
                    ID: 3
                },
            ]
        },
        テーブル2: {
            deleteRows:  [
                {
                    ID: 3
                },
                {
                    ID: 4
                },
            ]
        }
    });
    // テーブル1とテーブル2の複数件のレコードを一括更新します。
    Forguncy.modifyTablesData({
        テーブル1: {
            editRows: [
                {
                    primaryKey:
                    {
                        ID: 2
                    },
                    values: {
                        名前: "山田太郎",
                        部門: "開発部"
                    }
                },
                {
                    primaryKey:
                    {
                        ID: 3
                    },
                    values: {
                        名前: "鈴木花子",
                        部門: "総務部"
                    }
                },
            ]
        },
        テーブル2: {
            editRows: [
                {
                    primaryKey:
                    {
                        ID: 3
                    },
                    values: {
                        名前: "佐々木一郎",
                        部門: "マーケティング部"
                    }
                },
                {
                    primaryKey:
                    {
                        ID: 4
                    },
                    values: {
                        名前: "斎藤次郎",
                        部門: "マーケティング部"
                    }
                },
            ]
        }
    });
    // テーブル1に対して複数レコードの追加、複数レコードの削除、複数レコードの更新を一括で行います。
    Forguncy.modifyTablesData({
        テーブル1: {
            addRows: [
                {
                    名前: "佐々木一郎",
                    部門: "マーケティング部"
                },
                {
                    名前: "斎藤次郎",
                    部門: "マーケティング部"
                },
            ],
            deleteRows: [
                {
                    ID: 2
                },
                {
                    ID: 3
                },
            ],
            editRows: [
                {
                    primaryKey:
                    {
                        ID: 2
                    },
                    values: {
                        名前: "山田太郎",
                        部門: "開発部"
                    }
                },
                {
                    primaryKey:
                    {
                        ID: 3
                    },
                    values: {
                        名前: "鈴木花子",
                        部門: "総務部"
                    }
                },
            ]
        }
    });

    引数

    • modifyData: Object

      どのテーブルに対して、どの行のどの列を追加/変更/削除するかを含むModifyDataオブジェクトを指定します。

    • callback: Function

      レコードの一括更新が成功したときに実行するコールバック関数を指定します。

    • errorCallback: Function

      レコードの一括更新が失敗したときに実行するコールバック関数を指定します。 引数にエラーメッセージが渡されます。なお、テーブル名の指定に誤りがあるなどのデータベースアクセスにおける構文エラーについては、本コールバック関数を使用してエラーをハンドルすることはできません。そのような場合のエラー内容については、HTTP応答ヘッダーの内容を確認する必要があります。

    戻り値 void

updateTableData

  • updateTableData(tableName: string, primaryKey: Object, updateValue: Object, callback: Function, errorCallback: Function): void
  • 指定したテーブルに対してレコードが一意になるフィールド名と値、追加したいレコードのフィールド名と値を指定し、1件のレコードを更新します。

    使用例
    // 本サンプルコードでは、updateTableDataメソッドを使用してテーブルのデータを更新する例を示します。
    Forguncy.updateTableData("テーブル1", { "ID": 2 }, { 名前: "山田太郎", 部門: "開発部" },
        function (data) {
            // レコードの更新に成功した場合
            alert("レコードが1件更新されました。");
        },
        function (errorMessage) {
            // レコードの更新に失敗した場合
            alert(errorMessage);
        }
    );
    // 複数のフィールドを組み合わせて一意なレコードを特定する場合、以下のようなコードを使用します。
    Forguncy.updateTableData("ListView1", { "ID": 2, 名前: "山田太郎" }, { 部門: "開発部" },
        function (data) {
            // レコードの更新に成功した場合
            alert("レコードが1件更新されました。");
        },
        function (errorMessage) {
            // レコードの更新に失敗した場合
            alert(errorMessage);
        }
    );

    引数

    • tableName: string

      更新したいデータが格納されているテーブルの名前。

    • primaryKey: Object

      更新対象のレコードにおいて一意となるフィールド名と値を指定。プロパティ名にフィールド名、値にそのフィールドの値を持つオブジェクトを指定します。指定するフィールドが必ずしもデータベース上で一意制約を持つフィールドである必要はありません。

    • updateValue: Object

      対象レコードの更新後のフィールド名と値を指定。プロパティ名にフィールド名、値にそのフィールドの値を持つオブジェクトを指定します。すべてのフィールドを含めることは必要はなく、更新したいフィールドのみを含めることができます。

    • callback: Function

      レコードの更新が成功したときに実行するコールバック関数を指定します。引数には追加するオブジェクト(newValueパラメーターに指定した値)が渡されます。

    • errorCallback: Function

      レコードの更新が失敗したときに実行するコールバック関数を指定します。 引数にエラーメッセージが渡されます。なお、テーブル名の指定に誤りがあるなどのデータベースアクセスにおける構文エラーについては、本コールバック関数を使用してエラーをハンドルすることはできません。そのような場合のエラー内容については、HTTP応答ヘッダーの内容を確認する必要があります。

    戻り値 void