module Slack::Web::Api::Endpoints::Groups

Public Instance Methods

groups_archive(options = {}) click to toggle source

This method archives a private channel.

@option options [group] :channel

Private channel to archive.

@see api.slack.com/methods/groups.archive @see github.com/dblock/slack-api-ref/blob/master/methods/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 = {}) click to toggle source

This method closes a private channel.

@option options [group] :channel

Private channel to close.

@see api.slack.com/methods/groups.close @see github.com/dblock/slack-api-ref/blob/master/methods/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 = {}) click to toggle source

This method creates a private channel.

@option options [Object] :name

Name of private channel to create.

@see api.slack.com/methods/groups.create @see github.com/dblock/slack-api-ref/blob/master/methods/groups.create.json

# File lib/slack/web/api/endpoints/groups.rb, line 41
def groups_create(options = {})
  throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
  post('groups.create', options)
end
groups_createChild(options = {}) click to toggle source

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

@option options [group] :channel

Private channel to clone and archive.

@see api.slack.com/methods/groups.createChild @see github.com/dblock/slack-api-ref/blob/master/methods/groups.createChild.json

# File lib/slack/web/api/endpoints/groups.rb, line 53
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 = {}) click to toggle source

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.

@option options [group] :channel

Private channel to fetch history for.

@option options [timestamp] :latest

End of time range of messages to include in results.

@option options [timestamp] :oldest

Start of time range of messages to include in results.

@option options [Object] :inclusive

Include messages with latest or oldest timestamp in results.

@option options [Object] :unreads

Include unread_count_display in the output?.

@see api.slack.com/methods/groups.history @see github.com/dblock/slack-api-ref/blob/master/methods/groups.history.json

# File lib/slack/web/api/endpoints/groups.rb, line 76
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 = {}) click to toggle source

This method returns information about a private channel.

@option options [group] :channel

Private channel to get info on.

@see api.slack.com/methods/groups.info @see github.com/dblock/slack-api-ref/blob/master/methods/groups.info.json

# File lib/slack/web/api/endpoints/groups.rb, line 89
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 = {}) click to toggle source

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

@option options [group] :channel

Private channel to invite user to.

@option options [user] :user

User to invite.

@see api.slack.com/methods/groups.invite @see github.com/dblock/slack-api-ref/blob/master/methods/groups.invite.json

# File lib/slack/web/api/endpoints/groups.rb, line 104
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 = {}) click to toggle source

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

@option options [group] :channel

Private channel to remove user from.

@option options [user] :user

User to remove from private channel.

@see api.slack.com/methods/groups.kick @see github.com/dblock/slack-api-ref/blob/master/methods/groups.kick.json

# File lib/slack/web/api/endpoints/groups.rb, line 121
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 = {}) click to toggle source

This method is used to leave a private channel.

@option options [group] :channel

Private channel to leave.

@see api.slack.com/methods/groups.leave @see github.com/dblock/slack-api-ref/blob/master/methods/groups.leave.json

# File lib/slack/web/api/endpoints/groups.rb, line 136
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 = {}) click to toggle source

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.

@option options [Object] :exclude_archived

Don't return archived private channels.

@see api.slack.com/methods/groups.list @see github.com/dblock/slack-api-ref/blob/master/methods/groups.list.json

# File lib/slack/web/api/endpoints/groups.rb, line 150
def groups_list(options = {})
  post('groups.list', options)
end
groups_mark(options = {}) click to toggle source

This method moves the read cursor in a private channel.

@option options [group] :channel

Private channel to set reading cursor in.

@option options [timestamp] :ts

Timestamp of the most recently seen message.

@see api.slack.com/methods/groups.mark @see github.com/dblock/slack-api-ref/blob/master/methods/groups.mark.json

# File lib/slack/web/api/endpoints/groups.rb, line 163
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 = {}) click to toggle source

This method opens a private channel.

@option options [group] :channel

Private channel to open.

@see api.slack.com/methods/groups.open @see github.com/dblock/slack-api-ref/blob/master/methods/groups.open.json

# File lib/slack/web/api/endpoints/groups.rb, line 177
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 = {}) click to toggle source

This method renames a private channel.

@option options [group] :channel

Private channel to rename.

@option options [Object] :name

New name for private channel.

@see api.slack.com/methods/groups.rename @see github.com/dblock/slack-api-ref/blob/master/methods/groups.rename.json

# File lib/slack/web/api/endpoints/groups.rb, line 192
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_setPurpose(options = {}) click to toggle source

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

@option options [group] :channel

Private channel to set the purpose of.

@option options [Object] :purpose

The new purpose.

@see api.slack.com/methods/groups.setPurpose @see github.com/dblock/slack-api-ref/blob/master/methods/groups.setPurpose.json

# File lib/slack/web/api/endpoints/groups.rb, line 208
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 = {}) click to toggle source

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

@option options [group] :channel

Private channel to set the topic of.

@option options [Object] :topic

The new topic.

@see api.slack.com/methods/groups.setTopic @see github.com/dblock/slack-api-ref/blob/master/methods/groups.setTopic.json

# File lib/slack/web/api/endpoints/groups.rb, line 224
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 = {}) click to toggle source

This method unarchives a private channel.

@option options [group] :channel

Private channel to unarchive.

@see api.slack.com/methods/groups.unarchive @see github.com/dblock/slack-api-ref/blob/master/methods/groups.unarchive.json

# File lib/slack/web/api/endpoints/groups.rb, line 238
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