im.rb in slack-ruby-client-0.9.1

- old
+ new

@@ -4,11 +4,11 @@
   module Web
     module Api
       module Endpoints
         module Im
           #
-          # This method closes a direct message channel.
+          # Close a direct message channel.
           #
           # @option options [im] :channel
           #   Direct message channel to close.
           # @see https://api.slack.com/methods/im.close
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im/im.close.json
@@ -17,22 +17,20 @@
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('im.close', options)
           end
 
           #
-          # This method returns a portion of messages/events from the specified direct message channel.
-          # To read the entire history for a direct message channel, call the method with no latest or
-          # oldest arguments, and then continue paging using the instructions below.
+          # Fetches history of messages and events from direct message channel.
           #
           # @option options [im] :channel
           #   Direct message channel to fetch history for.
+          # @option options [Object] :inclusive
+          #   Include messages with latest or oldest timestamp in results.
           # @option options [timestamp] :latest
           #   End of time range of messages to include in results.
           # @option options [timestamp] :oldest
           #   Start of time range of messages to include in results.
-          # @option options [Object] :inclusive
-          #   Include messages with latest or oldest timestamp in results.
           # @option options [Object] :unreads
           #   Include unread_count_display in the output?.
           # @see https://api.slack.com/methods/im.history
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im/im.history.json
           def im_history(options = {})
@@ -40,20 +38,20 @@
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('im.history', options)
           end
 
           #
-          # This method returns a list of all im channels that the user has.
+          # Lists direct message channels for the calling user.
           #
           # @see https://api.slack.com/methods/im.list
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im/im.list.json
           def im_list(options = {})
             post('im.list', options)
           end
 
           #
-          # This method moves the read cursor in a direct message channel.
+          # Sets the read cursor in a direct message channel.
           #
           # @option options [im] :channel
           #   Direct message channel to set reading cursor in.
           # @option options [timestamp] :ts
           #   Timestamp of the most recently seen message.
@@ -65,11 +63,11 @@
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('im.mark', options)
           end
 
           #
-          # This method opens a direct message channel with another member of your Slack team.
+          # Opens a direct message channel.
           #
           # @option options [user] :user
           #   User to open a direct message channel with.
           # @option options [Object] :return_im
           #   Boolean, indicates you want the full IM channel definition in the response.
@@ -80,10 +78,10 @@
             options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('im.open', options)
           end
 
           #
-          # This method returns an entire thread (a message plus all the messages in reply to it).
+          # Retrieve a thread of messages posted to a direct message conversation
           #
           # @option options [im] :channel
           #   Direct message channel to fetch thread from.
           # @option options [Object] :thread_ts
           #   Unique identifier of a thread's parent message.