module Slack::Web::Groups

Module for the groups methods. Get info on your team's private groups.

Constants

SCOPE

Endpoint scope

Public Instance Methods

groups_archive(params = {}) click to toggle source

Archives a private group.

@param [Hash] params

API call arguments

@option params [group] 'channel'

Private group to archive

@see api.slack.com/methods/groups.archive

# File lib/slack/web/groups.rb, line 20
def groups_archive(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  response = @session.do_post "#{SCOPE}.archive", params
  Slack.parse_response(response)
end
groups_close(params = {}) click to toggle source

Closes a private group.

@param [Hash] params

API call arguments

@option params [group] 'channel'

Group to close.

@see api.slack.com/methods/groups.close

# File lib/slack/web/groups.rb, line 34
def groups_close(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  response = @session.do_post "#{SCOPE}.close", params
  Slack.parse_response(response)
end
groups_create(params = {}) click to toggle source

Creates a private group.

@param [Hash] params

API call arguments

@option params [Object] 'name'

Name of group to create

@see api.slack.com/methods/groups.create

# File lib/slack/web/groups.rb, line 48
def groups_create(params = {})
  fail ArgumentError, "Required arguments 'name' missing" if params['name'].nil?
  response = @session.do_post "#{SCOPE}.create", params
  Slack.parse_response(response)
end
groups_create_child(params = {}) click to toggle source

Clones and archives a private group.

@param [Hash] params

API call arguments

@option params [Object] 'channel'

Group to clone and archive.

@see api.slack.com/methods/groups.createChild

# File lib/slack/web/groups.rb, line 62
def groups_create_child(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  response = @session.do_post "#{SCOPE}.createChild", params
  Slack.parse_response(response)
end
groups_history(params = {}) click to toggle source

Fetches history of messages and events from a private group.

@param [Hash] params

API call arguments

@option params [group] 'channel'

Group to fetch history for.

@option params [timestamp] 'latest'

Latest message timestamp to include in results.

@option params [timestamp] 'oldest'

Oldest message timestamp to include in results.

@option params [Object] 'inclusive'

Include messages with latest or oldest timestamp in results.

@option params [Object] 'count'

Number of messages to return, between 1 and 1000.

@see api.slack.com/methods/groups.history

# File lib/slack/web/groups.rb, line 84
def groups_history(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  response = @session.do_post "#{SCOPE}.history", params
  Slack.parse_response(response)
end
groups_info(params = {}) click to toggle source

This method returns information about a private group.

@param [Hash] params

API call arguments

@option params [channel] 'channel'

Group to get info on

@see api.slack.com/methods/channels.info

# File lib/slack/web/groups.rb, line 98
def groups_info(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  response = @session.do_post "#{SCOPE}.info", params
  Slack.parse_response(response)
end
groups_invite(params = {}) click to toggle source

Invites a user to a private group.

@param [Hash] params

API call arguments

@option params [group] 'channel'

Private group to invite user to.

@option params [user] 'user'

User to invite.

@see api.slack.com/methods/groups.invite

# File lib/slack/web/groups.rb, line 114
def groups_invite(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  fail ArgumentError, "Required arguments 'user' missing" if params['user'].nil?
  response = @session.do_post "#{SCOPE}.invite", params
  Slack.parse_response(response)
end
groups_kick(params = {}) click to toggle source

Removes a user from a private group.

@param [Hash] params

API call arguments

@option params [group] 'channel'

Group to remove user from.

@option params [user] 'user'

User to remove from group.

@see api.slack.com/methods/groups.kick

# File lib/slack/web/groups.rb, line 131
def groups_kick(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  fail ArgumentError, "Required arguments 'user' missing" if params['user'].nil?
  response = @session.do_post "#{SCOPE}.kick", params
  Slack.parse_response(response)
end
groups_leave(params = {}) click to toggle source

Leaves a private group. @param [Hash] params

API call arguments

@option params [group] 'channel'

Group to leave

@see api.slack.com/methods/groups.leave

# File lib/slack/web/groups.rb, line 145
def groups_leave(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  response = @session.do_post "#{SCOPE}.leave", params
  Slack.parse_response(response)
end
groups_list(params = {}) click to toggle source

Lists private groups that the calling user has access to.

@param [Hash] params

API call arguments

@option params [Object] 'exclude_archived'

Don't return archived groups.

@see api.slack.com/methods/groups.list

# File lib/slack/web/groups.rb, line 159
def groups_list(params = {})
  response = @session.do_post "#{SCOPE}.list", params
  Slack.parse_response(response)
end
groups_mark(params = {}) click to toggle source

Sets the read cursor in a private group.

@param [Hash] params

API call arguments

@option params [group] 'channel'

Group to set reading cursor in.

@option params [timestamp] 'ts'

Timestamp of the most recently seen message.

@see api.slack.com/methods/groups.mark

# File lib/slack/web/groups.rb, line 174
def groups_mark(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  fail ArgumentError, "Required arguments 'ts' missing" if params['ts'].nil?
  response = @session.do_post "#{SCOPE}.mark", params
  Slack.parse_response(response)
end
groups_open(params = {}) click to toggle source

Opens a private group.

@param [Hash] params

API call arguments

@option params [group] 'channel'

Group to open.

@see api.slack.com/methods/groups.open

# File lib/slack/web/groups.rb, line 189
def groups_open(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  response = @session.do_post "#{SCOPE}.open", params
  Slack.parse_response(response)
end
groups_rename(params = {}) click to toggle source

Renames a private group.

@param [Hash] params

API call arguments

@option params [group] 'channel'

Group to rename

@option params [Object] 'name'

New name for group.

@see api.slack.com/methods/groups.rename

# File lib/slack/web/groups.rb, line 205
def groups_rename(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  fail ArgumentError, "Required arguments 'name' missing" if params['name'].nil?
  response = @session.do_post "#{SCOPE}.rename", params
  Slack.parse_response(response)
end
groups_set_purpose(params = {}) click to toggle source

Sets the purpose for a private group.

@param [Hash] params

API call arguments

@option params [group] 'channel'

Private group to set the purpose of

@option params [Object] 'purpose'

The new purpose

@see api.slack.com/methods/groups.setPurpose

# File lib/slack/web/groups.rb, line 222
def groups_set_purpose(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  fail ArgumentError, "Required arguments 'pupose' missing" if params['purpos'].nil?
  response = @session.do_post "#{SCOPE}.setPurpose", params
  Slack.parse_response(response)
end
groups_set_topic(params = {}) click to toggle source

Sets the topic for a private group.

@param [Hash] params

API call arguments

@option params [group] 'channel'

Private group to set the purpose of

@option params [Object] 'topic'

The new topic

@see api.slack.com/methods/groups.setTopic

# File lib/slack/web/groups.rb, line 239
def groups_set_topic(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  fail ArgumentError, "Required arguments 'topic' missing" if params['topic'].nil?
  response = @session.do_post "#{SCOPE}.setTopic", params
  Slack.parse_response(response)
end
groups_unarchive(params = {}) click to toggle source

Unarchives a private group.

@param [Hash] params

API call arguments

@option params [group] 'channel'

Group to unarchive

@fail [ArgumentError] if 'channel' is not present @see api.slack.com/methods/groups.unarchive

# File lib/slack/web/groups.rb, line 254
def groups_unarchive(params = {})
  fail ArgumentError, "Required arguments 'channel' missing" if params['channel'].nil?
  response = @session.do_post "#{SCOPE}.unarchive", params
  Slack.parse_response(response)
end