From d0950fb7f86140260d192caea75922e91828e62e Mon Sep 17 00:00:00 2001 From: Jason Wong Date: Wed, 13 Oct 2021 13:57:37 +0900 Subject: [PATCH 1/5] Adds #479 from the bolt-py docs to the bolt-js ones --- docs/_basic/ja_listening_modals.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/_basic/ja_listening_modals.md b/docs/_basic/ja_listening_modals.md index 8f84ff648..5fb2bc06f 100644 --- a/docs/_basic/ja_listening_modals.md +++ b/docs/_basic/ja_listening_modals.md @@ -8,10 +8,27 @@ order: 12
モーダルのペイロードが入力のブロックを含む場合、その入力値を受け取るために view_submission のリクエストをリッスンする必要があります。view_submission イベントをリッスンするためには、組み込みの view() メソッドを使用します。 -view() メソッドは、文字列型または RegeExp型 の callback_id を必要とします。 +view() メソッドは、文字列型または RegExp型 の callback_id を必要とします。 input ブロックの値は state オブジェクトを参照することで取得できます。state 内には values というオブジェクトがあり、これは block_id と一意な action_id に紐づける形で入力値を保持しています。 +--- + +##### モーダル送信でのビューの更新 + +view_submission リクエストに対してモーダルを更新するには、update型の response_action と新しく作成した view を指定すると確認を示します。 + +```javascript +// モーダル送信でのビューの更新 +app.view('modal-callback-id', async ({ ack, body }) => { + await ack({ + response_action: 'update', + view: buildNewModalView(body), + }); +}); +``` +この例と同様に、モーダルでの送信イベントに対して、[エラーを表示する](https://api.slack.com/surfaces/modals/using#displaying_errors)オプションもあります。 + より詳細な情報は API ドキュメントを参照してください。
From 9c3dc8667f496a86a218d71b86b3582e47c05fea Mon Sep 17 00:00:00 2001 From: Jason Wong Date: Wed, 13 Oct 2021 15:10:46 +0900 Subject: [PATCH 2/5] add changes from Kaz's comments --- docs/_basic/ja_listening_modals.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/_basic/ja_listening_modals.md b/docs/_basic/ja_listening_modals.md index 5fb2bc06f..dbdf8ef60 100644 --- a/docs/_basic/ja_listening_modals.md +++ b/docs/_basic/ja_listening_modals.md @@ -18,6 +18,8 @@ order: 12 view_submission リクエストに対してモーダルを更新するには、update型の response_action と新しく作成した view を指定すると確認を示します。 +view_submission リクエストに対してモーダルを更新するには、リクエストの確認の中で update を指定した response_action と新しく作成した view を指定します。 + ```javascript // モーダル送信でのビューの更新 app.view('modal-callback-id', async ({ ack, body }) => { @@ -27,7 +29,7 @@ app.view('modal-callback-id', async ({ ack, body }) => { }); }); ``` -この例と同様に、モーダルでの送信イベントに対して、[エラーを表示する](https://api.slack.com/surfaces/modals/using#displaying_errors)オプションもあります。 +この例と同様に、モーダルでの送信イベントに対して、[エラーを表示する](https://api.slack.com/surfaces/modals/using#displaying_errors) ためのオプションもあります。 より詳細な情報は API ドキュメントを参照してください。 From 9d59f49934a41cb391186086ecb03620304c887e Mon Sep 17 00:00:00 2001 From: Jason Wong Date: Wed, 13 Oct 2021 15:24:58 +0900 Subject: [PATCH 3/5] change out tags for markdown equivalent --- docs/_basic/ja_listening_modals.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/_basic/ja_listening_modals.md b/docs/_basic/ja_listening_modals.md index dbdf8ef60..a7dd9fc2d 100644 --- a/docs/_basic/ja_listening_modals.md +++ b/docs/_basic/ja_listening_modals.md @@ -6,19 +6,19 @@ order: 12 ---
-モーダルのペイロードが入力のブロックを含む場合、その入力値を受け取るために view_submission のリクエストをリッスンする必要があります。view_submission イベントをリッスンするためには、組み込みの view() メソッドを使用します。 +モーダルのペイロードが入力のブロックを含む場合、その入力値を受け取るために `view_submission` のリクエストをリッスンする必要があります。`view_submission` イベントをリッスンするためには、組み込みの `view()` メソッドを使用します。 -view() メソッドは、文字列型または RegExp型 の callback_id を必要とします。 +`view()` メソッドは、文字列型または `RegExp`型 の `callback_id` を必要とします。 -input ブロックの値は state オブジェクトを参照することで取得できます。state 内には values というオブジェクトがあり、これは block_id と一意な action_id に紐づける形で入力値を保持しています。 +`input` ブロックの値は `state` オブジェクトを参照することで取得できます。`state` 内には `values` というオブジェクトがあり、これは `block_id` と一意な `action_id` に紐づける形で入力値を保持しています。 --- ##### モーダル送信でのビューの更新 -view_submission リクエストに対してモーダルを更新するには、update型の response_action と新しく作成した view を指定すると確認を示します。 +`view_submission` リクエストに対してモーダルを更新するには、`update`型の `response_action` と新しく作成した `view` を指定すると確認を示します。 -view_submission リクエストに対してモーダルを更新するには、リクエストの確認の中で update を指定した response_action と新しく作成した view を指定します。 +`view_submission` リクエストに対してモーダルを更新するには、リクエストの確認の中で `update` を指定した `response_action` と新しく作成した `view` を指定します。 ```javascript // モーダル送信でのビューの更新 From 3f9db6616fd653c3472ac8a8fb2155d606f15eda Mon Sep 17 00:00:00 2001 From: Jason Wong Date: Wed, 13 Oct 2021 15:26:30 +0900 Subject: [PATCH 4/5] switch out 'event' for 'request' --- docs/_basic/ja_listening_modals.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_basic/ja_listening_modals.md b/docs/_basic/ja_listening_modals.md index a7dd9fc2d..dfe502367 100644 --- a/docs/_basic/ja_listening_modals.md +++ b/docs/_basic/ja_listening_modals.md @@ -6,7 +6,7 @@ order: 12 ---
-モーダルのペイロードが入力のブロックを含む場合、その入力値を受け取るために `view_submission` のリクエストをリッスンする必要があります。`view_submission` イベントをリッスンするためには、組み込みの `view()` メソッドを使用します。 +モーダルのペイロードが入力のブロックを含む場合、その入力値を受け取るために `view_submission` のリクエストをリッスンする必要があります。`view_submission` リクエストをリッスンするためには、組み込みの `view()` メソッドを使用します。 `view()` メソッドは、文字列型または `RegExp`型 の `callback_id` を必要とします。 @@ -29,7 +29,7 @@ app.view('modal-callback-id', async ({ ack, body }) => { }); }); ``` -この例と同様に、モーダルでの送信イベントに対して、[エラーを表示する](https://api.slack.com/surfaces/modals/using#displaying_errors) ためのオプションもあります。 +この例と同様に、モーダルでの送信リクエストに対して、[エラーを表示する](https://api.slack.com/surfaces/modals/using#displaying_errors) ためのオプションもあります。 より詳細な情報は API ドキュメントを参照してください。
From 99e4e1853cf2e388e1ea11fa14de5346fff594c3 Mon Sep 17 00:00:00 2001 From: Jason Wong Date: Thu, 14 Oct 2021 08:23:41 +0900 Subject: [PATCH 5/5] Removes extra line from previous translation, extra spaces and Kaz's comments --- docs/_basic/ja_listening_modals.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/_basic/ja_listening_modals.md b/docs/_basic/ja_listening_modals.md index dfe502367..1faae16a0 100644 --- a/docs/_basic/ja_listening_modals.md +++ b/docs/_basic/ja_listening_modals.md @@ -8,7 +8,7 @@ order: 12
モーダルのペイロードが入力のブロックを含む場合、その入力値を受け取るために `view_submission` のリクエストをリッスンする必要があります。`view_submission` リクエストをリッスンするためには、組み込みの `view()` メソッドを使用します。 -`view()` メソッドは、文字列型または `RegExp`型 の `callback_id` を必要とします。 +`view()` メソッドは、文字列型または `RegExp` 型 の `callback_id` を必要とします。 `input` ブロックの値は `state` オブジェクトを参照することで取得できます。`state` 内には `values` というオブジェクトがあり、これは `block_id` と一意な `action_id` に紐づける形で入力値を保持しています。 @@ -16,9 +16,7 @@ order: 12 ##### モーダル送信でのビューの更新 -`view_submission` リクエストに対してモーダルを更新するには、`update`型の `response_action` と新しく作成した `view` を指定すると確認を示します。 - -`view_submission` リクエストに対してモーダルを更新するには、リクエストの確認の中で `update` を指定した `response_action` と新しく作成した `view` を指定します。 +`view_submission` リクエストに対してモーダルを更新するには、リクエストの確認の中で `update` という `response_action` と新しく作成した `view` を指定します。 ```javascript // モーダル送信でのビューの更新