diff --git a/docs/_advanced/ja_adapters.md b/docs/_advanced/ja_adapters.md index 025ff6116..54aa42eb7 100644 --- a/docs/_advanced/ja_adapters.md +++ b/docs/_advanced/ja_adapters.md @@ -6,11 +6,11 @@ order: 0 ---
-アダプターは Slack から届く受信イベントの受付とパーズを担当し、それらのイベントを `BoltRequest` の形式に変換して Bolt アプリに引き渡します。 +アダプターは Slack から届く受信リクエストの受付とパーズを担当し、それらのリクエストを `BoltRequest` の形式に変換して Bolt アプリに引き渡します。 デフォルトでは、Bolt の組み込みの `HTTPServer` アダプターが使われます。このアダプターは、ローカルで開発するのには問題がありませんが、本番環境での利用は推奨されていません。Bolt for Python には複数の組み込みのアダプターが用意されており、必要に応じてインポートしてアプリで使用することができます。組み込みのアダプターは Flask、Django、Starlette をはじめとする様々な人気の Python フレームワークをサポートしています。これらのアダプターは、あなたが選択した本番環境で利用可能な Webサーバーとともに利用することができます。 -アダプターを使用するには、任意のフレームワークを使ってアプリを開発し、そのコードに対応するアダプターをインポートします。その後、アダプターのインスタンスを初期化して、受信イベントの受付とパーズを行う関数を呼び出します。 +アダプターを使用するには、任意のフレームワークを使ってアプリを開発し、そのコードに対応するアダプターをインポートします。その後、アダプターのインスタンスを初期化して、受信リクエストの受付とパーズを行う関数を呼び出します。 すべてのアダプターの一覧と、設定や使い方のサンプルは、リポジトリの `examples` フォルダをご覧ください。
diff --git a/docs/_advanced/ja_authorization.md b/docs/_advanced/ja_authorization.md index c329f87c5..98f6676fc 100644 --- a/docs/_advanced/ja_authorization.md +++ b/docs/_advanced/ja_authorization.md @@ -6,19 +6,19 @@ order: 5 ---
-認可（Authorization）は、Slack からの受信イベントを処理するにあたって、どのようなSlack +認可（Authorization）は、Slack からの受信リクエストを処理するにあたって、どのようなSlack クレデンシャル (ボットトークンなど) を使用可能にするかを決定するプロセスです。 単一のワークスペースにインストールされるアプリでは、`token` パラメーターを使って `App` のコンストラクターにボットトークンを渡すという、シンプルな方法が使えます。それに対して、複数のワークスペースにインストールされるアプリでは、次の 2 つの方法のいずれかを使用する必要があります。簡単なのは、組み込みの OAuth サポートを使用する方法です。OAuth サポートは、OAuth フロー用のURLのセットアップとstateの検証を行います。詳細は「[OAuth を使った認証](#authenticating-oauth)」セクションを参照してください。 -よりカスタマイズできる方法として、`App` をインスタンス化する関数に`authorize` パラメーターを指定する方法があります。`authorize` 関数から返される [`AuthorizeResult` のインスタンス](https://github.com/slackapi/bolt-python/blob/main/slack_bolt/authorization/authorize_result.py)には、どのユーザーがどこで発生させたイベントかを示す情報が含まれます。 +よりカスタマイズできる方法として、`App` をインスタンス化する関数に`authorize` パラメーターを指定する方法があります。`authorize` 関数から返される [`AuthorizeResult` のインスタンス](https://github.com/slackapi/bolt-python/blob/main/slack_bolt/authorization/authorize_result.py)には、どのユーザーがどこで発生させたリクエストかを示す情報が含まれます。 `AuthorizeResult` には、いくつか特定のプロパティを指定する必要があり、いずれも `str` 型です。 - **`bot_token`**（xoxb）*または* **`user_token`**（xoxp）: どちらか一方が**必須**です。ほとんどのアプリでは、デフォルトの `bot_token` を使用すればよいでしょう。トークンを渡すことで、`say()` などの組み込みの関数を機能させることができます。 - **`bot_user_id`** および **`bot_id`** : `bot_token` を使用する場合に指定します。 -- **`enterprise_id`** および **`team_id`** : アプリに届いたイベントから見つけることができます。 +- **`enterprise_id`** および **`team_id`** : アプリに届いたリクエストから見つけることができます。 - **`user_id`** : `user_token` を使用する場合に必須です。
diff --git a/docs/_advanced/ja_context.md b/docs/_advanced/ja_context.md index 6ddfe1bf2..759c8d50b 100644 --- a/docs/_advanced/ja_context.md +++ b/docs/_advanced/ja_context.md @@ -6,7 +6,7 @@ order: 9 ---
-すべてのリスナーは `context` ディクショナリにアクセスできます。リスナーはこれを使ってイベントの付加情報を得ることができます。受信イベントに含まれる `user_id`、`team_id`、`channel_id`、`enterprise_id` などの情報は、Bolt によって自動的に設定されます。 +すべてのリスナーは `context` ディクショナリにアクセスできます。リスナーはこれを使ってリクエストの付加情報を得ることができます。受信リクエストに含まれる `user_id`、`team_id`、`channel_id`、`enterprise_id` などの情報は、Bolt によって自動的に設定されます。 `context` は単純なディクショナリで、変更を直接加えることもできます。
diff --git a/docs/_advanced/ja_global_middleware.md b/docs/_advanced/ja_global_middleware.md index 86b844d26..7f1e995d8 100644 --- a/docs/_advanced/ja_global_middleware.md +++ b/docs/_advanced/ja_global_middleware.md @@ -6,7 +6,7 @@ order: 8 ---
-グローバルミドルウェアは、すべての受信イベントに対して、リスナーミドルウェアが呼ばれる前に実行されるものです。ミドルウェア関数を `app.use()` に渡すことで、アプリにはグローバルミドルウェアをいくつでも追加できます。ミドルウェア関数で受け取れる引数はリスナー関数と同じものに加えて`next()` 関数があります。 +グローバルミドルウェアは、すべての受信リクエストに対して、リスナーミドルウェアが呼ばれる前に実行されるものです。ミドルウェア関数を `app.use()` に渡すことで、アプリにはグローバルミドルウェアをいくつでも追加できます。ミドルウェア関数で受け取れる引数はリスナー関数と同じものに加えて`next()` 関数があります。 グローバルミドルウェアでもリスナーミドルウェアでも、次のミドルウェアに実行チェーンの制御をリレーするために、`next()` を呼び出す必要があります。
diff --git a/docs/_advanced/ja_lazy_listener.md b/docs/_advanced/ja_lazy_listener.md index 930e4d9ff..eb9c15008 100644 --- a/docs/_advanced/ja_lazy_listener.md +++ b/docs/_advanced/ja_lazy_listener.md @@ -8,11 +8,11 @@ order: 10
⚠️ Lazy リスナー関数は、FaaS 環境への Bolt for Python アプリのデプロイを容易にする、ベータ版の機能です。開発中の機能であるため、Bolt for Python の API は変更される可能性があります。 -通常、リスナー関数では最初の手順として `ack()` を呼び出します。`ack()` を呼び出すことで、アプリがイベントを受け取り、適切な時間内（3 秒間）に処理する予定であることが Slack に伝えられます。 +通常、リスナー関数では最初の手順として `ack()` を呼び出します。`ack()` を呼び出すことで、アプリがリクエストを受け取り、適切な時間内（3 秒間）に処理する予定であることが Slack に伝えられます。 -しかし、FaaS 環境や類似のランタイムで実行されるアプリでは、HTTP レスポンスを返したあとにスレッドやプロセスの実行を続けることができないため、同じパターンに従うことはできません。代わりに、`process_before_response` フラグを `True` に設定します。この設定により、`ack()` の呼び出しとイベントの処理を安全に行うリスナーを作成することができます。しかし、3 秒以内にすべての処理を完了させる必要があることは変わりません。イベント APIに応答するリスナーでは`ack()` メソッドの呼び出しを必要としませんが、この設定では処理を 3 秒以内に完了させる必要があります。 +しかし、FaaS 環境や類似のランタイムで実行されるアプリでは、HTTP レスポンスを返したあとにスレッドやプロセスの実行を続けることができないため、同じパターンに従うことはできません。代わりに、`process_before_response` フラグを `True` に設定します。この設定により、`ack()` の呼び出しとリクエストの処理を安全に行うリスナーを作成することができます。しかし、3 秒以内にすべての処理を完了させる必要があることは変わりません。Events APIに応答するリスナーでは`ack()` メソッドの呼び出しを必要としませんが、この設定では処理を 3 秒以内に完了させる必要があります。 -Lazy リスナーは、この問題を解決するためのソリューションです。Lazy リスナーは、デコレーターとして動作するものではなく、次の 2 つのキーワード引数を指定することにより動作するものです。 * `ack:Callable` : `ack()` の呼び出しを行います。 * `lazy:List[Callable]` : イベントに関係する、時間のかかるプロセスの処理を担当します。Lazy 関数からは `ack()` にアクセスできません。 +Lazy リスナーは、この問題を解決するためのソリューションです。Lazy リスナーは、デコレーターとして動作するものではなく、次の 2 つのキーワード引数を指定することにより動作するものです。 * `ack:Callable` : `ack()` の呼び出しを行います。 * `lazy:List[Callable]` : リクエストに関係する、時間のかかるプロセスの処理を担当します。Lazy 関数からは `ack()` にアクセスできません。
```python diff --git a/docs/_basic/ja_acknowledging_events.md b/docs/_basic/ja_acknowledging_events.md index 51331a3ce..8967308cc 100644 --- a/docs/_basic/ja_acknowledging_events.md +++ b/docs/_basic/ja_acknowledging_events.md @@ -1,5 +1,5 @@ --- -title: イベントの確認 +title: リクエストの確認 lang: ja-jp slug: acknowledge order: 7 @@ -7,9 +7,9 @@ order: 7
-アクション（action）、コマンド（command）、およびオプション（options）の各イベントは、**必ず** `ack()` 関数を使って確認を行う必要があります。これによってイベントが受信されたことが Slack に認識され、Slack のユーザーインターフェイスが適切に更新されます。 +アクション（action）、コマンド（command）、およびオプション（options）の各リクエストは、**必ず** `ack()` 関数を使って確認を行う必要があります。これによってリクエストが受信されたことが Slack に認識され、Slack のユーザーインターフェイスが適切に更新されます。 -イベントの種類によっては、確認で通知方法が異なる場合があります。例えば、外部データソースを使用する選択メニューのオプションのリクエストに対する確認では、適切な[オプション](https://api.slack.com/reference/block-kit/composition-objects#option)のリストとともに `ack()` を呼び出します。 +リクエストの種類によっては、確認で通知方法が異なる場合があります。例えば、外部データソースを使用する選択メニューのオプションのリクエストに対する確認では、適切な[オプション](https://api.slack.com/reference/block-kit/composition-objects#option)のリストとともに `ack()` を呼び出します。 確認までの猶予は 3 秒しかないため、新しいメッセージの送信や、データベースからの情報の取得は、`ack()` を呼び出した後で行うことをおすすめします。 diff --git a/docs/_basic/ja_listening_actions.md b/docs/_basic/ja_listening_actions.md index 6456b56ab..b468fdd42 100644 --- a/docs/_basic/ja_listening_actions.md +++ b/docs/_basic/ja_listening_actions.md @@ -10,7 +10,7 @@ Bolt アプリは `action` メソッドを用いて、ボタンのクリック アクションは `str` 型または `re.Pattern` 型の `action_id` でフィルタリングできます。`action_id` は、Slack プラットフォーム上のインタラクティブコンポーネントを区別する一意の識別子として機能します。 -`action()` を使ったすべての例で `ack()` が使用されていることに注目してください。アクションのリスナー内では、Slack からのイベントを受信したことを確認するために、`ack()` 関数を呼び出す必要があります。これについては、[イベントの確認](#acknowledge)セクションで説明しています。 +`action()` を使ったすべての例で `ack()` が使用されていることに注目してください。アクションのリスナー内では、Slack からのリクエストを受信したことを確認するために、`ack()` 関数を呼び出す必要があります。これについては、[リクエストの確認](#acknowledge)セクションで説明しています。
diff --git a/docs/_basic/ja_listening_modals.md b/docs/_basic/ja_listening_modals.md index 66d6aa020..d169faeb5 100644 --- a/docs/_basic/ja_listening_modals.md +++ b/docs/_basic/ja_listening_modals.md @@ -7,7 +7,7 @@ order: 12
-モーダルのペイロードに input ブロックを含める場合、その入力値を受け取るために`view_submission` イベントをリッスンする必要があります。`view_submission` イベントのリッスンには、組み込みの`view()` メソッドを利用することができます。`view()` の引数には、`str` 型または `re.Pattern` 型の `callback_id` を指定します。 +モーダルのペイロードに input ブロックを含める場合、その入力値を受け取るために`view_submission` リクエストをリッスンする必要があります。`view_submission` リクエストのリッスンには、組み込みの`view()` メソッドを利用することができます。`view()` の引数には、`str` 型または `re.Pattern` 型の `callback_id` を指定します。 `input` ブロックの値にアクセスするには `state` オブジェクトを参照します。`state` 内には `values` というオブジェクトがあり、`block_id` と一意の `action_id` に紐づける形で入力値を保持しています。 @@ -18,7 +18,7 @@ order: 12
指定可能な引数の一覧はモジュールドキュメントを参考にしてください。 ```python -# view_submission イベントを処理 +# view_submission リクエストを処理 @app.view("view_1") def handle_submission(ack, body, client, view, logger): # `block_c`という block_id に `dreamy_input` を持つ input ブロックがある場合 @@ -31,7 +31,7 @@ def handle_submission(ack, body, client, view, logger): if len(errors) > 0: ack(response_action="errors", errors=errors) return - # view_submission イベントの確認を行い、モーダルを閉じる + # view_submission リクエストの確認を行い、モーダルを閉じる ack() # 入力されたデータを使った処理を実行。このサンプルでは DB に保存する処理を行う # そして入力値の検証結果をユーザーに送信 diff --git a/docs/_basic/ja_listening_responding_commands.md b/docs/_basic/ja_listening_responding_commands.md index 3895c4d79..98c63f0ae 100644 --- a/docs/_basic/ja_listening_responding_commands.md +++ b/docs/_basic/ja_listening_responding_commands.md @@ -7,9 +7,9 @@ order: 9
-スラッシュコマンドが実行されたイベントをリッスンするには、`command()` メソッドを使用します。このメソッドでは `str` 型の `command_name` の指定が必要です。 +スラッシュコマンドが実行されたリクエストをリッスンするには、`command()` メソッドを使用します。このメソッドでは `str` 型の `command_name` の指定が必要です。 -コマンドイベントをアプリが受信し確認したことを Slack に通知するため、`ack()` を呼び出す必要があります。 +コマンドリクエストをアプリが受信し確認したことを Slack に通知するため、`ack()` を呼び出す必要があります。 スラッシュコマンドに応答する方法は 2 つあります。1 つ目は `say()` を使う方法で、文字列または JSON のペイロードを渡すことができます。2 つ目は `respond()` を使う方法です。これは `response_url` がある場合に活躍します。これらの方法は[アクションへの応答](#action-respond)セクションで詳しく説明しています。 diff --git a/docs/_basic/ja_listening_responding_shortcuts.md b/docs/_basic/ja_listening_responding_shortcuts.md index 03fbb7fb8..282756049 100644 --- a/docs/_basic/ja_listening_responding_shortcuts.md +++ b/docs/_basic/ja_listening_responding_shortcuts.md @@ -9,9 +9,9 @@ order: 8 `shortcut()` メソッドは、[グローバルショートカット](https://api.slack.com/interactivity/shortcuts/using#global_shortcuts)と[メッセージショートカット](https://api.slack.com/interactivity/shortcuts/using#message_shortcuts)の 2 つをサポートしています。 -ショートカットは、いつでも呼び出せるアプリのエントリーポイントを提供するものです。グローバルショートカットは Slack のテキスト入力エリアや検索ウィンドウからアクセスできます。メッセージショートカットはメッセージのコンテキストメニューからアクセスできます。アプリは、ショートカットイベントをリッスンするために `shortcut()` メソッドを使用します。このメソッドには `str` 型または `re.Pattern` 型の `callback_id` パラメーターを指定します。 +ショートカットは、いつでも呼び出せるアプリのエントリーポイントを提供するものです。グローバルショートカットは Slack のテキスト入力エリアや検索ウィンドウからアクセスできます。メッセージショートカットはメッセージのコンテキストメニューからアクセスできます。アプリは、ショートカットリクエストをリッスンするために `shortcut()` メソッドを使用します。このメソッドには `str` 型または `re.Pattern` 型の `callback_id` パラメーターを指定します。 -ショートカットイベントがアプリによって確認されたことを Slack に伝えるため、`ack()` を呼び出す必要があります。 +ショートカットリクエストがアプリによって確認されたことを Slack に伝えるため、`ack()` を呼び出す必要があります。 ショートカットのペイロードには `trigger_id` が含まれます。アプリはこれを使って、ユーザーにやろうとしていることを確認するための[モーダルを開く](#creating-modals)ことができます。 diff --git a/docs/_basic/ja_responding_actions.md b/docs/_basic/ja_responding_actions.md index 0068073e6..fb6a50033 100644 --- a/docs/_basic/ja_responding_actions.md +++ b/docs/_basic/ja_responding_actions.md @@ -7,7 +7,7 @@ order: 6
-アクションへの応答には、主に 2 つの方法があります。1 つ目の最も一般的なやり方は `say()` を使用する方法です。そのイベントが発生した会話（チャンネルや DM）にメッセージを返します。 +アクションへの応答には、主に 2 つの方法があります。1 つ目の最も一般的なやり方は `say()` を使用する方法です。そのリクエストが発生した会話（チャンネルや DM）にメッセージを返します。 2 つ目は、`respond()` を使用する方法です。これは、アクションに関連づけられた `response_url` を使ったメッセージ送信を行うためのユーティリティです。