プラグインに設定を保存する
キーと値を対にしたオブジェクト形式でプラグインに設定を保存します。
関数
garoon.plugin.setConfig(config, successCallback)
使用可能なガルーンバージョン
- クラウド版 Garoon
引数
| 引数 | 型 | 必須 | 説明 |
|---|---|---|---|
| config | オブジェクト | 必須 |
キーと値を対にしたオブジェクトの形式で、プラグインに保存する設定を指定します。 例： {
|
| successCallback | 関数 | 設定の保存が完了した後に実行する関数を指定します。 引数はありません。 未指定、undefined または null を指定した場合、設定の保存が完了すると「プラグインの詳細」画面に遷移します。 |
返り値
なし
実行できる画面
- 各プラグインの詳細設定画面
サンプルコード
制限事項
- garoon.plugin.setConfig() で保存できる config のサイズは 256KB までです。
補足
- この API で保存した内容は、ユーザーが プラグインの設定情報を取得する API を実行することで取得できます。
他システムと連携するための認証情報などユーザーに見せたくない情報は、
「プロキシ API の設定」画面 の「パラメーター」や「ヘッダー」項目に保存してください。
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。