Garoon JavaScript API
固定リンクがコピーされました
スケジュール
固定リンクがコピーされました
イベント
固定リンクがコピーされました
表示イベント
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| 予定の登録画面を表示した後 | schedule.event.create.show | 〇 | 4.10以降 |
| 予定の変更画面を表示した後 | schedule.event.edit.show | 〇 | 4.10以降 |
| 予定の詳細画面を表示した後 | schedule.event.detail.show | 〇 | 4.10以降 |
| グループ日画面を表示した後 | schedule.calendar.groupDayIndex.show | 〇 | 4.10以降 |
| グループ週画面を表示したとき | schedule.calendar.groupWeekIndex.show | 〇 | 4.6以降 |
| 日画面を表示した後 | schedule.calendar.dayIndex.show | 〇 | 4.10以降 |
| 週画面を表示したとき | schedule.calendar.weekIndex.show | 〇 | 4.10以降 |
| 月画面を表示したとき | schedule.calendar.monthIndex.show | 〇 | 4.10以降 |
登録イベント
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| 予定を登録するとき | schedule.event.create.submit | 〇 | 5.0以降 |
| 予定の登録に成功したとき | schedule.event.create.submit.success | 〇 | 5.9以降 |
| ポップアップウィンドウで予定の登録に成功したとき | schedule.event.quick.create.submit.success | 〇 | 5.9以降 |
変更イベント
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| 予定を変更するとき | schedule.event.edit.submit | 〇 | 5.0以降 |
| 予定の変更に成功したとき | schedule.event.edit.submit.success | 〇 | 5.9以降 |
| ドラッグ＆ドロップで予定の変更に成功したとき | schedule.event.quick.edit.submit.success | 〇 | 5.9以降 |
削除イベント
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| 予定を削除するとき | schedule.event.delete.submit | 〇 |
5.9以降 |
| 予定の削除に成功したとき | schedule.event.delete.submit.success | 〇 |
5.9以降 |
予定に参加したとき、抜けたときのイベント
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| 予定の参加に成功したとき | schedule.event.attend.submit.success | 〇 | 5.15以降 |
| 予定から抜けることに成功したとき | schedule.event.leave.submit.success | 〇 | 5.15以降 |
情報の取得・設定
固定リンクがコピーされました
値の取得や設定
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| 予定の値を取得する | garoon.schedule.event.get() | 〇 | 4.10以降 |
| 予定の値をセットする | garoon.schedule.event.set() | 〇 | 4.10以降 |
| カスタム項目（Schedule datastore）の値を取得する | garoon.schedule.event.datastore.get() | 〇 |
5.9以降 |
| カスタム項目（Schedule datastore）の値をセットする | garoon.schedule.event.datastore.set() | 〇 |
5.9以降 |
要素の取得や設定
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| 予定枠最上部の要素を取得する | garoon.schedule.calendar.getDayFirstSpaceElement() | 〇 | 4.10以降 |
| 予定の詳細／登録／変更画面のヘッダー部分の要素を取得する | garoon.schedule.event.getHeaderSpaceElement() | 〇 | 4.10以降 |
| 予定の詳細画面のテーブルに行を追加する | garoon.schedule.event.insertTableRow() | 〇 | 5.5 以降 |
メッセージ
固定リンクがコピーされました
イベント
固定リンクがコピーされました
表示イベント
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| メッセージの作成画面を表示したとき | message.body.create.show | 〇 | 5.0以降 |
| メッセージの宛先変更画面を表示したとき | message.body.changeTo.show | 〇 | 5.0以降 |
情報の取得・設定
固定リンクがコピーされました
値の取得や設定
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| メッセージの値をセットする | garoon.message.body.set() | 〇 | 5.0以降 |
要素の取得や設定
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| メッセージの「宛先」下の要素を取得する | garoon.message.body.getItemLastSpaceElement() | 〇 | 5.0以降 |
ワークフロー
固定リンクがコピーされました
イベント
固定リンクがコピーされました
表示イベント
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| ワークフロー申請の作成画面を表示したとき | workflow.request.create.show | 〇 | 4.6以降 |
| ワークフロー申請の詳細画面を表示したとき | workflow.request.detail.show | 〇 | 4.6以降 |
| ワークフロー申請の承認画面を表示したとき | workflow.request.approve.show | 〇 | 4.6以降 |
| ワークフロー申請の印刷用画面を表示したとき | workflow.request.print.show | 〇 | 4.6以降 |
提出／承認／確認イベント
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| ワークフロー申請を提出したとき | workflow.request.create.submit.success | 〇 | 5.15以降 |
| ワークフロー申請を承認したとき | workflow.request.approve.submit.success | 〇 | 4.10以降 |
| ワークフロー申請を確認したとき | workflow.request.acknowledge.submit.success | 〇 | 5.15以降 |
情報の取得・設定
固定リンクがコピーされました
値の取得や設定
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| 申請データの値を取得する | garoon.workflow.request.get() | 〇 | 4.6以降 |
| 申請データに値をセットする | garoon.workflow.request.set() | 〇 | 4.6以降 |
要素の取得や設定
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| 申請フォーム項目の編集可／不可を切り替える | garoon.workflow.request.setItemEditable() | 〇 | 5.0以降 |
| JavaScriptカスタマイズ用項目の要素を取得する | garoon.workflow.request.getSpaceElement() | 〇 | 4.6以降 |
ユーザー
固定リンクがコピーされました
情報の取得・設定
固定リンクがコピーされました
値の取得や設定
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| ログインユーザーの情報を取得する | garoon.base.user.getLoginUser | 〇 | 4.10以降 |
プロフィール
固定リンクがコピーされました
イベント
固定リンクがコピーされました
ポップアップダイアログ表示イベント
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| プロフィールのポップアップダイアログを表示した後 | profile.dialog.show | 〇 | × *1 |
要素の取得や設定
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| プロフィールのポップアップダイアログの下側の要素を取得する | garoon.profile.dialog.getFooterSpaceElement() | 〇 | × *1 |
*1 クラウド版で先行提供している機能です。 ^
メール
固定リンクがコピーされました
イベント
固定リンクがコピーされました
送信イベント
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| メールの作成画面を表示したとき | mail.mail.create.show | 〇 | 6.0以降 |
| メールの詳細画面を表示したとき | mail.mail.detail.show | 〇 | 5.15以降 |
| メールの返信画面を表示したとき | mail.mail.reply.show | 〇 | 6.0以降 |
| メールを送信する前 | mail.mail.send.submit | 〇 | 5.5 以降 |
情報の取得・設定
固定リンクがコピーされました
値の取得や設定
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| メールの値を取得する | garoon.mail.mail.get() | 〇 | 6.0以降 |
| メールの値をセットする | garoon.mail.mail.set() | 〇 | 6.0以降 |
要素の取得や設定
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| メールの「標題」下の空白要素を取得する | garoon.mail.mail.getMailSubjectSpaceElement() | 〇 | 5.15以降 |
画像アセット
固定リンクがコピーされました
情報の取得・設定
固定リンクがコピーされました
値の取得や設定
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| ファイルキーから画像URLを取得する | garoon.assets.images.getUrl() | 〇 | 5.0以降 |
REST API実行
固定リンクがコピーされました
| カテゴリ | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| Garoon REST APIリクエストを送信する | garoon.api() | 〇 | 5.0以降 |
| kintone連携用トークンを取得する | garoon.connect.kintone.getRequestToken() | 〇 | 提供なし *1 |
| CSRFトークンを取得する | garoon.base.request.getRequestToken() | 〇 | 4.10以降 |
| 外部 のAPIを実行する | garoon.base.proxy.send() | 〇 | 4.6以降 |
*1 kintone連携はクラウド版でのみ提供している機能です。 ^
プラグイン
固定リンクがコピーされました
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| プラグインの詳細設定を取得する | garoon.plugin.getConfig() | 〇 | 提供なし *1 |
| プラグインの詳細設定を保存する | garoon.plugin.setConfig() | 〇 | 提供なし *1 |
*1 プラグインはクラウド版でのみ提供している機能です。 ^
その他
固定リンクがコピーされました
| API | 関数 | クラウド版 | パッケージ版 |
|---|---|---|---|
| garoon.Promiseを使用する | garoon.Promise | 〇 | 4.6以降 |