kintone APIドキュメント

サイドバーの開閉を切り替える

目次

サイドバーの開閉を切り替える

固定リンクがコピーされました

現在開いているレコードのサイドバーを開閉します。
または、レコードコメント、変更履歴のいずれかを開きます。

このAPIは非同期なAPIです。
同期的に処理したい場合は、次のページを参照してください。

関数

固定リンクがコピーされました

PC

kintone.app.record.showSideBar(state)

引数

固定リンクがコピーされました

引数名 型 必須 説明
state 文字列 必須 次のいずれかの値を指定します。
  • OPEN：サイドバーを開く
  • CLOSED：サイドバーを閉じる
  • COMMENTS：レコードコメントを表示する
  • HISTORY：レコードの変更履歴を表示する

戻り値

固定リンクがコピーされました

戻り値はPromiseオブジェクトです。
Promiseオブジェクトの解決時に値は返りません。

利用できる画面

固定リンクがコピーされました

PC
  • レコード詳細画面
  • レコード編集画面

サンプルコード

固定リンクがコピーされました

1
2
3
4

// コメントタブが開く
kintone.events.on('app.record.edit.show', async (event) => {
  await kintone.app.record.showSideBar('COMMENTS');
});

制限事項

固定リンクがコピーされました

  • コメント・変更履歴両方のタブが存在する場合、OPENを指定して実行すると、コメント欄が開きます。
    アプリの設定で「レコードのコメント機能を有効にする」のチェックボックスが無効になっている場合は、レコードの変更履歴が開きます。
    どちらも無効になっている場合は、何も起こりません。