diff --git a/README.md b/README.md index 8f73858fe..1145d79ed 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ [![codecov](https://codecov.io/gh/slackapi/bolt-js/branch/main/graph/badge.svg?token=x4oCgiexvp)](https://codecov.io/gh/slackapi/bolt-js) [![Node.js CI](https://github.com/slackapi/bolt-js/actions/workflows/ci-build.yml/badge.svg)](https://github.com/slackapi/bolt-js/actions/workflows/ci-build.yml) -A JavaScript framework to build Slack apps in a flash with the latest platform features. Read the [getting started guide](https://slack.dev/bolt-js/tutorial/getting-started) to set-up and run your first Bolt app. +A JavaScript framework to build Slack apps in a flash with the latest platform features. Read the [getting started guide](https://tools.slack.dev/bolt-js/tutorial/getting-started) to set-up and run your first Bolt app. -Read [the documentation](https://slack.dev/bolt-js) to explore the basic and advanced concepts of Bolt for JavaScript. +Read [the documentation](https://tools.slack.dev/bolt-js) to explore the basic and advanced concepts of Bolt for JavaScript. ## Setup @@ -80,7 +80,7 @@ Most of the app's functionality will be inside listener functions (the `fn` para | Argument | Description | | :---: | :--- | -| `payload` | Contents of the incoming event. The payload structure depends on the listener. For example, for an Events API event, `payload` will be the [event type structure](https://api.slack.com/events-api#event_type_structure). For a block action, it will be the action from within the `actions` array. The `payload` object is also accessible via the alias corresponding to the listener (`message`, `event`, `action`, `shortcut`, `view`, `command`, or `options`). For example, if you were building a `message()` listener, you could use the `payload` and `message` arguments interchangeably. **An easy way to understand what's in a payload is to log it**, or [use TypeScript](https://slack.dev/bolt-js/tutorial/using-typescript). | +| `payload` | Contents of the incoming event. The payload structure depends on the listener. For example, for an Events API event, `payload` will be the [event type structure](https://api.slack.com/events-api#event_type_structure). For a block action, it will be the action from within the `actions` array. The `payload` object is also accessible via the alias corresponding to the listener (`message`, `event`, `action`, `shortcut`, `view`, `command`, or `options`). For example, if you were building a `message()` listener, you could use the `payload` and `message` arguments interchangeably. **An easy way to understand what's in a payload is to log it**, or use TypeScript. | | `say` | Function to send a message to the channel associated with the incoming event. This argument is only available when the listener is triggered for events that contain a `channel_id` (the most common being `message` events). `say` accepts simple strings (for plain-text messages) and objects (for messages containing blocks). `say` returns a promise that will resolve with a [`chat.postMessage` response](https://api.slack.com/methods/chat.postMessage). | `ack` | Function that **must** be called to acknowledge that an incoming event was received by your app. `ack` exists for all actions, shortcuts, view, slash command and options requests. `ack` returns a promise that resolves when complete. Read more in [Acknowledging events](#acknowledging-events) | `client` | Web API client that uses the token associated with that event. For single-workspace installations, the token is provided to the constructor. For multi-workspace installations, the token is returned by the `authorize` function. @@ -107,7 +107,7 @@ app.message(async ({ message, say }) => { ### Calling the Web API -In addition to the [`client` property passed to listeners](#making-things-happen), each app has a top-level `client` that can be used to call methods. Unlike the `client` passed to listeners, the top-level client must be passed a `token`. [Read the documentation](https://slack.dev/bolt-js/concepts#web-api) for more details. +In addition to the [`client` property passed to listeners](#making-things-happen), each app has a top-level `client` that can be used to call methods. Unlike the `client` passed to listeners, the top-level client must be passed a `token`. [Read the documentation](https://tools.slack.dev/bolt-js/concepts#web-api) for more details. ### Acknowledging events @@ -129,7 +129,7 @@ Depending on the type of incoming event a listener is meant for, `ack()` should ## Getting Help -[The documentation](https://slack.dev/bolt-js) has more information on basic and advanced concepts for Bolt for JavaScript. +[The documentation](https://tools.slack.dev/bolt-js) has more information on basic and advanced concepts for Bolt for JavaScript. If you otherwise get stuck, we're here to help. The following are the best ways to get assistance working through your issue: diff --git a/docs/README.md b/docs/README.md index 4df7305eb..4d5186390 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# slack.dev/bolt-js +# tools.slack.dev/bolt-js This website is built using [Docusaurus](https://docusaurus.io/). 'Tis cool. diff --git a/docs/content/basic/authenticating-oauth.md b/docs/content/basic/authenticating-oauth.md index 949c18571..1e074ae96 100644 --- a/docs/content/basic/authenticating-oauth.md +++ b/docs/content/basic/authenticating-oauth.md @@ -702,30 +702,30 @@ for additional details for common error codes. [authorization]: /concepts/authorization [callback-default-failure]: https://github.com/slackapi/node-slack-sdk/blob/e5a4f3fbbd4f6aad9fdd415976f80668b01fd442/packages/oauth/src/callback-options.ts#L127-L162 [callback-default-success]: https://github.com/slackapi/node-slack-sdk/blob/e5a4f3fbbd4f6aad9fdd415976f80668b01fd442/packages/oauth/src/callback-options.ts#L81-L125 -[callback-options]: https://slack.dev/node-slack-sdk/reference/oauth/interfaces/CallbackOptions +[callback-options]: https://tools.slack.dev/node-slack-sdk/reference/oauth/interfaces/CallbackOptions [callback-options-default]: https://github.com/slackapi/node-slack-sdk/blob/e5a4f3fbbd4f6aad9fdd415976f80668b01fd442/packages/oauth/src/callback-options.ts#L81-L162 -[callbacks]: https://slack.dev/node-slack-sdk/reference/oauth/interfaces/CallbackOptions +[callbacks]: https://tools.slack.dev/node-slack-sdk/reference/oauth/interfaces/CallbackOptions [custom-routes]: /concepts/custom-routes [direct-install]: https://github.com/slackapi/bolt-js/blob/5b4d9ceb65e6bf5cf29dfa58268ea248e5466bfb/examples/oauth/app.js#L58-L64 [errors]: https://api.slack.com/authentication/oauth-v2#errors [examples]: https://github.com/slackapi/bolt-js/tree/main/examples/oauth -[generate-install-url]: https://slack.dev/node-slack-sdk/oauth/#using-handleinstallpath +[generate-install-url]: https://tools.slack.dev/node-slack-sdk/oauth/#using-handleinstallpath [install-provider-options]: https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/install-provider-options.ts -[installation-page]: https://slack.dev/node-slack-sdk/oauth/#showing-an-installation-page -[installation-store]: https://slack.dev/node-slack-sdk/reference/oauth/interfaces/InstallationStore +[installation-page]: https://tools.slack.dev/node-slack-sdk/oauth/#showing-an-installation-page +[installation-store]: https://tools.slack.dev/node-slack-sdk/reference/oauth/interfaces/InstallationStore [installation-store-file]: https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/installation-stores/file-store.ts -[oauth-node]: https://slack.dev/node-slack-sdk/oauth +[oauth-node]: https://tools.slack.dev/node-slack-sdk/oauth [oauth-v2]: https://api.slack.com/authentication/oauth-v2 -[oidc]: https://slack.dev/node-slack-sdk/web-api#sign-in-with-slack-via-openid-connect +[oidc]: https://tools.slack.dev/node-slack-sdk/web-api#sign-in-with-slack-via-openid-connect [org-ready]: https://api.slack.com/enterprise/org-ready-apps [org-ready-oauth]: https://api.slack.com/enterprise/org-ready-apps#oauth [scopes]: https://api.slack.com/scopes [settings]: https://api.slack.com/apps [siws]: https://api.slack.com/authentication/sign-in-with-slack -[state]: https://slack.dev/node-slack-sdk/oauth#using-a-custom-state-store -[state-store]: https://slack.dev/node-slack-sdk/reference/oauth/interfaces/StateStore +[state]: https://tools.slack.dev/node-slack-sdk/oauth#using-a-custom-state-store +[state-store]: https://tools.slack.dev/node-slack-sdk/reference/oauth/interfaces/StateStore [state-store-clear]: https://github.com/slackapi/node-slack-sdk/blob/main/packages/oauth/src/state-stores/clear-state-store.ts -[store]: https://slack.dev/node-slack-sdk/oauth#storing-installations-in-a-database +[store]: https://tools.slack.dev/node-slack-sdk/oauth#storing-installations-in-a-database [user-tokens]: https://api.slack.com/concepts/token-types#user -[verification]: https://slack.dev/node-slack-sdk/oauth#state-verification -[web-api]: https://slack.dev/node-slack-sdk/web-api +[verification]: https://tools.slack.dev/node-slack-sdk/oauth#state-verification +[web-api]: https://tools.slack.dev/node-slack-sdk/web-api diff --git a/docs/content/basic/web-api.md b/docs/content/basic/web-api.md index 2a970d32c..c6c2f27cd 100644 --- a/docs/content/basic/web-api.md +++ b/docs/content/basic/web-api.md @@ -4,11 +4,11 @@ lang: en slug: /concepts/web-api --- -You can call [any Web API method](https://api.slack.com/methods) using the [`WebClient`](https://slack.dev/node-slack-sdk/web-api) provided to your app's listeners as `client`. This uses either the token that initialized your app **or** the token that is returned from the [`authorize`](/concepts/authorization) function for the incoming event. The built-in [OAuth support](/concepts/authenticating-oauth) handles the second case by default. +You can call [any Web API method](https://api.slack.com/methods) using the [`WebClient`](https://tools.slack.dev/node-slack-sdk/web-api) provided to your app's listeners as `client`. This uses either the token that initialized your app **or** the token that is returned from the [`authorize`](/concepts/authorization) function for the incoming event. The built-in [OAuth support](/concepts/authenticating-oauth) handles the second case by default. Your Bolt app also has a top-level `app.client` which you can manually pass the `token` parameter. If the incoming request is not authorized or you're calling a method from outside of a listener, use the top-level `app.client`. -Calling one of the [`WebClient`](https://slack.dev/node-slack-sdk/web-api)'s methods will return a Promise containing the response from Slack, regardless of whether you use the top-level or listener's client. +Calling one of the [`WebClient`](https://tools.slack.dev/node-slack-sdk/web-api)'s methods will return a Promise containing the response from Slack, regardless of whether you use the top-level or listener's client. Since the introduction of [org wide app installations](https://api.slack.com/enterprise/apps), [some web-api methods](https://api.slack.com/enterprise/apps/changes-apis#methods) now require `team_id` to indicate which workspace to act on. Bolt for JavaScript will attempt to infer the `team_id` based on incoming payloads and pass it along to `client`. This is handy for existing applications looking to add support for org wide installations and not spend time updating all of these web-api calls. diff --git a/docs/content/reference.md b/docs/content/reference.md index c4c7a06be..44e9f1fec 100644 --- a/docs/content/reference.md +++ b/docs/content/reference.md @@ -128,7 +128,7 @@ App options are passed into the `App` constructor. When the `receiver` argument | Option | Description | | :--- | :--- | | `receiver` | An instance of `Receiver` that parses and handles incoming events. Must conform to the [`Receiver` interface](/concepts/receiver), which includes `init(app)`, `start()`, and `stop()`. More information about receivers is [in the documentation](/concepts/receiver). | -| `agent` | Optional HTTP `Agent` used to set up proxy support. Read more about custom agents in the [Node Slack SDK documentation](https://slack.dev/node-slack-sdk/web-api#proxy-requests-with-a-custom-agent). | +| `agent` | Optional HTTP `Agent` used to set up proxy support. Read more about custom agents in the [Node Slack SDK documentation](https://tools.slack.dev/node-slack-sdk/web-api#proxy-requests-with-a-custom-agent). | | `clientTls` | Optional `string` to set a custom TLS configuration for HTTP client requests. Must be one of: `"pfx"`, `"key"`, `"passphrase"`, `"cert"`, or `"ca"`. | | `convoStore` | A store to set and retrieve state-related conversation information. `set()` sets conversation state and `get()` fetches it. By default, apps have access to an in-memory store. More information and an example can be found [in the documentation](/concepts/conversation-store). | | `token` | A `string` from your app's configuration (under "Settings" > "Install App") required for calling the Web API. May not be passed when using `authorize`, `orgAuthorize`, or OAuth. | @@ -147,7 +147,7 @@ App options are passed into the `App` constructor. When the `receiver` argument :::info -Bolt's client is an instance of `WebClient` from the [Node Slack SDK](https://slack.dev/node-slack-sdk), so some of that documentation may be helpful as you're developing. +Bolt's client is an instance of `WebClient` from the [Node Slack SDK](https://tools.slack.dev/node-slack-sdk), so some of that documentation may be helpful as you're developing. ::: @@ -172,11 +172,11 @@ You can find the code for error definition and construction within [errors.ts](h ::: ### Client errors -Bolt imports a `WebClient` to call Slack's APIs. Below is a set of errors you may encounter when making API calls with the client, though you can read more [in the web API documentation](https://slack.dev/node-slack-sdk/web-api#handle-errors). When handling client errors, more information can be found in the body within the `data` property. +Bolt imports a `WebClient` to call Slack's APIs. Below is a set of errors you may encounter when making API calls with the client, though you can read more [in the web API documentation](https://tools.slack.dev/node-slack-sdk/web-api#handle-errors). When handling client errors, more information can be found in the body within the `data` property. | Error code | Details | | :--- | :--- | | `PlatformError` | Error received when calling a Slack API. Includes a `data` property. | | `RequestError` | A request could not be sent, perhaps because your network connection is not available. It has an `original` property with more details. | -| `RateLimitedError` | Your app has made too many requests too quickly. Includes a `retryAfter` property with the number of seconds you should wait before trying to send again. The `WebClient` will handle rate limit errors by default–[you can read more in the documentation](https://slack.dev/node-slack-sdk/web-api#rate-limits). | +| `RateLimitedError` | Your app has made too many requests too quickly. Includes a `retryAfter` property with the number of seconds you should wait before trying to send again. The `WebClient` will handle rate limit errors by default–[you can read more in the documentation](https://tools.slack.dev/node-slack-sdk/web-api#rate-limits). | | `HTTPError` | The HTTP response contained an unfamiliar status code. The Web API only responds with `200` (including for errors), or `429` for rate limiting. | diff --git a/docs/content/tutorial/hubot-migration.md b/docs/content/tutorial/hubot-migration.md index fd3144884..3f2ef5b2e 100644 --- a/docs/content/tutorial/hubot-migration.md +++ b/docs/content/tutorial/hubot-migration.md @@ -53,7 +53,7 @@ The [Events API](https://api.slack.com/bot-users#app-mentions-response) is a bot :::info -Before you configure your bot’s events, you’ll need a public URL. If you’ve never created a Bolt for JavaScript app or never used the Events API, it’d be helpful to go through [setting up your local Bolt project](/getting-started) and [setting up events](https://slack.dev/getting-started#setting-up-events) in the Getting Started guide. +Before you configure your bot’s events, you’ll need a public URL. If you’ve never created a Bolt for JavaScript app or never used the Events API, it’d be helpful to go through [setting up your local Bolt project](/getting-started) and [setting up events](https://tools.slack.dev/getting-started#setting-up-events) in the Getting Started guide. ::: diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 0da3e9f36..0a2058be9 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -12,7 +12,7 @@ const config = { tagline: 'Official frameworks, libraries, and SDKs for Slack developers', favicon: 'img/favicon.ico', - url: 'https://slack.dev', + url: 'https://tools.slack.dev', baseUrl: '/bolt-js/', organizationName: 'slackapi', projectName: 'bolt-js', @@ -86,7 +86,7 @@ plugins: logo: { alt: 'Slack logo', src: 'img/slack-logo.svg', - href: 'https://slack.dev', + href: 'https://tools.slack.dev', target : '_self' }, items: [ @@ -97,17 +97,17 @@ plugins: items: [ { label: 'Java', - to: 'https://slack.dev/java-slack-sdk/guides/bolt-basics', + to: 'https://tools.slack.dev/java-slack-sdk/guides/bolt-basics', target: '_self', }, { label: 'JavaScript', - to: 'https://slack.dev/bolt-js', + to: 'https://tools.slack.dev/bolt-js', target: '_self', }, { label: 'Python', - to: 'https://slack.dev/bolt-python', + to: 'https://tools.slack.dev/bolt-python', target: '_self', }, ] @@ -119,17 +119,17 @@ plugins: items: [ { label: 'Java Slack SDK', - to: 'https://slack.dev/java-slack-sdk/', + to: 'https://tools.slack.dev/java-slack-sdk/', target: '_self', }, { label: 'Node Slack SDK', - to: 'https://slack.dev/node-slack-sdk/', + to: 'https://tools.slack.dev/node-slack-sdk/', target: '_self', }, { label: 'Python Slack SDK', - to: 'https://slack.dev/python-slack-sdk/', + to: 'https://tools.slack.dev/python-slack-sdk/', target: '_self', }, { @@ -146,7 +146,7 @@ plugins: items: [ { label: 'Community tools', - to: 'https://slack.dev/community-tools', + to: 'https://tools.slack.dev/community-tools', target: '_self', }, { diff --git a/docs/i18n/ja-jp/README.md b/docs/i18n/ja-jp/README.md index 0939c22be..5acce6f8d 100644 --- a/docs/i18n/ja-jp/README.md +++ b/docs/i18n/ja-jp/README.md @@ -118,4 +118,4 @@ For example: }, ``` -Be careful changing `code.json`. If you change something in this repo, it will likely need to be changed in the other Slack.dev repos too, like the Bolt-Python repo. We want these translations to match for all Slack.dev sites. \ No newline at end of file +Be careful changing `code.json`. If you change something in this repo, it will likely need to be changed in the other tools.slack.dev repos too, like the Bolt-Python repo. We want these translations to match for all tools.slack.dev sites. \ No newline at end of file diff --git a/docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/basic/authenticating-oauth.md b/docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/basic/authenticating-oauth.md index da97da39b..f17fa03e7 100644 --- a/docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/basic/authenticating-oauth.md +++ b/docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/basic/authenticating-oauth.md @@ -38,9 +38,9 @@ const app = new App({ * **Slack で開く**: ユーザーが **Slack で開く** を選択した後、アプリが Slack からのイベントをするときに `installationStore` の `fetchInstallation` や `storeInstallation` ハンドラーが実行されます。ハンドラーに渡す引数に関するより詳しい情報は **Installation Object** セクションを参照してください。 -* アプリがすでにインストールされていて、さらにユーザーから追加の認可情報（例：ユーザートークンの発行）な場合や、何らかの理由で動的にインストール用の URL を生成したい場合は、`ExpressReceiver` を自前でインスタンス化し、それを `receiver` という変数に代入した上で `receiver.installer.generateInstallUrl()` を呼び出してください。詳しくは [OAuth ライブラリのドキュメント](https://slack.dev/node-slack-sdk/oauth#generating-an-installation-url)の `generateInstallUrl()` を参照してください。 +* アプリがすでにインストールされていて、さらにユーザーから追加の認可情報（例：ユーザートークンの発行）な場合や、何らかの理由で動的にインストール用の URL を生成したい場合は、`ExpressReceiver` を自前でインスタンス化し、それを `receiver` という変数に代入した上で `receiver.installer.generateInstallUrl()` を呼び出してください。詳しくは [OAuth ライブラリのドキュメント](https://tools.slack.dev/node-slack-sdk/oauth#generating-an-installation-url)の `generateInstallUrl()` を参照してください。 -* 💡 Bolt for JavaScript は [カスタムのレシーバー](/concepts/receiver)での OAuth をサポートしていません。カスタムのレシーバーで OAuth フローを実装したい場合は、私たちが提供している [OAuth ライブラリ](https://slack.dev/node-slack-sdk/oauth#slack-oauth) を使うことができます。Bolt for JavaScript の組み込みのモジュールもこれを内部的に利用しています。 +* 💡 Bolt for JavaScript は [カスタムのレシーバー](/concepts/receiver)での OAuth をサポートしていません。カスタムのレシーバーで OAuth フローを実装したい場合は、私たちが提供している [OAuth ライブラリ](https://tools.slack.dev/node-slack-sdk/oauth#slack-oauth) を使うことができます。Bolt for JavaScript の組み込みのモジュールもこれを内部的に利用しています。 ##### Redirect URI diff --git a/docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/basic/web-api.md b/docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/basic/web-api.md index 679568570..a5578871f 100644 --- a/docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/basic/web-api.md +++ b/docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/basic/web-api.md @@ -4,11 +4,11 @@ lang: ja-jp slug: /concepts/web-api --- -[Web API メソッド](https://api.slack.com/methods)を呼び出すには、リスナー関数の引数に `client` として提供されている [`WebClient`](https://slack.dev/node-slack-sdk/web-api) を使用します。このインスタンスが使用するトークンは、Bolt アプリの初期化時に指定されたもの もしくは Slack からのリクエストに対して [`authorize` 関数](/concepts/authorization)から返されたものが設定されます。組み込みの [OAuth サポート](/concepts/authenticating-oauth)は、この後者のケースをデフォルトでハンドリングします。 +[Web API メソッド](https://api.slack.com/methods)を呼び出すには、リスナー関数の引数に `client` として提供されている [`WebClient`](https://tools.slack.dev/node-slack-sdk/web-api) を使用します。このインスタンスが使用するトークンは、Bolt アプリの初期化時に指定されたもの もしくは Slack からのリクエストに対して [`authorize` 関数](/concepts/authorization)から返されたものが設定されます。組み込みの [OAuth サポート](/concepts/authenticating-oauth)は、この後者のケースをデフォルトでハンドリングします。 Bolt アプリケーションは、トップレベルに `app.client` も持っています。このインスタンスには、トークンをメソッド呼び出しのパラメーターとして都度指定します。Slack からのリクエストが authorize されないユースケースや、リスナー関数の外で Web API を呼び出したい場合は、このトップレベルの `app.client` を使用します。 -トップレベルのクライアントを使ってもリスナー関数でのクライアントを使っても、[`WebClient`](https://slack.dev/node-slack-sdk/web-api) が提供するメソッドを呼び出すと、それへの Slack からのレスポンスを含む Promise の値が返されます。 +トップレベルのクライアントを使ってもリスナー関数でのクライアントを使っても、[`WebClient`](https://tools.slack.dev/node-slack-sdk/web-api) が提供するメソッドを呼び出すと、それへの Slack からのレスポンスを含む Promise の値が返されます。 [OrG 全体へのインストール機能](https://api.slack.com/enterprise/apps)の導入により、[いくつかの Web API](https://api.slack.com/enterprise/apps/changes-apis#methods) は、動作しているワークスペースを伝えるために `team_id` パラメーターを必要とします。Bolt for JavaScript は、この `team_id` を Slack から受け取ったペイロードを元に判定し、`client` インスタンスに設定します。これは、既存のアプリケーションにとっても OrG 全体へのインストールに対応する上で有用です。既存の Web API 呼び出しの処理をアップデートする必要はありません。 diff --git a/docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/deployments/aws-lambda.md b/docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/deployments/aws-lambda.md index e316d4f93..743589da5 100644 --- a/docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/deployments/aws-lambda.md +++ b/docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/deployments/aws-lambda.md @@ -246,7 +246,7 @@ ngrok http 3000 :::tip -パブリック URL の作成方法と、ローカルマシンへのリクエストの転送方法については、[ngrok の使い方](https://slack.dev/bolt-js/getting-started#setting-up-events)を参照してください。 +パブリック URL の作成方法と、ローカルマシンへのリクエストの転送方法については、[ngrok の使い方](https://tools.slack.dev/bolt-js/getting-started#setting-up-events)を参照してください。 ::: diff --git a/docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/reference.md b/docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/reference.md index 482f27e53..175c11311 100644 --- a/docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/reference.md +++ b/docs/i18n/ja-jp/docusaurus-plugin-content-docs/current/reference.md @@ -103,7 +103,7 @@ App オプションは、`App` のコンストラクターに渡します。`rec | オプション | 説明 | | :--- | :--- | | `receiver` | `Receiver` のインスタンス。受信イベントのパースとその処理を行います。[`Receiver` インターフェイス](/concepts/receiver)に準拠して、`init(app)`、`start()`、`stop()`を持つ必要があります。receiver について詳しくは、[ドキュメント](/concepts/receiver)を参照してください。 | -| `agent` | オプションの HTTP `エージェント`。プロキシのサポートを設定する場合に使用します。カスタムの agent について詳しくは、[Node Slack SDK のドキュメント](https://slack.dev/node-slack-sdk/web-api#proxy-requests-with-a-custom-agent)を参照してください。 | +| `agent` | オプションの HTTP `エージェント`。プロキシのサポートを設定する場合に使用します。カスタムの agent について詳しくは、[Node Slack SDK のドキュメント](https://tools.slack.dev/node-slack-sdk/web-api#proxy-requests-with-a-custom-agent)を参照してください。 | | `clientTls` | 設定必須ではない文字列。HTTP クライアントリクエストにカスタムの TLS を設定する場合に指定します。`"pfx"`、`"key"`、`"passphrase"`、`"cert"`、`"ca"` のいずれかを指定します。 | | `convoStore` | ステートに関連する会話のデータを設定・取得するためのデータストア実装。`set()` で会話のステートを設定し、`get()` で取得します。デフォルトでは、アプリはインメモリのストアを利用できます。詳細とサンプルについては、[ドキュメント](/concepts/conversation-store)を参照してください。 | | `token` | アプリの設定（「Settings」>「Install App」）で指定した 文字列。Web API の呼び出しに必要です。`authorize`、`orgAuthorize`やOAuth 設定を使用する場合には指定しないでください。 | @@ -120,7 +120,7 @@ App オプションは、`App` のコンストラクターに渡します。`rec | `deferInitialization` | アプリの初期化を遅延させる真偽値です。有効にすると非同期の `App#init()` メソッドを手動で呼び出す必要があります。 また `init()` メソッドは `App#start()` を実行する前に呼び出さなければなりません。 デフォルトは `false` です。 | | `signatureVerification` | Boltが着信リクエストでSlackの署名を検証する必要があるかどうかを決定するブール値。 デフォルトは`true`です。 | -> Bolt のclientは [Node Slack SDK](https://slack.dev/node-slack-sdk) の `WebClient` のインスタンスです。そのため、Node Slack SDK のドキュメントも合わせて参照すると、開発時の理解に役立つでしょう。 +> Bolt のclientは [Node Slack SDK](https://tools.slack.dev/node-slack-sdk) の `WebClient` のインスタンスです。そのため、Node Slack SDK のドキュメントも合わせて参照すると、開発時の理解に役立つでしょう。 ## フレームワークのエラー {#framework-error-types} @@ -140,11 +140,11 @@ Bolt では、さまざまなエラーが定義されています。これらに > [errors.ts](https://github.com/slackapi/bolt-js/blob/main/src/errors.ts) のコードで、エラー定義の部分とコンストラクターの部分を読み、参考にしてみてください。 ### クライアント側のエラー {#client-errors} -Bolt では、Slack API の呼び出しのため `WebClient` をインポートしています。クライアントで API 呼び出しを行う際に目にすると思われるエラーを以下に示します。より詳しい内容は、[Web API のドキュメント](https://slack.dev/node-slack-sdk/web-api#handle-errors)を参照してください。クライアントのエラーをハンドリングする際、`data` プロパティの `body` で詳しい情報を確認できます。 +Bolt では、Slack API の呼び出しのため `WebClient` をインポートしています。クライアントで API 呼び出しを行う際に目にすると思われるエラーを以下に示します。より詳しい内容は、[Web API のドキュメント](https://tools.slack.dev/node-slack-sdk/web-api#handle-errors)を参照してください。クライアントのエラーをハンドリングする際、`data` プロパティの `body` で詳しい情報を確認できます。 | エラーコード | 詳細 | | :--- | :--- | | `PlatformError` | Slack API の呼び出し中に何らかの異常が発生したことを示すエラー。`data` プロパティを持ちます。 | | `RequestError` | リクエストが送信できなかったことを示すエラー。ネットワーク接続が利用できないことなどが原因として考えられます。`original` プロパティで詳細を確認できます。 | -| `RateLimitedError` | 短時間で送信したリクエストが多すぎることを示すエラー。`retryAfter` プロパティで、再送信まで待機する必要のある秒数を確認できます。`WebClient` は、デフォルトでレート制限エラーのハンドリングを行います。[詳しくはドキュメントを参照してください](https://slack.dev/node-slack-sdk/web-api#rate-limits)。 | +| `RateLimitedError` | 短時間で送信したリクエストが多すぎることを示すエラー。`retryAfter` プロパティで、再送信まで待機する必要のある秒数を確認できます。`WebClient` は、デフォルトでレート制限エラーのハンドリングを行います。[詳しくはドキュメントを参照してください](https://tools.slack.dev/node-slack-sdk/web-api#rate-limits)。 | | `HTTPError` | HTTP レスポンスに通常は想定されないステータスコードが設定されていたことを示すエラー。Web API が返す HTTP ステータスコードは、通常 `200`（エラー時を含む）または `429`（レート制限時）のみです。 | \ No newline at end of file