Module: Slack::Web::Api::Endpoints::Reactions

Included in:

Slack::Web::Api::Endpoints

Defined in:

lib/slack/web/api/endpoints/reactions.rb

Instance Method Summary

• #reactions_add(options = {}) ⇒ Object

  This method adds a reaction (emoji) to an item (file, file comment, channel message, group message, or direct message).

• #reactions_get(options = {}) ⇒ Object

  This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message).

• #reactions_list(options = {}) ⇒ Object

  This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user.

• #reactions_remove(options = {}) ⇒ Object

  This method removes a reaction (emoji) from an item (file, file comment, channel message, group message, or direct message).

Instance Method Details

#reactions_add(options = {}) ⇒ Object

This method adds a reaction (emoji) to an item (file, file comment, channel message, group message, or direct message). One of file, file_comment, or the combination of channel and timestamp must be specified.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :name (Object) —

  Reaction (emoji) name.

• :file (file) —

  File to add reaction to.

• :file_comment (Object) —

  File comment to add reaction to.

• :channel (channel) —

  Channel where the message to add reaction to was posted.

• :timestamp (Object) —

  Timestamp of the message to add reaction to.

See Also:

• https://api.slack.com/methods/reactions.add
• https://github.com/dblock/slack-api-ref/blob/master/methods/reactions/reactions.add.json

# File 'lib/slack/web/api/endpoints/reactions.rb', line 24

def reactions_add(options = {})
  throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('reactions.add', options)
end

#reactions_get(options = {}) ⇒ Object

This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message).

Parameters:

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

  a customizable set of options

Options Hash (options):

• :file (file) —

  File to get reactions for.

• :file_comment (Object) —

  File comment to get reactions for.

• :channel (channel) —

  Channel where the message to get reactions for was posted.

• :timestamp (Object) —

  Timestamp of the message to get reactions for.

• :full (Object) —

  If true always return the complete reaction list.

See Also:

• https://api.slack.com/methods/reactions.get
• https://github.com/dblock/slack-api-ref/blob/master/methods/reactions/reactions.get.json

# File 'lib/slack/web/api/endpoints/reactions.rb', line 45

def reactions_get(options = {})
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('reactions.get', options)
end

#reactions_list(options = {}) ⇒ Object

This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :user (user) —

  Show reactions made by this user. Defaults to the authed user.

• :full (Object) —

  If true always return the complete reaction list.

See Also:

• https://api.slack.com/methods/reactions.list
• https://github.com/dblock/slack-api-ref/blob/master/methods/reactions/reactions.list.json

# File 'lib/slack/web/api/endpoints/reactions.rb', line 59

def reactions_list(options = {})
  options = options.merge(user: users_id(options)['user']['id']) if options[:user]
  post('reactions.list', options)
end

#reactions_remove(options = {}) ⇒ Object

This method removes a reaction (emoji) from an item (file, file comment, channel message, group message, or direct message). One of file, file_comment, or the combination of channel and timestamp must be specified.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :name (Object) —

  Reaction (emoji) name.

• :file (file) —

  File to remove reaction from.

• :file_comment (Object) —

  File comment to remove reaction from.

• :channel (channel) —

  Channel where the message to remove reaction from was posted.

• :timestamp (Object) —

  Timestamp of the message to remove reaction from.

See Also:

• https://api.slack.com/methods/reactions.remove
• https://github.com/dblock/slack-api-ref/blob/master/methods/reactions/reactions.remove.json

# File 'lib/slack/web/api/endpoints/reactions.rb', line 80

def reactions_remove(options = {})
  throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('reactions.remove', options)
end