Fixes #1216, #1233 Adds view_closed docs and other minor fixes #1236

wongjas · 2021-12-07T01:12:31Z

Summary

Fixes #1216, #1233.

Adds view_closed docs
Updates link to view_submission docs
Updates some references of event -> request

Requirements (place an `x` in each `[ ]`)

I've read and understood the Contributing Guidelines and have done my best effort to follow them.
I've read and agree to the Code of Conduct.

codecov · 2021-12-07T01:14:33Z

Codecov Report

Merging #1236 (e81ecb4) into main (9658caa) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1236   +/-   ##
=======================================
  Coverage   73.22%   73.22%           
=======================================
  Files          17       17           
  Lines        1438     1438           
  Branches      431      431           
=======================================
  Hits         1053     1053           
  Misses        300      300           
  Partials       85       85

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9658caa...e81ecb4. Read the comment docs.

seratch · 2021-12-07T01:18:21Z

docs/_basic/ja_listening_modals.md


-`view()` メソッドは、文字列型または `RegExp` 型 の `callback_id` を必要とします。
+`view` メソッドを使ってユーザーからのインタラクションをリッスンすることができます。


It seems that interaction here is the one with views. The current translation does not include the part.

Suggested change

`view` メソッドを使ってユーザーからのインタラクションをリッスンすることができます。

`view` メソッドを使うと、ユーザーのビューとのインタラクションをリッスンすることができます。

seratch · 2021-12-07T01:24:20Z

docs/_basic/ja_listening_modals.md


-`input` ブロックの値は `state` オブジェクトを参照することで取得できます。`state` 内には `values` というオブジェクトがあり、これは `block_id` と一意な `action_id` に紐づける形で入力値を保持しています。
+`view_submission` リクエストは、アプリが開いたモーダルでユーザーが Submit ボタンを押したときに発生します。`input` ブロックの値は `state` オブジェクトを参照することで取得できます。`state` 内には `values` というオブジェクトがあり、これは `block_id` と一意な `action_id` に紐づける形で入力値を保持しています。


Suggested change

`view_submission` リクエストは、アプリが開いたモーダルでユーザーが Submit ボタンを押したときに発生します。`input` ブロックの値は `state` オブジェクトを参照することで取得できます。`state` 内には `values` というオブジェクトがあり、これは `block_id` と一意な `action_id` に紐づける形で入力値を保持しています。

ユーザーがモーダルからデータ送信したとき、Slack から `view_submission` のリクエストが送信されます。送信された `input` ブロックの値は `state` オブジェクトから取得できます。`state` 内には `values` というオブジェクトがあり、これは `block_id` と一意な `action_id` に紐づける形で入力値を保持しています。

seratch · 2021-12-07T01:25:28Z

docs/_basic/ja_listening_modals.md


-`input` ブロックの値は `state` オブジェクトを参照することで取得できます。`state` 内には `values` というオブジェクトがあり、これは `block_id` と一意な `action_id` に紐づける形で入力値を保持しています。
+`view_submission` リクエストは、アプリが開いたモーダルでユーザーが Submit ボタンを押したときに発生します。`input` ブロックの値は `state` オブジェクトを参照することで取得できます。`state` 内には `values` というオブジェクトがあり、これは `block_id` と一意な `action_id` に紐づける形で入力値を保持しています。
+モーダルでの `notify_on_close` プロパティが `true` に設定した場合、ユーザーが Close ボタンを押すと Slack は `view_closed` リクエストも送信します。 より詳細な情報は以下の **モーダルを閉じるときのハンドリング** を参照してください。


Suggested change

モーダルでの `notify_on_close` プロパティが `true` に設定した場合、ユーザーが Close ボタンを押すと Slack は `view_closed` リクエストも送信します。より詳細な情報は以下の **モーダルを閉じるときのハンドリング** を参照してください。

モーダルでの `notify_on_close` プロパティを `true` に設定した場合、ユーザーが Close ボタンを押したときに Slack から `view_closed` リクエストが送信されます。より詳細な情報は以下の **モーダルを閉じるときのハンドリング** を参照してください。

seratch · 2021-12-07T01:27:06Z

docs/_basic/ja_listening_modals.md

-`input` ブロックの値は `state` オブジェクトを参照することで取得できます。`state` 内には `values` というオブジェクトがあり、これは `block_id` と一意な `action_id` に紐づける形で入力値を保持しています。
+`view_submission` リクエストは、アプリが開いたモーダルでユーザーが Submit ボタンを押したときに発生します。`input` ブロックの値は `state` オブジェクトを参照することで取得できます。`state` 内には `values` というオブジェクトがあり、これは `block_id` と一意な `action_id` に紐づける形で入力値を保持しています。
+モーダルでの `notify_on_close` プロパティが `true` に設定した場合、ユーザーが Close ボタンを押すと Slack は `view_closed` リクエストも送信します。 より詳細な情報は以下の **モーダルを閉じるときのハンドリング** を参照してください。
+`view_submission` リクエストあるいは `view_closed` リクエストをリッスンするためには、組み込みの `view()` メソッドを使用します。


Suggested change

`view_submission` リクエストあるいは `view_closed` リクエストをリッスンするためには、組み込みの `view()` メソッドを使用します。

`view_submission` や `view_closed` リクエストをリッスンするには、組み込みの `view()` メソッドを使用できます。

seratch · 2021-12-07T01:28:53Z

docs/_basic/ja_listening_modals.md

+モーダルでの `notify_on_close` プロパティが `true` に設定した場合、ユーザーが Close ボタンを押すと Slack は `view_closed` リクエストも送信します。 より詳細な情報は以下の **モーダルを閉じるときのハンドリング** を参照してください。
+`view_submission` リクエストあるいは `view_closed` リクエストをリッスンするためには、組み込みの `view()` メソッドを使用します。
+
+`view()` メソッドは、文字列型または `RegExp` 型の `callback_id` を必要とします。あるいは、 `type` と `callback_id` を用いた制約付きオブジェクトを必要とします。


Suggested change

`view()` メソッドは、文字列型または `RegExp` 型の `callback_id` を必要とします。あるいは、 `type` と `callback_id` を用いた制約付きオブジェクトを必要とします。

`view()` メソッドでは、文字列か正規表現の `callback_id` の指定が必要です。`type` と `callback_id` を含む制約付きオブジェクトを渡すこともできます。

seratch · 2021-12-07T01:29:37Z

docs/_basic/ja_listening_modals.md

+
+##### モーダルを閉じるときのハンドリング
+
+💡 `view_closed` リクエストをリッスンするとき、`callback_id` と `type: 'view_closed'` を含んだオブジェクトを指定することが必要とします。以下の例を参照してください。


Suggested change

💡 `view_closed` リクエストをリッスンするとき、`callback_id` と `type: 'view_closed'` を含んだオブジェクトを指定することが必要とします。以下の例を参照してください。

💡 `view_closed` リクエストをリッスンするとき、`callback_id` と `type: 'view_closed'` を含むオブジェクトの指定が必要です。以下の例を参照してください。

seratch · 2021-12-07T01:30:00Z

docs/_basic/ja_listening_modals.md

+
+💡 `view_closed` リクエストをリッスンするとき、`callback_id` と `type: 'view_closed'` を含んだオブジェクトを指定することが必要とします。以下の例を参照してください。
+
+`view_closed` についてより詳細な情報は [API ドキュメント](https://api.slack.com/surfaces/modals/using#modal_cancellations)を参照してください。


Suggested change

`view_closed` についてより詳細な情報は [API ドキュメント](https://api.slack.com/surfaces/modals/using#modal_cancellations)を参照してください。

`view_closed` に関するより詳細な情報は [API ドキュメント](https://api.slack.com/surfaces/modals/using#modal_cancellations)を参照してください。

seratch · 2021-12-07T01:31:11Z

docs/_basic/ja_listening_modals.md

+app.view({ callback_id: 'view_b', type: 'view_closed' }, async ({ ack, body, view, client }) => {
+  // view_closed リクエストの確認
+  await ack();
+  // close リクエストに何らかの処理


Suggested change

// close リクエストに何らかの処理

// close リクエストについて何らかの処理

wongjas added 5 commits December 6, 2021 20:00

JP - Fixes #1216: First draft

e7a57c5

proof read draft

4507caf

Merge branch 'main' into jwong_fix_1216_add_view_closed

f88f228

fix #1233

f5186ea

minor tweaks

03d57e6

wongjas requested a review from seratch December 7, 2021 01:12

wongjas self-assigned this Dec 7, 2021

wongjas mentioned this pull request Dec 7, 2021

Fixes #1233 Removes redundant information, update link to actual view submissions #1234

Closed

2 tasks

seratch requested changes Dec 7, 2021

View reviewed changes

wongjas linked an issue Dec 7, 2021 that may be closed by this pull request

Section on view submissions has redundant information and the link should be updated #1233

Closed

10 tasks

wongjas added 2 commits December 7, 2021 11:38

Add Kaz's fixes

c71c919

Merge branch 'main' into jwong_fix_1216_add_view_closed

e81ecb4

wongjas requested a review from seratch December 9, 2021 23:51

seratch approved these changes Dec 10, 2021

View reviewed changes

seratch added the docs M-T: Documentation work only label Dec 10, 2021

seratch added this to the 3.9.0 milestone Dec 10, 2021

seratch merged commit db85844 into slackapi:main Dec 10, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixes #1216, #1233 Adds view_closed docs and other minor fixes #1236

Fixes #1216, #1233 Adds view_closed docs and other minor fixes #1236

wongjas commented Dec 7, 2021

codecov bot commented Dec 7, 2021 •

edited

Loading

seratch Dec 7, 2021

seratch Dec 7, 2021

seratch Dec 7, 2021

seratch Dec 7, 2021

seratch Dec 7, 2021

seratch Dec 7, 2021

seratch Dec 7, 2021

seratch Dec 7, 2021


		`view()` メソッドは、文字列型または `RegExp` 型の `callback_id` を必要とします。
		`view` メソッドを使ってユーザーからのインタラクションをリッスンすることができます。

	`view` メソッドを使ってユーザーからのインタラクションをリッスンすることができます。
	`view` メソッドを使うと、ユーザーのビューとのインタラクションをリッスンすることができます。


		`input` ブロックの値は `state` オブジェクトを参照することで取得できます。`state` 内には `values` というオブジェクトがあり、これは `block_id` と一意な `action_id` に紐づける形で入力値を保持しています。
		`view_submission` リクエストは、アプリが開いたモーダルでユーザーが Submit ボタンを押したときに発生します。`input` ブロックの値は `state` オブジェクトを参照することで取得できます。`state` 内には `values` というオブジェクトがあり、これは `block_id` と一意な `action_id` に紐づける形で入力値を保持しています。

	モーダルでの `notify_on_close` プロパティが `true` に設定した場合、ユーザーが Close ボタンを押すと Slack は `view_closed` リクエストも送信します。より詳細な情報は以下のモーダルを閉じるときのハンドリングを参照してください。
	モーダルでの `notify_on_close` プロパティを `true` に設定した場合、ユーザーが Close ボタンを押したときに Slack から `view_closed` リクエストが送信されます。より詳細な情報は以下のモーダルを閉じるときのハンドリングを参照してください。

	`view_submission` リクエストあるいは `view_closed` リクエストをリッスンするためには、組み込みの `view()` メソッドを使用します。
	`view_submission` や `view_closed` リクエストをリッスンするには、組み込みの `view()` メソッドを使用できます。

	`view()` メソッドは、文字列型または `RegExp` 型の `callback_id` を必要とします。あるいは、 `type` と `callback_id` を用いた制約付きオブジェクトを必要とします。
	`view()` メソッドでは、文字列か正規表現の `callback_id` の指定が必要です。`type` と `callback_id` を含む制約付きオブジェクトを渡すこともできます。


		##### モーダルを閉じるときのハンドリング

		💡 `view_closed` リクエストをリッスンするとき、`callback_id` と `type: 'view_closed'` を含んだオブジェクトを指定することが必要とします。以下の例を参照してください。


		💡 `view_closed` リクエストをリッスンするとき、`callback_id` と `type: 'view_closed'` を含んだオブジェクトを指定することが必要とします。以下の例を参照してください。

		`view_closed` についてより詳細な情報は [API ドキュメント](https://api.slack.com/surfaces/modals/using#modal_cancellations)を参照してください。

	`view_closed` についてより詳細な情報は [API ドキュメント](https://api.slack.com/surfaces/modals/using#modal_cancellations)を参照してください。
	`view_closed` に関するより詳細な情報は [API ドキュメント](https://api.slack.com/surfaces/modals/using#modal_cancellations)を参照してください。

	// close リクエストに何らかの処理
	// close リクエストについて何らかの処理

Fixes #1216, #1233 Adds view_closed docs and other minor fixes #1236

Fixes #1216, #1233 Adds view_closed docs and other minor fixes #1236

Conversation

wongjas commented Dec 7, 2021

Summary

Requirements (place an x in each [ ])

codecov bot commented Dec 7, 2021 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Requirements (place an `x` in each `[ ]`)

codecov bot commented Dec 7, 2021 •

edited

Loading