Module: Slack::Endpoint::Chat

Included in:

Slack::Endpoint

Defined in:

lib/slack/endpoint/chat.rb

Instance Method Summary

• #chat_delete(options = {}) ⇒ Object

  This method deletes a message from a channel.

• #chat_meMessage(options = {}) ⇒ Object

  This method sends a me message to a channel from the calling user.

• #chat_postMessage(options = {}) ⇒ Object

  This method posts a message to a public channel, private channel, or direct message/IM channel.

• #chat_unfurl(options = {}) ⇒ Object

  This method attaches Slack app unfurl behavior to a specified and relevant message.

• #chat_update(options = {}) ⇒ Object

  This method updates a message in a channel.

Instance Method Details

#chat_delete(options = {}) ⇒ Object

This method deletes a message from a channel.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :ts (Object) —

  Timestamp of the message to be deleted.

• :channel (Object) —

  Channel containing the message to be deleted.

• :as_user (Object) —

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

See Also:

• https://api.slack.com/methods/chat.delete
• https://github.com/aki017/slack-api-docs/blob/master/methods/chat.delete.md
• https://github.com/aki017/slack-api-docs/blob/master/methods/chat.delete.json

# File 'lib/slack/endpoint/chat.rb', line 18

def chat_delete(options={})
  throw ArgumentError.new("Required arguments :ts missing") if options[:ts].nil?
  throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
  post("chat.delete", options)
end

#chat_meMessage(options = {}) ⇒ Object

This method sends a me message to a channel from the calling user.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (Object) —

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

• :text (Object) —

  Text of the message to send.

See Also:

• https://api.slack.com/methods/chat.meMessage
• https://github.com/aki017/slack-api-docs/blob/master/methods/chat.meMessage.md
• https://github.com/aki017/slack-api-docs/blob/master/methods/chat.meMessage.json

# File 'lib/slack/endpoint/chat.rb', line 34

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

#chat_postMessage(options = {}) ⇒ Object

This method posts a message to a public channel, private channel, or direct message/IM channel.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (Object) —

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

• :text (Object) —

  Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you’re providing only attachments instead.

• :parse (Object) —

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

• :link_names (Object) —

  Find and link channel names and usernames.

• :attachments (Object) —

  Structured message attachments.

• :unfurl_links (Object) —

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

• :unfurl_media (Object) —

  Pass false to disable unfurling of media content.

• :username (Object) —

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

• :as_user (Object) —

  Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.

• :icon_url (Object) —

  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.

• :icon_emoji (Object) —

  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.

• :thread_ts (Object) —

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

• :reply_broadcast (Object) —

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

See Also:

• https://api.slack.com/methods/chat.postMessage
• https://github.com/aki017/slack-api-docs/blob/master/methods/chat.postMessage.md
• https://github.com/aki017/slack-api-docs/blob/master/methods/chat.postMessage.json

# File 'lib/slack/endpoint/chat.rb', line 72

def chat_postMessage(options={})
  throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
  throw ArgumentError.new("Required arguments :text or :attachments missing") if options[:text].nil? && options[:attachments].nil?
  options[:attachments] = options[:attachments].to_json if options[:attachments].is_a?(Array) || options[:attachments].is_a?(Hash)
  post("chat.postMessage", options)
end

#chat_unfurl(options = {}) ⇒ Object

This method attaches Slack app unfurl behavior to a specified and relevant message. A user token is required as this method does not support bot user tokens.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (Object) —

  Channel ID of the message

• :ts (Object) —

  Timestamp of the message to add unfurl behavior to

• :unfurls (Object) —

  JSON mapping a set of URLs from the message to their unfurl attachments

• :user_auth_required (Object) —

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

See Also:

• https://api.slack.com/methods/chat.unfurl
• https://github.com/aki017/slack-api-docs/blob/master/methods/chat.unfurl.md
• https://github.com/aki017/slack-api-docs/blob/master/methods/chat.unfurl.json

# File 'lib/slack/endpoint/chat.rb', line 93

def chat_unfurl(options={})
  throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
  throw ArgumentError.new("Required arguments :ts missing") if options[:ts].nil?
  throw ArgumentError.new("Required arguments :unfurls missing") if options[:unfurls].nil?
  post("chat.unfurl", options)
end

#chat_update(options = {}) ⇒ Object

This method updates a message in a channel. Though related to chat.postMessage, some parameters of chat.update are handled differently.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :ts (Object) —

  Timestamp of the message to be updated.

• :channel (Object) —

  Channel containing the message to be updated.

• :text (Object) —

  New text for the message, using the default formatting rules.

• :attachments (Object) —

  Structured message attachments.

• :parse (Object) —

  Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.

• :link_names (Object) —

  Find and link channel names and usernames. Defaults to none. This parameter should be used in conjunction with parse. To set link_names to 1, specify a parse mode of full.

• :as_user (Object) —

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

See Also:

• https://api.slack.com/methods/chat.update
• https://github.com/aki017/slack-api-docs/blob/master/methods/chat.update.md
• https://github.com/aki017/slack-api-docs/blob/master/methods/chat.update.json

# File 'lib/slack/endpoint/chat.rb', line 120

def chat_update(options={})
  throw ArgumentError.new("Required arguments :ts missing") if options[:ts].nil?
  throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
  throw ArgumentError.new("Required arguments :text missing") if options[:text].nil?
  options[:attachments] = options[:attachments].to_json if options[:attachments].is_a?(Array) || options[:attachments].is_a?(Hash)
  post("chat.update", options)
end