kintone JavaScript API 一覧

目次

イベントの利用方法は、 イベント処理の記述方法 を参照してください。

イベント

レコード一覧画面

イベントが発生するタイミング イベントタイプ PC モバイル
一覧画面を表示した後 app.record.index.show
インライン編集を開始したとき app.record.index.edit.show
インライン編集のフィールド値を変更したとき app.record.index.edit.change.フィールドコード
インライン編集の【保存】をクリックしたとき app.record.index.edit.submit
インライン編集の保存が成功したとき app.record.index.edit.submit.success
レコードを削除するとき app.record.index.delete.submit

レコード詳細画面

イベントが発生するタイミング イベントタイプ PC モバイル
レコード詳細画面を表示した後 app.record.detail.show
レコードを削除するとき app.record.detail.delete.submit
プロセス管理のアクションを実行したとき app.record.detail.process.proceed

レコード追加画面

イベントが発生するタイミング イベントタイプ PC モバイル
レコード追加画面を表示した後 app.record.create.show
フィールドの値を変更したとき app.record.create.change.フィールドコード
【保存】をクリックしたとき app.record.create.submit
保存が成功したとき app.record.create.submit.success

レコード編集画面

イベントが発生するタイミング イベントタイプ PC モバイル
レコード編集画面を表示した後 app.record.edit.show
フィールドの値を変更したとき app.record.edit.change.フィールドコード
【保存】をクリックしたとき app.record.edit.submit
保存が成功したとき app.record.edit.submit.success

レコード印刷画面

イベントが発生するタイミング イベントタイプ PC モバイル
レコード印刷画面を表示した後 app.record.print.show

グラフ画面

イベントが発生するタイミング イベントタイプ PC モバイル
グラフ画面を表示した後 app.report.show

ポータル画面

イベントが発生するタイミング イベントタイプ PC モバイル
ポータル画面を表示した後 portal.show

スペース画面

イベントが発生するタイミング イベントタイプ PC モバイル
スペース画面を表示した後 space.portal.show

イベントハンドラーの登録・削除

API 関数名 PC モバイル
イベントハンドラーを登録する kintone.events.on
イベントハンドラーを削除する kintone.events.off

API実行

kintone REST API の実行

API 関数名 PC モバイル
kintone REST API を実行する kintone.api
API の URL を取得する kintone.api.url
API の URL を取得する(クエリ文字列付き) kintone.api.urlForGet
CSRF トークンを取得する kintone.getRequestToken
同時接続数を取得する kintone.api.getConcurrencyLimit

外部 API の実行

API 関数名 PC モバイル
外部 API を実行する kintone.proxy
外部にファイルをアップロードする kintone.proxy.upload

情報の取得/設定

レコード

API 関数名 PC モバイル
レコード ID を取得する kintone.app.record.getId
レコードの値を取得する kintone.app.record.get
レコードの値をセットする kintone.app.record.set

アプリ

API 関数名 PC モバイル
アプリ ID を取得する kintone.app.getId
ルックアップフィールドの対象アプリの ID を取得する kintone.app.getLookupTargetAppId
関連レコード一覧の対象アプリ ID を取得する kintone.app.getRelatedRecordsTargetAppId
クエリ文字列を取得する kintone.app.getQueryCondition
クエリ文字列を取得する(オプション付き) kintone.app.getQuery

全体

API 関数名 PC モバイル
ログインユーザー情報を取得する kintone.getLoginUser
kintone の UI バージョンを取得する kintone.getUiVersion

フィールド表示/非表示

API 関数名 PC モバイル
フィールドの表示・非表示を切り替える kintone.app.record.setFieldShown
グループフィールドを開閉する kintone.app.record.setGroupFieldOpen

要素の取得

レコード詳細画面

API 関数名 PC モバイル
フィールド要素を取得する kintone.app.record.getFieldElement
メニューの上側の要素を取得する kintone.app.record.getHeaderMenuSpaceElement
スペースフィールドの要素を取得する kintone.app.record.getSpaceElement
ヘッダーの下側の要素を取得する kintone.mobile.app.getHeaderSpaceElement

レコード一覧画面

API 関数名 PC モバイル
フィールド要素を取得する kintone.app.getFieldElements
メニューの右側の要素を取得する kintone.app.getHeaderMenuSpaceElement
メニューの下側の要素を取得する kintone.app.getHeaderSpaceElement
ヘッダーの下側の要素を取得する kintone.mobile.app.getHeaderSpaceElement

ポータル画面

API 関数名 PC モバイル
ポータルの上側の要素を取得する kintone.portal.getContentSpaceElement

スペース画面

API 関数名 PC モバイル
スペースのトップ画面の上側の要素を取得する kintone.space.portal.getContentSpaceElement

プラグイン

API 関数名 PC モバイル
設定情報を取得する kintone.plugin.app.getConfig
設定情報を保存する kintone.plugin.app.setConfig
外部 API のリクエスト情報を取得する kintone.plugin.app.getProxyConfig
外部APIのリクエスト情報を保存する kintone.plugin.app.setProxyConfig
外部 API を実行する kintone.plugin.app.proxy
外部にファイルをアップロードする kintone.plugin.app.proxy.upload