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.

  • :latest (timestamp)

    End of time range of messages to include in results.

  • :oldest (timestamp)

    Start of time range of messages to include in results.

  • :inclusive (Object)

    Include messages with latest or oldest timestamp 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

This method returns a list of all multiparty direct message channels that the user has.


49
50
51
# File 'lib/slack/web/api/endpoints/mpim.rb', line 49

def mpim_list(options = {})
  post('mpim.list', options)
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:


62
63
64
65
66
67
# 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

#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:


76
77
78
79
# 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