module Slack::Web::Api::Endpoints::Reactions
Public Instance Methods
Adds a reaction to an item.
@option options [channel] :channel
Channel where the message to add reaction to was posted.
@option options [Object] :name
Reaction (emoji) name.
@option options [Object] :timestamp
Timestamp of the message to add reaction to.
@see api.slack.com/methods/reactions.add @see github.com/slack-ruby/slack-api-ref/blob/master/methods/reactions/reactions.add.json
# File lib/slack/web/api/endpoints/reactions.rb, line 20 def reactions_add(options = {}) throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? throw ArgumentError.new('Required arguments :name missing') if options[:name].nil? throw ArgumentError.new('Required arguments :timestamp missing') if options[:timestamp].nil? options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] post('reactions.add', options) end
Gets reactions for an item.
@option options [channel] :channel
Channel where the message to get reactions for was posted.
@option options [file] :file
File to get reactions for.
@option options [Object] :file_comment
File comment to get reactions for.
@option options [Object] :full
If true always return the complete reaction list.
@option options [Object] :timestamp
Timestamp of the message to get reactions for.
@see api.slack.com/methods/reactions.get @see github.com/slack-ruby/slack-api-ref/blob/master/methods/reactions/reactions.get.json
# File lib/slack/web/api/endpoints/reactions.rb, line 43 def reactions_get(options = {}) options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] post('reactions.get', options) end
Lists reactions made by a user.
@option options [Object] :cursor
Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
@option options [Object] :full
If true always return the complete reaction list.
@option options [Object] :limit
The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.
@option options [Object] :team_id
encoded team id to list reactions in, required if org token is used.
@option options [user] :user
Show reactions made by this user. Defaults to the authed user.
@see api.slack.com/methods/reactions.list @see github.com/slack-ruby/slack-api-ref/blob/master/methods/reactions/reactions.list.json
# File lib/slack/web/api/endpoints/reactions.rb, line 63 def reactions_list(options = {}) options = options.merge(user: users_id(options)['user']['id']) if options[:user] if block_given? Pagination::Cursor.new(self, :reactions_list, options).each do |page| yield page end else post('reactions.list', options) end end
Removes a reaction from an item.
@option options [Object] :name
Reaction (emoji) name.
@option options [channel] :channel
Channel where the message to remove reaction from was posted.
@option options [file] :file
File to remove reaction from.
@option options [Object] :file_comment
File comment to remove reaction from.
@option options [Object] :timestamp
Timestamp of the message to remove reaction from.
@see api.slack.com/methods/reactions.remove @see github.com/slack-ruby/slack-api-ref/blob/master/methods/reactions/reactions.remove.json
# File lib/slack/web/api/endpoints/reactions.rb, line 89 def reactions_remove(options = {}) throw ArgumentError.new('Required arguments :name missing') if options[:name].nil? options = options.merge(channel: conversations_id(options)['channel']['id']) if options[:channel] post('reactions.remove', options) end