Module: Slack::Web::Api::Endpoints::Conversations

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

Instance Method Summary collapse

Instance Method Details

#conversations_archive(options = {}) ⇒ Object

Archives a conversation.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    ID of conversation to archive.

See Also:



15
16
17
18
19
 
# File 'lib/slack/web/api/endpoints/conversations.rb', line 15

def conversations_archive(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('conversations.archive', options)
end

#conversations_close(options = {}) ⇒ Object

Closes a direct message or multi-person direct message.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    Conversation to close.

See Also:



28
29
30
31
32
 
# File 'lib/slack/web/api/endpoints/conversations.rb', line 28

def conversations_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('conversations.close', options)
end

#conversations_create(options = {}) ⇒ Object

Initiates a public or private channel-based conversation

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :name (Object) —

    Name of the public or private channel to create.

  • :is_private (Object) —

    Create a private channel instead of a public one.

See Also:



43
44
45
46
 
# File 'lib/slack/web/api/endpoints/conversations.rb', line 43

def conversations_create(options = {})
  throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
  post('conversations.create', options)
end

#conversations_history(options = {}) ⇒ Object

Fetches a conversation’s history of messages and events.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    Conversation ID to fetch history for.

  • :cursor (Object) —

    Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request’s response_metadata. Default value fetches the first “page” of the collection. See pagination for more detail.

  • :latest (timestamp) —

    End of time range of messages to include in results.

  • :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 users list hasn’t been reached.

  • :oldest (timestamp) —

    Start of time range of messages to include in results.

See Also:



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/slack/web/api/endpoints/conversations.rb', line 63

def conversations_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]
  if block_given?
    Pagination::Cursor.new(self, :conversations_history, options).each do |page|
      yield page
    end
  else
    post('conversations.history', options)
  end
end

#conversations_info(options = {}) ⇒ Object

Retrieve information about a conversation.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    Conversation ID to learn more about.

  • :include_locale (Object) —

    Set this to true to receive the locale for this conversation. Defaults to false.

See Also:



84
85
86
87
88
 
# File 'lib/slack/web/api/endpoints/conversations.rb', line 84

def conversations_info(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('conversations.info', options)
end

#conversations_invite(options = {}) ⇒ Object

Invites users to a channel.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    The ID of the public or private channel to invite user(s) to.

  • :users (Object) —

    A comma separated list of user IDs. Up to 30 users may be listed.

See Also:



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

def conversations_invite(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :users missing') if options[:users].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('conversations.invite', options)
end

#conversations_join(options = {}) ⇒ Object

Joins an existing conversation.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    ID of conversation to join.

See Also:



113
114
115
116
117
 
# File 'lib/slack/web/api/endpoints/conversations.rb', line 113

def conversations_join(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('conversations.join', options)
end

#conversations_kick(options = {}) ⇒ Object

Removes a user from a conversation.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    ID of conversation to remove user from.

  • :user (user) —

    User ID to be removed.

See Also:



128
129
130
131
132
133
134
 
# File 'lib/slack/web/api/endpoints/conversations.rb', line 128

def conversations_kick(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  options = options.merge(user: users_id(options)['user']['id']) if options[:user]
  post('conversations.kick', options)
end

#conversations_leave(options = {}) ⇒ Object

Leaves a conversation.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    Conversation to leave.

See Also:



143
144
145
146
147
 
# File 'lib/slack/web/api/endpoints/conversations.rb', line 143

def conversations_leave(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('conversations.leave', options)
end

#conversations_list(options = {}) ⇒ Object

Lists all channels in a Slack team.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :cursor (Object) —

    Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request’s response_metadata. Default value fetches the first “page” of the collection. See pagination for more detail.

  • :exclude_archived (Object) —

    Set to true to exclude archived channels from the list.

  • :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. Must be an integer no larger than 1000.

  • :types (Object) —

    Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.

See Also:



162
163
164
165
166
167
168
169
170
 
# File 'lib/slack/web/api/endpoints/conversations.rb', line 162

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

#conversations_members(options = {}) ⇒ Object

Retrieve members of a conversation.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    ID of the conversation to retrieve members for.

  • :cursor (Object) —

    Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request’s response_metadata. Default value fetches the first “page” of the collection. See pagination for more detail.

  • :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 users list hasn’t been reached.

See Also:



183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/slack/web/api/endpoints/conversations.rb', line 183

def conversations_members(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  if block_given?
    Pagination::Cursor.new(self, :conversations_members, options).each do |page|
      yield page
    end
  else
    post('conversations.members', options)
  end
end

#conversations_open(options = {}) ⇒ Object

Opens or resumes a direct message or multi-person direct message.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    Resume a conversation by supplying an im or mpim’s ID. Or provide the users field instead.

  • :return_im (Object) —

    Boolean, indicates you want the full IM channel definition in the response.

  • :users (Object) —

    Comma separated lists of users. If only one user is included, this creates a 1:1 DM. The ordering of the users is preserved whenever a multi-person direct message is returned. Supply a channel when not supplying users.

See Also:



206
207
208
209
 
# File 'lib/slack/web/api/endpoints/conversations.rb', line 206

def conversations_open(options = {})
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('conversations.open', options)
end

#conversations_rename(options = {}) ⇒ Object

Renames a conversation.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    ID of conversation to rename.

  • :name (Object) —

    New name for conversation.

See Also:



220
221
222
223
224
225
 
# File 'lib/slack/web/api/endpoints/conversations.rb', line 220

def conversations_rename(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('conversations.rename', options)
end

#conversations_replies(options = {}) ⇒ Object

Retrieve a thread of messages posted to a conversation

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    Conversation ID to fetch thread from.

  • :ts (timestamp) —

    Unique identifier of a thread’s parent message.

  • :cursor (Object) —

    Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request’s response_metadata. Default value fetches the first “page” of the collection. See pagination for more detail.

  • :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 users list hasn’t been reached.

See Also:



240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/slack/web/api/endpoints/conversations.rb', line 240

def conversations_replies(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]
  if block_given?
    Pagination::Cursor.new(self, :conversations_replies, options).each do |page|
      yield page
    end
  else
    post('conversations.replies', options)
  end
end

#conversations_setPurpose(options = {}) ⇒ Object

Sets the purpose for a conversation.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    Conversation to set the purpose of.

  • :purpose (Object) —

    A new, specialer purpose.

See Also:



262
263
264
265
266
267
 
# File 'lib/slack/web/api/endpoints/conversations.rb', line 262

def conversations_setPurpose(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :purpose missing') if options[:purpose].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('conversations.setPurpose', options)
end

#conversations_setTopic(options = {}) ⇒ Object

Sets the topic for a conversation.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    Conversation to set the topic of.

  • :topic (Object) —

    The new topic string. Does not support formatting or linkification.

See Also:



278
279
280
281
282
283
 
# File 'lib/slack/web/api/endpoints/conversations.rb', line 278

def conversations_setTopic(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  throw ArgumentError.new('Required arguments :topic missing') if options[:topic].nil?
  options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
  post('conversations.setTopic', options)
end

#conversations_unarchive(options = {}) ⇒ Object

Reverses conversation archival.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (channel) —

    ID of conversation to unarchive.

See Also:



292
293
294
295
296
 
# File 'lib/slack/web/api/endpoints/conversations.rb', line 292

def conversations_unarchive(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('conversations.unarchive', options)
end