This is an automated email from the ASF dual-hosted git repository. orpiske pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/camel.git
commit 96644db709345d0e2773e456ebb6e3082cffd556 Author: Otavio Rodolfo Piske <[email protected]> AuthorDate: Wed Feb 21 17:57:31 2024 +0100 CAMEL-20410: documentation fixes for camel-slack - Fixed samples - Fixed grammar and typos - Fixed punctuation - Added and/or fixed links - Converted to use tabs --- .../camel-slack/src/main/docs/slack-component.adoc | 30 ++++++++++++---------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/components/camel-slack/src/main/docs/slack-component.adoc b/components/camel-slack/src/main/docs/slack-component.adoc index 127e24b5ef8..cd122e1aca7 100644 --- a/components/camel-slack/src/main/docs/slack-component.adoc +++ b/components/camel-slack/src/main/docs/slack-component.adoc @@ -17,9 +17,8 @@ The Slack component allows you to connect to an instance of http://www.slack.com/[Slack] and to send and receive the messages. -To send a message contained in the message body a pre -established https://api.slack.com/incoming-webhooks[Slack incoming -webhook] must be configured in Slack. +To send a message contained in the message body, a pre-established +https://api.slack.com/incoming-webhooks[Slack incoming webhook] must be configured in Slack. Maven users will need to add the following dependency to their `pom.xml` for this component: @@ -42,7 +41,7 @@ To send a message to a channel. slack:#channel[?options] ------------------------ -To send a direct message to a slack user. +To send a direct message to a Slack user. ------------------------- slack:@userID[?options] @@ -78,7 +77,7 @@ parameter. </bean> ----------------------------------------------------------------------------------------------------------------------- -For Java you can configure this using Java code. +For Java, you can configure this using Java code. == Example @@ -131,19 +130,19 @@ You can now use the Slack API model to create blocks. You can read more about it } --------------------------------------------------------------------------------------------------------------------------- -You'll need to create a Slack app and use it on your workspace. +You'll need to create a Slack app and use it in your workspace. For token usage, set the 'OAuth Token'. IMPORTANT: Add the corresponding (`channels:history`, `chat:write`) user token scopes to your app to grant it permission to write messages in the corresponding channel. You'll also need to invite the Bot or User to the corresponding channel. -For Bot tokens you'll need the following permissions: +For Bot tokens, you'll need the following permissions: - channels:history - chat:write -For User tokens you'll need the following permissions: +For User tokens, you'll need the following permissions: - channels:history - chat:write @@ -158,7 +157,9 @@ from("slack://general?token=RAW(<YOUR_TOKEN>)&maxResults=1") .to("mock:result"); --------------------------------------------------------------------------------------------------------------------------- -This way you'll get the last message from `general` channel. The consumer will track the timestamp of the last message consumed and in the next poll it will consume only newer messages in the channel. +This way you'll get the last message from `general` channel. +The consumer will track the timestamp of the last message consumed, +and in the next poll it will consume only newer messages in the channel. You'll need to create a Slack app and use it in your workspace. @@ -168,7 +169,7 @@ IMPORTANT: Add the corresponding history (`channels:history`, `groups:history`, read (`channels:read`, `groups:read`, `mpim:read` and `im:read`) user token scope to your app to grant it permission to view messages in the corresponding channel. -For Bot tokens you'll need the following permissions: +For Bot tokens, you'll need the following permissions: - channels:history - groups:history @@ -179,7 +180,7 @@ For Bot tokens you'll need the following permissions: - im:read - mpim:read -For User tokens you'll need the following permissions: +For User tokens, you'll need the following permissions: - channels:history - groups:history @@ -190,9 +191,10 @@ For User tokens you'll need the following permissions: - im:read - mpim:read -The naturalOrder option allows consuming messages from the oldest to the newest. -Originally you would get the newest first and consume backward (message 3 => message 2 => message 1) +The `naturalOrder` option allows consuming messages from the oldest to the newest. +Originally, you would get the newest first and consume backward (`message 3 -> message 2 -> message 1`) -IMPORTANT: The channel / conversation doesn't need to be public to read the history and messages. Use the `conversationType` option to specify the type of the conversation (PUBLIC_CHANNEL,PRIVATE_CHANNEL, MPIM, IM). +IMPORTANT: The channel / conversation doesn't need to be public to read the history and messages. +Use the `conversationType` option to specify the type of the conversation (`PUBLIC_CHANNEL`,`PRIVATE_CHANNEL`, `MPIM`, `IM`). include::spring-boot:partial$starter.adoc[]
