module Slack::Web::Api::Endpoints::Mpim
Public Instance Methods
This method closes a multiparty direct message channel.
@option options [channel] :channel
MPIM to close.
@see api.slack.com/methods/mpim.close @see github.com/dblock/slack-api-ref/blob/master/methods/mpim.close.json
# File lib/slack/web/api/endpoints/mpim.rb, line 15 def mpim_close(options = {}) throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel] 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 [channel] :channel
Multiparty direct message to fetch history for.
@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 api.slack.com/methods/mpim.history @see github.com/dblock/slack-api-ref/blob/master/methods/mpim.history.json
# File lib/slack/web/api/endpoints/mpim.rb, line 38 def mpim_history(options = {}) throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil? options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel] 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/dblock/slack-api-ref/blob/master/methods/mpim.list.json
# File lib/slack/web/api/endpoints/mpim.rb, line 49 def mpim_list(options = {}) post('mpim.list', options) end
This method moves the read cursor in a multiparty direct message channel.
@option options [channel] :channel
multiparty direct message channel to set reading cursor in.
@option options [timestamp] :ts
Timestamp of the most recently seen message.
@see api.slack.com/methods/mpim.mark @see github.com/dblock/slack-api-ref/blob/master/methods/mpim.mark.json
# File lib/slack/web/api/endpoints/mpim.rb, line 62 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 = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel] 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/dblock/slack-api-ref/blob/master/methods/mpim.open.json
# File lib/slack/web/api/endpoints/mpim.rb, line 76 def mpim_open(options = {}) throw ArgumentError.new('Required arguments :users missing') if options[:users].nil? post('mpim.open', options) end