Skip to content

Commit

Permalink
Fix slackapi#1047 Japanese: Make "events" in the document even clearer (
Browse files Browse the repository at this point in the history
slackapi#1152)

* change instances of events to requests in reference to slack requests
* change "request source" back to "event source" and update middleware error as per suggestions
  • Loading branch information
wongjas authored Oct 12, 2021
1 parent b045c77 commit 7f1ec57
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 17 deletions.
4 changes: 2 additions & 2 deletions docs/_advanced/ja_authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ order: 2
---

<div class="section-content">
認可(Authorization)は、Slack からのイベントを処理するにあたって、どの Slack クレデンシャル (ボットトークンなど) を使用可能にするかを決定するプロセスです。
認可(Authorization)は、Slack からのリクエストを処理するにあたって、どの Slack クレデンシャル (ボットトークンなど) を使用可能にするかを決定するプロセスです。

1 つだけのワークスペースにインストールされたカスタムアプリであれば `App` 初期化時に単に `token` オプションを使用するだけで OK です。一方で、複数のワークスペースにインストールされる、複数のユーザートークンを使用するといったケースのように、アプリが複数のトークンを処理しなければならない場合があります。このようなケースでは `token` の代わりに `authorize` オプションを使用する必要があります。

`authorize` オプションには、イベントソースを入力値として受け取り、許可された認可されたクレデンシャルを含むオブジェクトを Promise の値として返す関数を指定します。このイベントソースの情報には、 `teamId` (常に存在します)、 `userId``conversationId``enterpriseId` のような、イベントが誰によって発生させられたか、どこで発生したかに関する情報が含まれます。
`authorize` オプションには、イベントソースを入力値として受け取り、許可された認可されたクレデンシャルを含むオブジェクトを Promise の値として返す関数を指定します。このイベントソースの情報には、 `teamId` (常に存在します)、 `userId``conversationId``enterpriseId` のような、リクエストが誰によって発生させられたか、どこで発生したかに関する情報が含まれます。

許可されたクレデンシャルには、`botToken``userToken``botId` (アプリがボット自体からのメッセージを無視するために必要です)、 `botUserId` が含まれます。[`context`](#context) オブジェクトに、これ以外の他のプロパティを自由に設定することもできます。

Expand Down
2 changes: 1 addition & 1 deletion docs/_advanced/ja_context.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ order: 6
---

<div class="section-content">
`context` オブジェクトは、受信イベントに付加情報を提供するために使用されるもので、全てのリスナーがこれを使用できます。例えば、3rd party のシステムからユーザー情報を追加したり、ミドルウェアのチェインの中で次のミドルウェアが必要とする一時的な状態を追加したりといった用途に利用できます。
`context` オブジェクトは、受信リクエストに付加情報を提供するために使用されるもので、全てのリスナーがこれを使用できます。例えば、3rd party のシステムからユーザー情報を追加したり、ミドルウェアのチェインの中で次のミドルウェアが必要とする一時的な状態を追加したりといった用途に利用できます。

`context` は、ただのオブジェクトなので、いくらでも属性を追加、編集することができます。
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/_advanced/ja_middleware_global.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ order: 4
---

<div class="section-content">
グローバルミドルウェアは、すべての受信イベントに対して、リスナーミドルウェアより前に実行されます。`app.use(fn({payload,...,next}))` を使用すると、グローバルミドルウェアをいくつでもアプリに追加できます。
グローバルミドルウェアは、すべての受信リクエストに対して、リスナーミドルウェアより前に実行されます。`app.use(fn({payload,...,next}))` を使用すると、グローバルミドルウェアをいくつでもアプリに追加できます。

グローバルミドルウェアとリスナーミドルウェアは、いずれも、`await next()` を呼び出して実行チェーンの制御を次のミドルウェアに渡すか、`throw` を呼び出して以前に実行したミドルウェアチェーンにエラーを渡す必要があります。

Expand All @@ -16,7 +16,7 @@ order: 4
</div>

```javascript
// Acme ID情報管理プロバイダ上のユーザからの着信イベントと紐つけた認証ミドルウェア
// Acme ID情報管理プロバイダ上のユーザからの着信リクエストと紐つけた認証ミドルウェア
async function authWithAcme({ payload, client, context, next }) {
const slackUserId = payload.user;
const helpChannelId = 'C12345';
Expand All @@ -28,7 +28,7 @@ async function authWithAcme({ payload, client, context, next }) {
// 検索できたらそのユーザ情報でコンテクストを生成
context.user = user;
} catch (error) {
// Acme システム上にユーザが存在しないのでエラーをわたし、イベントプロセスを終了
// Acme システム上にユーザが存在しないパターン。エラーを伝えることとし、リクエストの処理は継続しない
if (error.message === 'Not Found') {
await client.chat.postEphemeral({
channel: payload.channel,
Expand Down
4 changes: 2 additions & 2 deletions docs/_basic/ja_acknowledging_requests.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: イベントの確認
title: リクエストの確認
lang: ja-jp
slug: acknowledge
order: 7
---

<div class="section-content">
アクション(action)、コマンド(command)、およびオプション(options)イベントは**必ず** `ack()` 関数を用いて確認する必要があります。これにより Slack 側にイベントが正常に受信されたことを知らせることができ、それに応じて Slack のユーザーインターフェイスが更新されます。イベントのタイプによっては、確認の通知方法が異なる場合があります。たとえば、モーダルの送信を確認するとき、送信内容にエラーがあればバリデーションエラーとともに `ack()` を呼び出しますが、送信内容が問題なければ、そのようなパラメータなしで `ack()` を呼び出します。
アクション(action)、コマンド(command)、およびオプション(options)リクエストは**必ず** `ack()` 関数を用いて確認する必要があります。これにより Slack 側にリクエストが正常に受信されたことを知らせることができ、それに応じて Slack のユーザーインターフェイスが更新されます。リクエストのタイプによっては、確認の通知方法が異なる場合があります。たとえば、モーダルの送信を確認するとき、送信内容にエラーがあればバリデーションエラーとともに `ack()` を呼び出しますが、送信内容が問題なければ、そのようなパラメータなしで `ack()` を呼び出します。

この `ack()` による応答は 3 秒以内に行う必要があります。新しいメッセージの送信や、データベースからの情報の取得などを行う前に、リクエストを受けてすぐに `ack()` を呼び出して応答を返してしまうことをおすすめします。
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/_basic/ja_listening_actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Bolt アプリは `action` メソッドを用いて、ボタンのクリック

アクションは文字列型の `action_id` または RegExp オブジェクトでフィルタリングできます。 `action_id` は、Slack プラットフォーム上のインタラクティブコンポーネントの一意の識別子として機能します。

すべての `action()` の例で `ack()` が使用されていることに注目してください。Slack からイベントを受信したことを確認するために、アクションリスナー内で `ack()` 関数を呼び出す必要があります。これについては、「[イベントの確認](#acknowledge)」 セクションで説明しています。
すべての `action()` の例で `ack()` が使用されていることに注目してください。Slack からリクエストを受信したことを確認するために、アクションリスナー内で `ack()` 関数を呼び出す必要があります。これについては、「[リクエストの確認](#acknowledge)」 セクションで説明しています。

*注: Bolt 2.x からメッセージショートカット(以前はメッセージアクションと呼ばれていました)は `action()` ではなく `shortcut()` メソッドを使用するようになりました。この変更については [2.x マイグレーションガイド](https://slack.dev/bolt/ja-jp/tutorial/migration-v2)を参照してください。*
</div>
Expand Down
6 changes: 3 additions & 3 deletions docs/_basic/ja_listening_modals.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ order: 12
---

<div class="section-content">
<a href="https://api.slack.com/reference/block-kit/views">モーダルのペイロード</a>が入力のブロックを含む場合、その入力値を受け取るために <code>view_submission</code> のイベントをリッスンする必要があります。<code>view_submission</code> イベントをリッスンするためには、組み込みの <code>view()</code> メソッドを使用します。
<a href="https://api.slack.com/reference/block-kit/views">モーダルのペイロード</a>が入力のブロックを含む場合、その入力値を受け取るために <code>view_submission</code> のリクエストをリッスンする必要があります。<code>view_submission</code> イベントをリッスンするためには、組み込みの <code>view()</code> メソッドを使用します。

<code>view()</code> メソッドは、文字列型または <code>RegeExp</code>型 の <code>callback_id</code> を必要とします。

Expand All @@ -16,9 +16,9 @@ order: 12
</div>

```javascript
// モーダルでのデータ送信イベントを処理します
// モーダルでのデータ送信リクエストを処理します
app.view('view_b', async ({ ack, body, view, client }) => {
// モーダルでのデータ送信イベントを確認
// モーダルでのデータ送信リクエストを確認
await ack();

// 入力値を使ってやりたいことをここで実装 - ここでは DB に保存して送信内容の確認を送っている
Expand Down
4 changes: 2 additions & 2 deletions docs/_basic/ja_listening_responding_commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ order: 9
---

<div class="section-content">
スラッシュコマンドが実行されたイベントをリッスンするには、アプリで `command()` メソッドを使用します。メソッドの使用には文字列か正規表現の `commandName` の指定が必要です。
スラッシュコマンドが実行されたリクエストをリッスンするには、アプリで `command()` メソッドを使用します。メソッドの使用には文字列か正規表現の `commandName` の指定が必要です。

⚠️ 同じ対象にマッチする正規表現の `command()` を複数使用する場合、マッチする _全ての_ リスナーが実行されることに注意してください。そのような挙動を意図しない場合は、これが発生しないよう正規表現をデザインしてください。

アプリがスラッシュコマンドのイベントを受け取ったことを `ack()` の実行によって Slack に通知する必要があります。
アプリがスラッシュコマンドのリクエストを受け取ったことを `ack()` の実行によって Slack に通知する必要があります。

スラッシュコマンドへの応答には 2 つのやり方があります。1 つ目の方法は、文字列または JSON ペイロードを受け取る `say()` で、2 つ目は `response_url` を簡単に利用するためのユーティリティである `respond()` です。これらについては、「[アクションへの応答](#action-respond)」セクションで詳しく説明しています。

Expand Down
4 changes: 2 additions & 2 deletions docs/_basic/ja_listening_responding_shortcuts.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ order: 8
<div class="section-content">
`shortcut()` メソッドは、[グローバルショートカット](https://api.slack.com/interactivity/shortcuts/using#global_shortcuts)[メッセージショートカット](https://api.slack.com/interactivity/shortcuts/using#message_shortcuts)の両方をサポートします。

ショートカットは、テキスト入力エリアや検索バーから起動できる Slack クライアント内の UI エレメントです。グローバルショートカットは、コンポーザーメニューまたは検索メニューから呼び出すことができます。メッセージショートカットは、メッセージのコンテキストメニュー内にあります。`shortcut()` メソッドを使って、これらのショートカットのイベントをリッスンすることができます。このメソッドには `callback_id` を文字列または正規表現のデータ型で設定します。
ショートカットは、テキスト入力エリアや検索バーから起動できる Slack クライアント内の UI エレメントです。グローバルショートカットは、コンポーザーメニューまたは検索メニューから呼び出すことができます。メッセージショートカットは、メッセージのコンテキストメニュー内にあります。`shortcut()` メソッドを使って、これらのショートカットのリクエストをリッスンすることができます。このメソッドには `callback_id` を文字列または正規表現のデータ型で設定します。

⚠️ 同じ対象にマッチする正規表現の `shortcut()` を複数使用する場合、マッチする _全ての_ リスナーが実行されることに注意してください。そのような挙動を意図しない場合は、これが発生しないよう正規表現をデザインしてください。

グローバルショートカットのイベントは Slack へイベントを受信したことを知らせるために `ack()` メソッドで確認する必要があります。
グローバルショートカットのリクエストは Slack へリクエストを受信したことを知らせるために `ack()` メソッドで確認する必要があります。

グローバルショートカットのペイロードは、ユーザーの実行アクションの確認のために[モーダルを開く](#creating-modals)などの用途に使用できる `trigger_id` を含んでいます。

Expand Down
2 changes: 1 addition & 1 deletion docs/_basic/ja_responding_actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ order: 6
---

<div class="section-content">
アクションへの応答には、主に 2 つのやり方があります。1 つ目の (最も一般的な) やり方は `say` 関数の利用です。 `say` 関数は、Slack 内のイベントが発生した会話(チャンネルや DM)へメッセージを返します。
アクションへの応答には、主に 2 つのやり方があります。1 つ目の (最も一般的な) やり方は `say` 関数の利用です。 `say` 関数は、Slack 内のリクエストが発生した会話(チャンネルや DM)へメッセージを返します。

アクションに応答する 2 つ目の方法は `respond()` です。これはアクションに紐付けられている `response_url` を用いたメッセージの送信をシンプルに行うためのユーティリティです。
</div>
Expand Down

0 comments on commit 7f1ec57

Please sign in to comment.