Module: Slack::Web::Api::Endpoints::Mpim

Included in:
Slack::Web::Api::Endpoints
Defined in:
lib/slack/web/api/endpoints/mpim.rb

Instance Method Summary collapse

Instance Method Details

#mpim_close(options = {}) ⇒ Object

This method closes a multiparty direct message channel.

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :channel (channel)

    MPIM to close.

See Also:


15
16
17
18
19
# 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

#mpim_history(options = {}) ⇒ Object

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.

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :channel (channel)

    Multiparty direct message to fetch history for.

  • :inclusive (Object)

    Include messages with latest or oldest timestamp in results.

  • :latest (timestamp)

    End of time range of messages to include in results.

  • :oldest (timestamp)

    Start of time range of messages to include in results.

  • :unreads (Object)

    Include unread_count_display in the output?.

See Also:


38
39
40
41
42
# 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

#mpim_list(options = {}) ⇒ Object

Don't use this method. Use conversations.list instead.

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :cursor (Object)

    Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first “page” of the collection. See pagination for more details.

  • :limit (Object)

    The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached.

See Also:


53
54
55
56
57
58
59
60
61
# File 'lib/slack/web/api/endpoints/mpim.rb', line 53

def mpim_list(options = {})
  if block_given?
    Pagination::Cursor.new(self, :mpim_list, options).each do |page|
      yield page
    end
  else
    post('mpim.list', options)
  end
end

#mpim_mark(options = {}) ⇒ Object

This method moves the read cursor in a multiparty direct message channel.

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :channel (channel)

    multiparty direct message channel to set reading cursor in.

  • :ts (timestamp)

    Timestamp of the most recently seen message.

See Also:


72
73
74
75
76
77
# File 'lib/slack/web/api/endpoints/mpim.rb', line 72

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

#mpim_open(options = {}) ⇒ Object

This method opens a multiparty direct message.

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :users (Object)

    Comma separated lists of users. The ordering of the users is preserved whenever a MPIM group is returned.

See Also:


86
87
88
89
# File 'lib/slack/web/api/endpoints/mpim.rb', line 86

def mpim_open(options = {})
  throw ArgumentError.new('Required arguments :users missing') if options[:users].nil?
  post('mpim.open', options)
end

#mpim_replies(options = {}) ⇒ Object

This method returns an entire thread (a message plus all the messages in reply to it).

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • :channel (channel)

    Multiparty direct message channel to fetch thread from.

  • :thread_ts (Object)

    Unique identifier of a thread's parent message.

See Also:


100
101
102
103
104
105
# File 'lib/slack/web/api/endpoints/mpim.rb', line 100

def mpim_replies(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :thread_ts missing') if options[:thread_ts].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('mpim.replies', options)
end