kintone JavaScript API

目次

kintone JavaScript APIの基本的な使い方は、チュートリアル「はじめようkintone API」で学ぶことができます。
はじめようkintone API

イベント

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

レコード一覧画面

イベントが発生するタイミング PC モバイル
一覧画面を表示した後 app.record.index.show mobile.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 mobile.app.record.detail.show
レコードを削除する前 app.record.detail.delete.submit mobile.app.record.detail.delete.submit
プロセス管理のアクションを実行したとき app.record.detail.process.proceed mobile.app.record.detail.process.proceed

レコード追加画面

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

レコード編集画面

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

レコード印刷画面

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

グラフ画面

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

ポータル画面

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

スペース画面

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

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

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

API実行

kintone REST APIの実行

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

外部APIの実行

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

情報の取得/設定

レコード

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

アプリ

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

全体

API PC モバイル
ログインユーザーの情報を取得する kintone.getLoginUser() kintone.getLoginUser()
デザインのバージョンを取得する kintone.getUiVersion() kintone.getUiVersion()

フィールド表示/非表示

API PC モバイル
フィールドの表示/非表示を切り替える kintone.app.record.setFieldShown() kintone.mobile.app.record.setFieldShown()
グループフィールドを開閉する kintone.app.record.setGroupFieldOpen() kintone.mobile.app.record.setGroupFieldOpen()

要素の取得

レコード詳細画面

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

レコード一覧画面

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

ポータル画面

API PC モバイル
ポータルの上側の要素を取得する kintone.portal.getContentSpaceElement() kintone.mobile.portal.getContentSpaceElement()

スペース画面

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

プラグイン

API PC モバイル
設定情報を取得する kintone.plugin.app.getConfig() 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()
外部にファイルをアップロードする kintone.plugin.app.proxy.upload() kintone.plugin.app.proxy.upload()