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 以降
予定のカスタム項目の値を取得する garoon.schedule.event.datastore.get()
5.9 以降
予定のカスタム項目の値をセットする 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 関数 クラウド版 パッケージ版
メールの作成画面を表示したとき 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 実行

カテゴリ 関数 クラウド版 パッケージ版
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 以降