Module: Slack::Web::Api::Endpoints::Groups

Included in:

Slack::Web::Api::Endpoints

Defined in:

lib/slack/web/api/endpoints/groups.rb

Instance Method Summary

• #groups_archive(options = {}) ⇒ Object

  This method archives a private channel.

• #groups_close(options = {}) ⇒ Object

  This method closes a private channel.

• #groups_create(options = {}) ⇒ Object

  This method creates a private channel.

• #groups_createChild(options = {}) ⇒ Object

  This method takes an existing private channel and performs the following steps:.

• #groups_history(options = {}) ⇒ Object

  This method returns a portion of messages/events from the specified private channel.

• #groups_info(options = {}) ⇒ Object

  This method returns information about a private channel.

• #groups_invite(options = {}) ⇒ Object

  This method is used to invite a user to a private channel.

• #groups_kick(options = {}) ⇒ Object

  This method allows a user to remove another member from a private channel.

• #groups_leave(options = {}) ⇒ Object

  This method is used to leave a private channel.

• #groups_list(options = {}) ⇒ Object

  This method returns a list of private channels in the team that the caller is in and archived groups that the caller was in.

• #groups_mark(options = {}) ⇒ Object

  This method moves the read cursor in a private channel.

• #groups_open(options = {}) ⇒ Object

  This method opens a private channel.

• #groups_rename(options = {}) ⇒ Object

  This method renames a private channel.

• #groups_replies(options = {}) ⇒ Object

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

• #groups_setPurpose(options = {}) ⇒ Object

  This method is used to change the purpose of a private channel.

• #groups_setTopic(options = {}) ⇒ Object

  This method is used to change the topic of a private channel.

• #groups_unarchive(options = {}) ⇒ Object

  This method unarchives a private channel.

Instance Method Details

#groups_archive(options = {}) ⇒ Object

This method archives a private channel.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (group) —

  Private channel to archive.

See Also:

• https://api.slack.com/methods/groups.archive
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.archive.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 15

def groups_archive(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
  post('groups.archive', options)
end

#groups_close(options = {}) ⇒ Object

This method closes a private channel.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (group) —

  Private channel to close.

See Also:

• https://api.slack.com/methods/groups.close
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.close.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 28

def groups_close(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
  post('groups.close', options)
end

#groups_create(options = {}) ⇒ Object

This method creates a private channel.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :name (Object) —

  Name of private channel to create.

• :validate (Object) —

  Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.

See Also:

• https://api.slack.com/methods/groups.create
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.create.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 43

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

#groups_createChild(options = {}) ⇒ Object

This method takes an existing private channel and performs the following steps:

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (group) —

  Private channel to clone and archive.

See Also:

• https://api.slack.com/methods/groups.createChild
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.createChild.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 55

def groups_createChild(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
  post('groups.createChild', options)
end

#groups_history(options = {}) ⇒ Object

This method returns a portion of messages/events from the specified private channel. To read the entire history for a private channel, 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 (group) —

  Private channel 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:

• https://api.slack.com/methods/groups.history
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.history.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 78

def groups_history(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
  post('groups.history', options)
end

#groups_info(options = {}) ⇒ Object

This method returns information about a private channel.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (group) —

  Private channel to get info on.

See Also:

• https://api.slack.com/methods/groups.info
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.info.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 91

def groups_info(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
  post('groups.info', options)
end

#groups_invite(options = {}) ⇒ Object

This method is used to invite a user to a private channel. The calling user must be a member of the private channel.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (group) —

  Private channel to invite user to.

• :user (user) —

  User to invite.

See Also:

• https://api.slack.com/methods/groups.invite
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.invite.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 106

def groups_invite(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: groups_id(options)['group']['id']) if options[:channel]
  options = options.merge(user: users_id(options)['user']['id']) if options[:user]
  post('groups.invite', options)
end

#groups_kick(options = {}) ⇒ Object

This method allows a user to remove another member from a private channel.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (group) —

  Private channel to remove user from.

• :user (user) —

  User to remove from private channel.

See Also:

• https://api.slack.com/methods/groups.kick
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.kick.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 123

def groups_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: groups_id(options)['group']['id']) if options[:channel]
  options = options.merge(user: users_id(options)['user']['id']) if options[:user]
  post('groups.kick', options)
end

#groups_leave(options = {}) ⇒ Object

This method is used to leave a private channel.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (group) —

  Private channel to leave.

See Also:

• https://api.slack.com/methods/groups.leave
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.leave.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 138

def groups_leave(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
  post('groups.leave', options)
end

#groups_list(options = {}) ⇒ Object

This method returns a list of private channels in the team that the caller is in and archived groups that the caller was in. The list of (non-deactivated) members in each private channel is also returned.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :exclude_archived (Object) —

  Don’t return archived private channels.

See Also:

• https://api.slack.com/methods/groups.list
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.list.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 152

def groups_list(options = {})
  post('groups.list', options)
end

#groups_mark(options = {}) ⇒ Object

This method moves the read cursor in a private channel.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (group) —

  Private channel to set reading cursor in.

• :ts (timestamp) —

  Timestamp of the most recently seen message.

See Also:

• https://api.slack.com/methods/groups.mark
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.mark.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 165

def groups_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: groups_id(options)['group']['id']) if options[:channel]
  post('groups.mark', options)
end

#groups_open(options = {}) ⇒ Object

This method opens a private channel.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (group) —

  Private channel to open.

See Also:

• https://api.slack.com/methods/groups.open
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.open.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 179

def groups_open(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
  post('groups.open', options)
end

#groups_rename(options = {}) ⇒ Object

This method renames a private channel.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (group) —

  Private channel to rename.

• :name (Object) —

  New name for private channel.

• :validate (Object) —

  Whether to return errors on invalid channel name instead of modifying it to meet the specified criteria.

See Also:

• https://api.slack.com/methods/groups.rename
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.rename.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 196

def groups_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: groups_id(options)['group']['id']) if options[:channel]
  post('groups.rename', options)
end

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

  Private channel to fetch thread from.

• :thread_ts (Object) —

  Unique identifier of a thread’s parent message.

See Also:

• https://api.slack.com/methods/groups.replies
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.replies.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 212

def groups_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: groups_id(options)['group']['id']) if options[:channel]
  post('groups.replies', options)
end

#groups_setPurpose(options = {}) ⇒ Object

This method is used to change the purpose of a private channel. The calling user must be a member of the private channel.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (group) —

  Private channel to set the purpose of.

• :purpose (Object) —

  The new purpose.

See Also:

• https://api.slack.com/methods/groups.setPurpose
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.setPurpose.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 228

def groups_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: groups_id(options)['group']['id']) if options[:channel]
  post('groups.setPurpose', options)
end

#groups_setTopic(options = {}) ⇒ Object

This method is used to change the topic of a private channel. The calling user must be a member of the private channel.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (group) —

  Private channel to set the topic of.

• :topic (Object) —

  The new topic.

See Also:

• https://api.slack.com/methods/groups.setTopic
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.setTopic.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 244

def groups_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: groups_id(options)['group']['id']) if options[:channel]
  post('groups.setTopic', options)
end

#groups_unarchive(options = {}) ⇒ Object

This method unarchives a private channel.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :channel (group) —

  Private channel to unarchive.

See Also:

• https://api.slack.com/methods/groups.unarchive
• https://github.com/dblock/slack-api-ref/blob/master/methods/groups/groups.unarchive.json

# File 'lib/slack/web/api/endpoints/groups.rb', line 258

def groups_unarchive(options = {})
  throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
  options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
  post('groups.unarchive', options)
end