lib/slack/web/api/endpoints/reactions.rb in slack-ruby-client-0.14.1 vs lib/slack/web/api/endpoints/reactions.rb in slack-ruby-client-0.14.2

- old
+ new

@@ -4,11 +4,12 @@ module Web module Api module Endpoints module Reactions # - # Adds a reaction to an item. + # This method adds a reaction (emoji) to a message. + # Now that file threads work the way you'd expect, the file and file_comment arguments are deprecated. Specify channel and timestamp instead. # # @option options [Object] :name # Reaction (emoji) name. # @option options [channel] :channel # Channel where the message to add reaction to was posted. @@ -25,11 +26,11 @@ options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel] post('reactions.add', options) end # - # Gets reactions for an item. + # This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message). # # @option options [channel] :channel # Channel where the message to get reactions for was posted. # @option options [file] :file # File to get reactions for. @@ -45,11 +46,11 @@ options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel] post('reactions.get', options) end # - # Lists reactions made by a user. + # This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to 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. @@ -69,10 +70,11 @@ post('reactions.list', options) end end # - # Removes a reaction from an item. + # 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. # # @option options [Object] :name # Reaction (emoji) name. # @option options [channel] :channel # Channel where the message to remove reaction from was posted.