Module: Slack::Web::Api::Endpoints::Chat

Included in:
Slack::Web::Api::Endpoints
Defined in:
lib/slack/web/api/endpoints/chat.rb

Instance Method Summary collapse

Instance Method Details

#chat_command(options = {}) ⇒ Object

Execute a slash command in a public channel (undocumented)

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    Channel to execute the command in.

  • :command (Object) —

    Slash command to be executed. Leading backslash is required.

  • :text (Object) —

    Additional parameters provided to the slash command.

Raises:

  • (ArgumentError)

See Also:



19
20
21
22
23
24
25
 
# File 'lib/slack/web/api/endpoints/chat.rb', line 19

def chat_command(options = {})
  raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
  raise ArgumentError, 'Required arguments :command missing' if options[:command].nil?
  options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
  logger.warn('The chat.command method is undocumented.')
  post('chat.command', options)
end

#chat_delete(options = {}) ⇒ Object

Deletes a message.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    Channel containing the message to be deleted.

  • :ts (timestamp) —

    Timestamp of the message to be deleted.

  • :as_user (boolean) —

    Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.

Raises:

  • (ArgumentError)

See Also:



38
39
40
41
42
43
 
# File 'lib/slack/web/api/endpoints/chat.rb', line 38

def chat_delete(options = {})
  raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
  raise ArgumentError, 'Required arguments :ts missing' if options[:ts].nil?
  options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
  post('chat.delete', options)
end

#chat_deleteScheduledMessage(options = {}) ⇒ Object

Deletes a pending scheduled message from the queue.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    The channel the scheduled_message is posting to.

  • :scheduled_message_id (string) —

    scheduled_message_id returned from call to chat.scheduleMessage.

  • :as_user (boolean) —

    Pass true to delete the message as the authed user with chat:write:user scope. Bot users in this context are considered authed users. If unused or false, the message will be deleted with chat:write:bot scope.

Raises:

  • (ArgumentError)

See Also:



56
57
58
59
60
61
 
# File 'lib/slack/web/api/endpoints/chat.rb', line 56

def chat_deleteScheduledMessage(options = {})
  raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
  raise ArgumentError, 'Required arguments :scheduled_message_id missing' if options[:scheduled_message_id].nil?
  options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
  post('chat.deleteScheduledMessage', options)
end

#chat_getPermalink(options = {}) ⇒ Object

Retrieve a permalink URL for a specific extant message

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    The ID of the conversation or channel containing the message.

  • :message_ts (string) —

    A message’s ts value, uniquely identifying it within a channel.

Raises:

  • (ArgumentError)

See Also:



72
73
74
75
76
77
 
# File 'lib/slack/web/api/endpoints/chat.rb', line 72

def chat_getPermalink(options = {})
  raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
  raise ArgumentError, 'Required arguments :message_ts missing' if options[:message_ts].nil?
  options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
  post('chat.getPermalink', options)
end

#chat_meMessage(options = {}) ⇒ Object

Share a me message into a channel.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.

  • :text (string) —

    Text of the message to send.

Raises:

  • (ArgumentError)

See Also:



88
89
90
91
92
 
# File 'lib/slack/web/api/endpoints/chat.rb', line 88

def chat_meMessage(options = {})
  raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
  raise ArgumentError, 'Required arguments :text missing' if options[:text].nil?
  post('chat.meMessage', options)
end

#chat_postEphemeral(options = {}) ⇒ Object

Sends an ephemeral message to a user in a channel.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.

  • :text (string) —

    How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.

  • :user (user) —

    id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.

  • :as_user (boolean) —

    Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.

  • :attachments (string) —

    A JSON-based array of structured attachments, presented as a URL-encoded string.

  • :blocks (blocks[] as string) —

    A JSON-based array of structured blocks, presented as a URL-encoded string.

  • :icon_emoji (string) —

    Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

  • :icon_url (string) —

    URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

  • :link_names (boolean) —

    Find and link channel names and usernames.

  • :parse (string) —

    Change how messages are treated. Defaults to none. See below.

  • :thread_ts (string) —

    Provide another message’s ts value to post this message in a thread. Avoid using a reply’s ts value; use its parent’s value instead. Ephemeral messages in threads are only shown if there is already an active thread.

  • :username (string) —

    Set your bot’s user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

Raises:

  • (ArgumentError)

See Also:



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/slack/web/api/endpoints/chat.rb', line 123

def chat_postEphemeral(options = {})
  raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
  raise ArgumentError, 'Required arguments :text, :attachments or :blocks missing' if options[:text].nil? && options[:attachments].nil? && options[:blocks].nil?
  raise ArgumentError, 'Required arguments :user missing' if options[:user].nil?
  options = options.merge(user: users_id(options)['user']['id']) if options[:user]
  # attachments must be passed as an encoded JSON string
  if options.key?(:attachments)
    attachments = options[:attachments]
    attachments = JSON.dump(attachments) unless attachments.is_a?(String)
    options = options.merge(attachments: attachments)
  end
  # blocks must be passed as an encoded JSON string
  if options.key?(:blocks)
    blocks = options[:blocks]
    blocks = JSON.dump(blocks) unless blocks.is_a?(String)
    options = options.merge(blocks: blocks)
  end
  post('chat.postEphemeral', options)
end

#chat_postMessage(options = {}) ⇒ Object

Sends a message to a channel.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.

  • :attachments (string) —

    A JSON-based array of structured attachments, presented as a URL-encoded string.

  • :blocks (blocks[] as string) —

    A JSON-based array of structured blocks, presented as a URL-encoded string.

  • :text (string) —

    The formatted text of the message to be published. If blocks are included, this will become the fallback text used in notifications.

  • :as_user (boolean) —

    Set to true to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps. See authorship below.

  • :icon_emoji (string) —

    Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

  • :icon_url (string) —

    URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

  • :link_names (boolean) —

    Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.

  • :metadata (string) —

    JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.

  • :mrkdwn (boolean) —

    Disable Slack markup parsing by setting to false. Enabled by default.

  • :parse (string) —

    Change how messages are treated. See below.

  • :reply_broadcast (boolean) —

    Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.

  • :thread_ts (string) —

    Provide another message’s ts value to make this message a reply. Avoid using a reply’s ts value; use its parent instead.

  • :unfurl_links (boolean) —

    Pass true to enable unfurling of primarily text-based content.

  • :unfurl_media (boolean) —

    Pass false to disable unfurling of media content.

  • :username (string) —

    Set your bot’s user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

Raises:

  • (ArgumentError)

See Also:



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/slack/web/api/endpoints/chat.rb', line 180

def chat_postMessage(options = {})
  raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
  raise ArgumentError, 'Required arguments :text, :attachments or :blocks missing' if options[:text].nil? && options[:attachments].nil? && options[:blocks].nil?
  # attachments must be passed as an encoded JSON string
  if options.key?(:attachments)
    attachments = options[:attachments]
    attachments = JSON.dump(attachments) unless attachments.is_a?(String)
    options = options.merge(attachments: attachments)
  end
  # blocks must be passed as an encoded JSON string
  if options.key?(:blocks)
    blocks = options[:blocks]
    blocks = JSON.dump(blocks) unless blocks.is_a?(String)
    options = options.merge(blocks: blocks)
  end
  post('chat.postMessage', options)
end

#chat_scheduleMessage(options = {}) ⇒ Object

Schedules a message to be sent to a channel.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    Channel, private group, or DM channel to send message to. Can be an encoded ID, or a name. See below for more details.

  • :post_at (integer) —

    Unix EPOCH timestamp of time in future to send the message.

  • :text (string) —

    How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.

  • :as_user (boolean) —

    Set to true to post the message as the authed user, instead of as a bot. Defaults to false. Cannot be used by new Slack apps. See chat.postMessage.

  • :attachments (string) —

    A JSON-based array of structured attachments, presented as a URL-encoded string.

  • :blocks (blocks[] as string) —

    A JSON-based array of structured blocks, presented as a URL-encoded string.

  • :link_names (boolean) —

    Find and link user groups. No longer supports linking individual users; use syntax shown in Mentioning Users instead.

  • :metadata (string) —

    JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.

  • :parse (string) —

    Change how messages are treated. See chat.postMessage.

  • :reply_broadcast (boolean) —

    Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.

  • :thread_ts (string) —

    Provide another message’s ts value to make this message a reply. Avoid using a reply’s ts value; use its parent instead.

  • :unfurl_links (boolean) —

    Pass true to enable unfurling of primarily text-based content.

  • :unfurl_media (boolean) —

    Pass false to disable unfurling of media content.

Raises:

  • (ArgumentError)

See Also:



229
230
231
232
233
234
 
# File 'lib/slack/web/api/endpoints/chat.rb', line 229

def chat_scheduleMessage(options = {})
  raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
  raise ArgumentError, 'Required arguments :post_at missing' if options[:post_at].nil?
  raise ArgumentError, 'Required arguments :text missing' if options[:text].nil?
  post('chat.scheduleMessage', options)
end

#chat_unfurl(options = {}) ⇒ Object

Provide custom unfurl behavior for user-posted URLs

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    Channel ID of the message. Both channel and ts must be provided together, or unfurl_id and source must be provided together.

  • :ts (timestamp) —

    Timestamp of the message to add unfurl behavior to.

  • :unfurls (string) —

    URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl blocks or message attachments.

  • :source (string) —

    The source of the link to unfurl. The source may either be composer, when the link is inside the message composer, or conversations_history, when the link has been posted to a conversation.

  • :unfurl_id (string) —

    The ID of the link to unfurl. Both unfurl_id and source must be provided together, or channel and ts must be provided together.

  • :user_auth_blocks (Object) —

    Provide a JSON based array of structured blocks presented as URL-encoded string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior.

  • :user_auth_message (Object) —

    Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior. Provides two buttons, Not now or Never ask me again.

  • :user_auth_required (boolean) —

    Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain.

  • :user_auth_url (Object) —

    Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.

Raises:

  • (ArgumentError)

See Also:



259
260
261
262
263
264
265
 
# File 'lib/slack/web/api/endpoints/chat.rb', line 259

def chat_unfurl(options = {})
  raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
  raise ArgumentError, 'Required arguments :ts missing' if options[:ts].nil?
  raise ArgumentError, 'Required arguments :unfurls missing' if options[:unfurls].nil?
  options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
  post('chat.unfurl', options)
end

#chat_update(options = {}) ⇒ Object

Updates a message.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    Channel containing the message to be updated.

  • :ts (timestamp) —

    Timestamp of the message to be updated.

  • :as_user (boolean) —

    Pass true to update the message as the authed user. Bot users in this context are considered authed users.

  • :attachments (string) —

    A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text. If you don’t include this field, the message’s previous attachments will be retained. To remove previous attachments, include an empty array for this field.

  • :blocks (blocks[] as string) —

    A JSON-based array of structured blocks, presented as a URL-encoded string. If you don’t include this field, the message’s previous blocks will be retained. To remove previous blocks, include an empty array for this field.

  • :file_ids (array) —

    Array of new file ids that will be sent with this message.

  • :link_names (boolean) —

    Find and link channel names and usernames. Defaults to none. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, none.

  • :metadata (string) —

    JSON object with event_type and event_payload fields, presented as a URL-encoded string. If you don’t include this field, the message’s previous metadata will be retained. To remove previous metadata, include an empty object for this field. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.

  • :parse (string) —

    Change how messages are treated. Defaults to client, unlike chat.postMessage. Accepts either none or full. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, client.

  • :reply_broadcast (boolean) —

    Broadcast an existing thread reply to make it visible to everyone in the channel or conversation.

  • :text (string) —

    New text for the message, using the default formatting rules. It’s not required when presenting blocks or attachments.

Raises:

  • (ArgumentError)

See Also:



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/slack/web/api/endpoints/chat.rb', line 294

def chat_update(options = {})
  raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
  raise ArgumentError, 'Required arguments :text, :attachments, :blocks or :reply_broadcast missing' if options[:text].nil? && options[:attachments].nil? && options[:blocks].nil? && options[:reply_broadcast].nil?
  raise ArgumentError, 'Required arguments :ts missing' if options[:ts].nil?
  options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel]
  # attachments must be passed as an encoded JSON string
  if options.key?(:attachments)
    attachments = options[:attachments]
    attachments = JSON.dump(attachments) unless attachments.is_a?(String)
    options = options.merge(attachments: attachments)
  end
  # blocks must be passed as an encoded JSON string
  if options.key?(:blocks)
    blocks = options[:blocks]
    blocks = JSON.dump(blocks) unless blocks.is_a?(String)
    options = options.merge(blocks: blocks)
  end
  post('chat.update', options)
end