Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a note concerning replying in a thread #168

Closed
wants to merge 4 commits into from
Closed

Add a note concerning replying in a thread #168

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9dd0cf0
Add a note concerning replying in a thread
Startouf Oct 18, 2017
c7f63b2
Add a section title for threaded messaging.
Startouf Oct 20, 2017
06cf052
Update documentation regarding thread_ts and ts
Startouf Dec 2, 2017
92be8dc
Restore contributions line
Startouf Dec 2, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,23 @@ end

Operator match data includes `match['operator']` and `match['expression']`. The `bot` match always checks against the `SlackRubyBot::Config.user` setting.

### Threaded Messages

You can reply to a message in a thread (or keep sending to the current thread) :
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should have it's own section, like ### Threaded Messages

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick: why a space before :?


```ruby
command 'reply in thread' do |client, data, match|
client.say(
channel: data.channel,
text: "let's avoid spamming everyone, I will tell you what you need in this thread",
thread_ts: data.thread_ts || data.ts
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a comment to what these are? Maybe a link to docs?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello sorry for the long wait. I'm a French guy so sometimes I forget there is no space before semicolons in english ^^"

I have included extra information and links regarding thread_ts and ts.

Sorry for stalling this PR for so long

)
end
```
Note that using only `thread_ts: data.ts` can cause some permanent issues where Slack will keep reporting inaccessible messages as unread. As recommended by the slack documentation, the replies to a thread should always be sent to message `ts` that started the thread, available as `thread_ts` for subsequent messages. Hence `data.thread_ts || data.ts`.

For additional options including broadcasting, refer to [slack-ruby-client#chat_postMessage](https://github.com/slack-ruby/slack-ruby-client/blob/41539c647ac877400f20aa338aa42d2ebfd2866b/lib/slack/web/api/endpoints/chat.rb#L105)

### Bot Aliases

A bot will always respond to its name (eg. `rubybot`) and Slack ID (eg. `@rubybot`), but you can specify multiple aliases via the `SLACK_RUBY_BOT_ALIASES` environment variable or via an explicit configuration.
Expand Down