lib/slack/web/api/endpoints/im.rb in slack-ruby-client-0.3.0 vs lib/slack/web/api/endpoints/im.rb in slack-ruby-client-0.3.1
- old
+ new
@@ -6,11 +6,11 @@
module Endpoints
module Im
#
# This method closes a direct message channel.
#
- # @option options [Object] :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.close.json
def im_close(options = {})
throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
@@ -20,15 +20,15 @@
#
# 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.
#
- # @option options [Object] :channel
+ # @option options [im] :channel
# Direct message channel to fetch history for.
- # @option options [Object] :latest
+ # @option options [timestamp] :latest
# End of time range of messages to include in results.
- # @option options [Object] :oldest
+ # @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.
# @see https://api.slack.com/methods/im.history
# @see https://github.com/dblock/slack-api-ref/blob/master/methods/im.history.json
@@ -47,13 +47,13 @@
end
#
# This method moves the read cursor in a direct message channel.
#
- # @option options [Object] :channel
+ # @option options [im] :channel
# Direct message channel to set reading cursor in.
- # @option options [Object] :ts
+ # @option options [timestamp] :ts
# Timestamp of the most recently seen message.
# @see https://api.slack.com/methods/im.mark
# @see https://github.com/dblock/slack-api-ref/blob/master/methods/im.mark.json
def im_mark(options = {})
throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
@@ -62,10 +62,10 @@
end
#
# This method opens a direct message channel with another member of your Slack team.
#
- # @option options [Object] :user
+ # @option options [user] :user
# User to open a direct message channel with.
# @see https://api.slack.com/methods/im.open
# @see https://github.com/dblock/slack-api-ref/blob/master/methods/im.open.json
def im_open(options = {})
throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?