2018年7月8日の定期メンテナンスの、kintone APIの更新に関する情報をお知らせします。
お知らせの内容に追加、変更等ありましたら、こちらのコメントにて変更箇所を追記します。
また、APIドキュメントには仕様を順次公開していきます。
kintone REST API
修正される不具合
- レコードの一括取得（クエリで条件を指定）APIのクエリで、「言語ごとの名称」で設定したステータス名を指定するとエラーが発生
- 修正内容:
プロセス管理のステータス名に「言語ごとの名称」を設定し、
レコードの一括取得APIの「query」パラメータで、設定した言語のステータス名（アカウントの言語設定と同じ言語）を指定して取得するとき
- 修正前：エラーが発生して、取得できない
- 修正後：正常に取得できる
- 修正内容:
- アプリの一覧の設定の取得APIで取得した関連レコード.ドロップダウンの項目が多言語対応されない
- 修正内容:
関連レコード一覧内のドロップダウンフィールドに「言語ごとの名称」を設定し、
アプリの一覧設定の取得APIで、設定した言語を「lang」パラメータで指定して取得したとき
- 修正前：「lang」パラメータが無視される
- 修正後：「lang」パラメータが反映される
- 修正内容:
kintone JavaScript API
仕様変更
- イベント処理を、カスタマイズ JavaScript として登録されたスクリプトが読み込まれるタイミングに、同期的に登録しない場合に警告表示
- 対象イベント :
- レコード表示イベント app.record.detail.show
- レコード追加イベント app.record.create.show
- レコード編集イベント app.record.edit.show
- 変更内容:
対象のイベント処理を、カスタマイズ JavaScript として登録されたスクリプトが読み込まれるタイミングに、同期的に登録しない場合
- 変更前：警告なし
- 変更後：ブラウザのコンソールに警告を表示
- 対象画面 :
- レコード詳細画面
- レコード作成画面
- レコード編集画面
- レコード再利用画面
- 対象画面 :
- 対象イベント :
詳細については以下の記事をご確認ください。
JavaScriptを当サイトなどを流用し使用しています。ただ、もともとJavaScriptの知識がなく今回の仕様変更による影響のイメージがつきません。
例えば、以下のようなJavaScriptを使用していますが、今回の仕様変更による影響はあるのでしょうか？
どなたか詳しく教えていただけると幸いです。
* 全申請書（ワークフロー）の再利用ボタンを非表示
* 新デザイン用
* 再利用ボタンのクラス名変更の為
*
*/
"use strict";
// レコード詳細画面が表示された時のイベント
kintone.events.on('app.record.detail.show', function (event) {
document.getElementsByClassName('gaia-argoui-app-menu-copy')[0].style.display = 'none';
});
})();
マツ様
今回の仕様変更は、
イベントハンドラーを同期的に登録するコードの記述でないと、イベントが発生するよりも、kintone.events.on()による イベントハンドラーの登録が後になってしまい、イベントハンドラーが呼び出されないことがあるため、そのような場合に警告を表示する
というものです。
動かなくなるわけではなく、動くことを保証されない記述方法のため警告を表示する、という仕様変更になります。
おっしゃるとおり、どのような書き方が良くないか？という点が伝わりづらいこともありますため、
現在、良い例、悪い例のサンプルコードを含めた具体的なガイドを7月8日までに公開できるよう準備しておりますので、そちらをお待ちいただけますでしょうか。
よろしくお願いいたします。
cybozu Development team様
コメントありがとうございます。ガイドの公開お待ちしております。