module Slack::Endpoint::Im
Public Instance Methods
This method closes a direct message channel.
@option options [Object] :channel
Direct message channel to close.
@see api.slack.com/methods/im.close @see github.com/aki017/slack-api-docs/blob/master/methods/im.close.md @see github.com/aki017/slack-api-docs/blob/master/methods/im.close.json
# File lib/slack/endpoint/im.rb, line 14 def im_close(options={}) throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil? options[:attachments] = options[:attachments].to_json if Hash === options[:attachments] 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.
@option options [Object] :channel
Direct message channel to fetch history for.
@option options [Object] :latest
End of time range of messages to include in results.
@option options [Object] :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] :count
Number of messages to return, between 1 and 1000.
@option options [Object] :unreads
Include unread_count_display in the output?
@see api.slack.com/methods/im.history @see github.com/aki017/slack-api-docs/blob/master/methods/im.history.md @see github.com/aki017/slack-api-docs/blob/master/methods/im.history.json
# File lib/slack/endpoint/im.rb, line 40 def im_history(options={}) throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil? options[:attachments] = options[:attachments].to_json if Hash === options[:attachments] post("im.history", options) end
This method returns a list of all im channels that the user has.
@see api.slack.com/methods/im.list @see github.com/aki017/slack-api-docs/blob/master/methods/im.list.md @see github.com/aki017/slack-api-docs/blob/master/methods/im.list.json
# File lib/slack/endpoint/im.rb, line 52 def im_list(options={}) options[:attachments] = options[:attachments].to_json if Hash === options[:attachments] post("im.list", options) end
This method moves the read cursor in a direct message channel.
@option options [Object] :channel
Direct message channel to set reading cursor in.
@option options [Object] :ts
Timestamp of the most recently seen message.
@see api.slack.com/methods/im.mark @see github.com/aki017/slack-api-docs/blob/master/methods/im.mark.md @see github.com/aki017/slack-api-docs/blob/master/methods/im.mark.json
# File lib/slack/endpoint/im.rb, line 67 def im_mark(options={}) throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil? throw ArgumentError.new("Required arguments :ts missing") if options[:ts].nil? options[:attachments] = options[:attachments].to_json if Hash === options[:attachments] post("im.mark", options) end
This method opens a direct message channel with another member of your Slack
team.
@option options [Object] :user
User to open a direct message channel with.
@see api.slack.com/methods/im.open @see github.com/aki017/slack-api-docs/blob/master/methods/im.open.md @see github.com/aki017/slack-api-docs/blob/master/methods/im.open.json
# File lib/slack/endpoint/im.rb, line 82 def im_open(options={}) throw ArgumentError.new("Required arguments :user missing") if options[:user].nil? options[:attachments] = options[:attachments].to_json if Hash === options[:attachments] post("im.open", options) end