Server Hook（スケジュール起動）のパラメーター

ここでは、Server Code のエンドポイントが Server Hook（スケジュール起動）によって呼び出された際の関数のパラメーターを示します。

Server Code の書式に示すように、エンドポイントは以下のような形式です。

// Synchronous function
function funcName(params, context) {
  // Your code comes here...
}

// Asynchronous function
function funcName(params, context, done) {
  // Your code comes here...
}

関数名 funcName はエンドポイント名になります。Server Code をコマンドラインツールで登録する際、このエンドポイント名を用いてスケジュール起動する日時と対象関数を関連付けます。
第 1 引数 params は、Server Hook 設定ファイルで記述したパラメータの値が渡されます。たとえば、スケジュール起動に "arg1" : "xxxx" と記述されていた場合、params.arg1 より xxxx を取得できます。
第 2 引数 context はアプリケーション関連パラメータ取得のために使用します。
- getAppID メソッドを使うと AppID が取得できます。
- getAppKey メソッドを使うと AppKey が取得できます。
- getAccessToken メソッドは常に null を返します。
- getAppAdminContext メソッドを使うとアプリ管理者のコンテキスト（KiiAppAdminContext）が取得できます。このコンテキストのメソッドからユーザーやグループの操作をアプリ管理者権限で実行できます（サンプルはこちら）。
第 3 引数 done は非同期的な実行の場合に、Server Code の実行を完了するためのコールバック関数です。引数値は下記に示す戻り値として記録されます。詳細は非同期的な実行を参照してください。

スケジュール起動では、Server Code からの戻り値は実行履歴に保存され、コマンドラインツールを使って確認できます。呼び出された関数の return で指定された値（同期的な実行の場合）、または、第 3 引数 done への引数値（非同期的な実行の場合）が記録されます。