Module: Slack::Endpoint::Chat

Included in:
Slack::Endpoint
Defined in:
lib/slack/endpoint/chat.rb

Instance Method Summary collapse

Instance Method Details

#chat_delete(options = {}) ⇒ Object

Deletes a message.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (Object)

    Channel containing the message to be deleted.

  • :ts (Object)

    Timestamp of the message to be deleted.

  • :as_user (Object)

    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.

See Also:


18
19
20
21
22
# File 'lib/slack/endpoint/chat.rb', line 18

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

Retrieve a permalink URL for a specific extant message

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (Object)

    The ID of the conversation or channel containing the message

  • :message_ts (Object)

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

See Also:


34
35
36
37
38
# File 'lib/slack/endpoint/chat.rb', line 34

def chat_getPermalink(options={})
  throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
  throw ArgumentError.new("Required arguments :message_ts missing") if options[:message_ts].nil?
  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 (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:


50
51
52
53
54
# File 'lib/slack/endpoint/chat.rb', line 50

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_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 (Object)

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

  • :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.

  • :user (Object)

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

  • :as_user (Object)

    Pass true to post the message as the authed bot. Defaults to false.

  • :attachments (Object)

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

  • :link_names (Object)

    Find and link channel names and usernames.

  • :parse (Object)

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

See Also:


76
77
78
79
80
81
82
# File 'lib/slack/endpoint/chat.rb', line 76

def chat_postEphemeral(options={})
  throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
  throw ArgumentError.new("Required arguments :text missing") if options[:text].nil?
  throw ArgumentError.new("Required arguments :user missing") if options[:user].nil?
  options[:attachments] = options[:attachments].to_json if options[:attachments].is_a?(Array) || options[:attachments].is_a?(Hash)
  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 (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.

  • :as_user (Object)

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

  • :attachments (Object)

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

  • :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.

  • :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.

  • :link_names (Object)

    Find and link channel names and usernames.

  • :parse (Object)

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

  • :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.

  • :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.

  • :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.

See Also:


116
117
118
119
120
121
# File 'lib/slack/endpoint/chat.rb', line 116

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

Provide custom unfurl behavior for user-posted URLs

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)

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

  • :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

  • :user_auth_required (Object)

    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.

See Also:


141
142
143
144
145
146
# File 'lib/slack/endpoint/chat.rb', line 141

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

Updates a message.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (Object)

    Channel containing the message to be updated.

  • :text (Object)

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

  • :ts (Object)

    Timestamp of the message to be updated.

  • :as_user (Object)

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

  • :attachments (Object)

    A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text.

  • :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.

  • :parse (Object)

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

See Also:


168
169
170
171
172
173
174
# File 'lib/slack/endpoint/chat.rb', line 168

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