Garoon JavaScript API 一覧 – cybozu developer network

注意事項

画面をカスタマイズする JavaScript API が提供されている各アプリケーションにカスタマイズを行う場合は、
全体 JS によるカスタマイズではなく、アプリケーションごとにカスタマイズファイルを適用することを推奨しています。
全体 JS によるカスタマイズを利用する場合、該当のアプリケーションのカスタマイズを有効にしなくても、
全体 JS で登録したイベントは実行されます。
Garoon JavaScript API は、以下の方法で表示したときには対応していません。
- 「モバイル表示」で表示したとき
- スマートフォン用アプリ「KUNAI」で表示したとき

スケジュール

イベント

カテゴリ	API	関数	クラウド版	パッケージ版
表示イベント	予定の登録画面が表示されたとき	schedule.event.create.show	〇	ver 4.10.0以降
	予定の変更画面が表示されたとき	schedule.event.edit.show	〇	ver 4.10.0以降
	予定の詳細画面が表示されたとき	schedule.event.detail.show	〇	ver 4.10.0以降
	グループ日画面が表示されたとき	schedule.calendar.groupDayIndex.show	〇	ver 4.10.0以降
	グループ週画面が表示されたとき	schedule.calendar.groupWeekIndex.show	〇	ver 4.6.0以降
	日画面が表示されたとき	schedule.calendar.dayIndex.show	〇	ver 4.10.0以降
	週画面が表示されたとき	schedule.calendar.weekIndex.show	〇	ver 4.10.0以降
	月画面が表示されたとき	schedule.calendar.monthIndex.show	〇	ver 4.10.0以降
	登録イベント	予定の登録実行前	schedule.event.create.submit	〇	ver 5.0.0以降
		予定の登録実行後	schedule.event.create.submit.success	〇	ver 5.9.0以降
		ポップアップウィンドウで予定の登録実行後	schedule.event.quick.create.submit.success	〇	ver 5.9.0以降
	変更イベント	予定の変更実行前	schedule.event.edit.submit	〇	ver 5.0.0以降
予定の変更実行後		schedule.event.edit.submit.success	〇	ver 5.9.0以降
ドラッグ＆ドロップで予定の変更実行後		schedule.event.quick.edit.submit.success	〇	ver 5.9.0以降
削除イベント	予定の削除実行前	schedule.event.delete.submit	〇	ver 5.9.0以降
削除イベント	予定の削除実行後	schedule.event.delete.submit.success	〇	ver 5.9.0以降
予定に参加、抜けたときのイベント	予定に参加したとき	schedule.event.attend.submit.success	〇	×
予定に参加、抜けたときのイベント	予定から抜けたとき	schedule.event.leave.submit.success	〇	×

情報の取得・設定

カテゴリ	API	関数	クラウド版	パッケージ版
値の取得	予定の値を取得	garoon.schedule.event.get()	〇	ver 4.10.0以降
値の設定	予定の値をセット	garoon.schedule.event.set()	〇	ver 4.10.0以降
カスタム項目の値の取得	予定のカスタム項目の値の取得	garoon.schedule.event.datastore.get()	〇	ver 5.9.0以降
カスタム項目の値の設定	予定のカスタム項目の値をセット	garoon.schedule.event.datastore.set()	〇	ver 5.9.0以降
要素の取得	【グループ日】ログインユーザーのスケジュールの予定枠最上部の空白要素を取得	garoon.schedule.calendar.getDayFirstSpaceElement()	〇	ver 4.10.0以降
	【グループ週】ログインユーザーのスケジュールの予定枠最上部の空白要素を取得	garoon.schedule.calendar.getDayFirstSpaceElement()	〇	ver 4.6.0以降
	【日】ログインユーザーのスケジュールの予定枠最上部の空白要素を取得	garoon.schedule.calendar.getDayFirstSpaceElement()	〇	ver 4.10.0以降
	【週】ログインユーザーのスケジュールの予定枠最上部の空白要素を取得	garoon.schedule.calendar.getDayFirstSpaceElement()	〇	ver 4.10.0以降
	【月】ログインユーザーのスケジュールの予定枠最上部の空白要素を取得	garoon.schedule.calendar.getDayFirstSpaceElement()	〇	ver 4.10.0以降
	予定の詳細/登録/変更画面のヘッダー部分の空白要素を取得	garoon.schedule.event.getHeaderSpaceElement()	〇	ver 4.10.0以降
	メール詳細画面の表題下の空白要素を取得 ※	garoon.mail.mail.getMailSubjectSpaceElement()	〇	×
要素の設定	テーブルに行を追加	garoon.schedule.event.insertTableRow()	〇	ver 5.5.0以降

※ 2022年8月定期メンテナンス後より

メッセージ

イベント

カテゴリ	API	関数	クラウド版	パッケージ版
表示イベント	メッセージの作成画面が表示されたとき	message.body.create.show	〇	ver 5.0.0以降
	メッセージの宛先変更画面が表示されたとき	message.body.changeTo.show	〇	ver 5.0.0以降

情報の取得・設定

カテゴリ	API	関数	クラウド版	パッケージ版
要素の取得	メッセージの空白要素を取得	garoon.message.body.getItemLastSpaceElement()	〇	ver 5.0.0以降
値の設定	メッセージの値をセット	garoon.message.body.set()	〇	ver 5.0.0以降

ワークフロー

イベント

カテゴリ	API	関数	クラウド版	パッケージ版
表示イベント	ワークフロー申請の作成画面が表示されたとき	workflow.request.create.show	〇	ver 4.6.0以降
	ワークフロー申請の詳細画面が表示されたとき	workflow.request.detail.show	〇	ver 4.6.0以降
	ワークフロー申請の承認画面が表示されたとき	workflow.request.approve.show	〇	ver 4.6.0以降
	ワークフロー申請の印刷用画面が表示されたとき	workflow.request.print.show	〇	ver 4.6.0以降
提出イベント	ワークフロー申請が提出されたとき	workflow.request.create.submit.success	〇	×
承認イベント	ワークフロー申請が承認されたとき	workflow.request.approve.submit.success	〇	ver 4.10.0以降
確認イベント	ワークフロー申請が確認されたとき	workflow.request.acknowledge.submit.success	〇	×

情報の取得・設定

カテゴリ	API	関数	クラウド版	パッケージ版
値の取得	申請データの値を取得	garoon.workflow.request.get()	〇	ver 4.6.0以降
値の設定	申請データに値をセット	garoon.workflow.request.set()	〇	ver 4.6.0以降
要素の取得	JavaScriptカスタマイズ用項目の要素を取得	garoon.workflow.request.getSpaceElement()	〇	ver 4.6.0以降

編集可・不可

カテゴリ	API	関数	クラウド版	パッケージ版
-	編集可/不可を切り替え	garoon.workflow.request.setItemEditable()	〇	ver 5.0.0以降

ユーザー

情報の取得・設定

カテゴリ	API	関数	クラウド版	パッケージ版
値の取得	ログインユーザー情報の取得	garoon.base.user.getLoginUser	〇	ver 4.10.0以降

メール

イベント

カテゴリ	API	関数	クラウド版	パッケージ版
-	メール送信前イベント	mail.mail.send.submit	〇	ver 5.5.0以降
-	メール詳細画面表示後イベント ※	mail.mail.detail.show	〇	×

※ 2022年8月定期メンテナンス後より

画像アセット

情報の取得・設定

カテゴリ	API	関数	クラウド版	パッケージ版
-	画像ファイルのダウンロードURLを取得	garoon.assets.images.getUrl()	〇	ver 5.0.0以降

API実行

カテゴリ	API	関数	クラウド版	パッケージ版
-	REST APIリクエストを送信	garoon.api()	〇	ver 5.0.0以降
	kintone連携用トークンを取得	garoon.connect.kintone.getRequestToken()	〇	×
	CSRFトークンを取得	garoon.base.request.getRequestToken()	〇	ver 4.10.0以降
	外部APIの実行	garoon.base.proxy.send()	〇	ver 4.6.0以降

プラグイン

カテゴリ	API	関数	クラウド版	パッケージ版
値の取得	プラグインの設定情報を取得する	garoon.plugin.getConfig()	〇	機能なし
値の設定	プラグインに設定を保存する	garoon.plugin.setConfig()	〇	機能なし

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

オフィス江口株式会社 2018年10月21日 02:08

予定の登録が完了した時に発火するイベントの実装予定はありますか？

ガルーンで作成した予定をkintoneにコピーしたいというニーズがあります。

よろしくお願いいたします。

cybozu Development team 2018年11月02日 03:40

オフィス江口株式会社様

返答が遅くなりまして申し訳ありません。

何とも時期は申し上げられませんが、登録完了時ではなく、「登録する」ボタンを押したときのイベントであれば、実現の可能性はあります。

製品開発への要望は、以下リンク先から直接あげることができますので、ぜひご活用ください。

https://developer.cybozu.io/hc/ja/articles/360001077023

cybozu Development teamにより編集されました 2018年11月02日 03:40

サインインしてコメントを残してください。