Module: Slack::Endpoint::Mpim

Included in:
Slack::Endpoint
Defined in:
lib/slack/endpoint/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 (Object) —

    MPIM to close.

See Also:



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

#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 (Object) —

    Multiparty direct message to fetch history for.

  • :latest (Object) —

    End of time range of messages to include in results.

  • :oldest (Object) —

    Start of time range of messages to include in results.

  • :inclusive (Object) —

    Include messages with latest or oldest timestamp in results.

  • :count (Object) —

    Number of messages to return, between 1 and 1000.

  • :unreads (Object) —

    Include unread_count_display in the output?

See Also:



40
41
42
43
44
 
# 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

#mpim_list(options = {}) ⇒ Object

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

See Also:



52
53
54
55
 
# 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

#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 (Object) —

    multiparty direct message channel to set reading cursor in.

  • :ts (Object) —

    Timestamp of the most recently seen message.

See Also:



67
68
69
70
71
72
 
# 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

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



82
83
84
85
86
 
# 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

#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 (Object) —

    Multiparty direct message channel to fetch thread from.

  • :thread_ts (Object) —

    Unique identifier of a thread’s parent message.

See Also:



98
99
100
101
102
103
 
# File 'lib/slack/endpoint/mpim.rb', line 98

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[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
  post("mpim.replies", options)
end