module Slack::Endpoint::Mpim
Public Instance Methods
This method closes a multiparty direct message channel.
@option options [Object] :channel
MPIM to close.
@see api.slack.com/methods/mpim.close @see github.com/aki017/slack-api-docs/blob/master/methods/mpim.close.md @see github.com/aki017/slack-api-docs/blob/master/methods/mpim.close.json
# File lib/slack/endpoint/mpim.rb, line 14 def mpim_close(options={}) throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil? options[:attachments] = options[:attachments].to_json if Hash === options[:attachments] post("mpim.close", options) end
This method returns a portion of messages/events from the specified multiparty direct message channel. To read the entire history for a multiparty direct message, call the method with no latest or oldest arguments, and then continue paging using the instructions below.
@option options [Object] :channel
Multiparty direct message 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/mpim.history @see github.com/aki017/slack-api-docs/blob/master/methods/mpim.history.md @see github.com/aki017/slack-api-docs/blob/master/methods/mpim.history.json
# File lib/slack/endpoint/mpim.rb, line 40 def mpim_history(options={}) throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil? options[:attachments] = options[:attachments].to_json if Hash === options[:attachments] post("mpim.history", options) end
This method returns a list of all multiparty direct message channels that the user has.
@see api.slack.com/methods/mpim.list @see github.com/aki017/slack-api-docs/blob/master/methods/mpim.list.md @see github.com/aki017/slack-api-docs/blob/master/methods/mpim.list.json
# File lib/slack/endpoint/mpim.rb, line 52 def mpim_list(options={}) options[:attachments] = options[:attachments].to_json if Hash === options[:attachments] post("mpim.list", options) end
This method moves the read cursor in a multiparty direct message channel.
@option options [Object] :channel
multiparty direct message channel to set reading cursor in.
@option options [Object] :ts
Timestamp of the most recently seen message.
@see api.slack.com/methods/mpim.mark @see github.com/aki017/slack-api-docs/blob/master/methods/mpim.mark.md @see github.com/aki017/slack-api-docs/blob/master/methods/mpim.mark.json
# File lib/slack/endpoint/mpim.rb, line 67 def mpim_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("mpim.mark", options) end
This method opens a multiparty direct message.
@option options [Object] :users
Comma separated lists of users. The ordering of the users is preserved whenever a MPIM group is returned.
@see api.slack.com/methods/mpim.open @see github.com/aki017/slack-api-docs/blob/master/methods/mpim.open.md @see github.com/aki017/slack-api-docs/blob/master/methods/mpim.open.json
# File lib/slack/endpoint/mpim.rb, line 82 def mpim_open(options={}) throw ArgumentError.new("Required arguments :users missing") if options[:users].nil? options[:attachments] = options[:attachments].to_json if Hash === options[:attachments] post("mpim.open", options) end