Module: Slack::Web::Api::Endpoints::Usergroups

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

Instance Method Summary collapse

Instance Method Details

#usergroups_create(options = {}) ⇒ Object

Create a User Group.

Options Hash (options):

  • :channels (array) —

    A comma separated string of encoded channel IDs for which the User Group uses as a default.

  • :additional_channels (array) —

    A comma separated string of encoded channel IDs for which the User Group can custom add usergroup members too.

  • :description (string) —

    A short description of the User Group.

  • :handle (string) —

    A mention handle. Must be unique among channels, users and User Groups.

  • :include_count (boolean) —

    Include the number of users in each User Group.

  • :name (string) —

    A name for the User Group. Must be unique among User Groups.

  • :team_id (string) —

    Encoded team id where the user group has to be created, required if org token is used.

  • :enable_section (boolean) —

    Configure this user group to show as a sidebar section for all group members. Note: Only relevant if group has 1 or more default channels added.

Raises:

  • (ArgumentError)

See Also:



30
31
32
33
 
# File 'lib/slack/web/api/endpoints/usergroups.rb', line 30

def usergroups_create(options = {})
  raise ArgumentError, 'Required arguments :name missing' if options[:name].nil?
  post('usergroups.create', options)
end

#usergroups_disable(options = {}) ⇒ Object

Disable an existing User Group.

Options Hash (options):

  • :include_count (boolean) —

    Include the number of users in the User Group.

  • :team_id (Object) —

    Encoded target team id where the user group is, required if org token is used.

  • :usergroup (Object) —

    The encoded ID of the User Group to disable.

Raises:

  • (ArgumentError)

See Also:



46
47
48
49
 
# File 'lib/slack/web/api/endpoints/usergroups.rb', line 46

def usergroups_disable(options = {})
  raise ArgumentError, 'Required arguments :usergroup missing' if options[:usergroup].nil?
  post('usergroups.disable', options)
end

#usergroups_enable(options = {}) ⇒ Object

Enable a User Group.

Options Hash (options):

  • :include_count (boolean) —

    Include the number of users in the User Group.

  • :team_id (string) —

    Encoded team id where the user group is, required if org token is used.

  • :usergroup (string) —

    The encoded ID of the User Group to enable.

Raises:

  • (ArgumentError)

See Also:



62
63
64
65
 
# File 'lib/slack/web/api/endpoints/usergroups.rb', line 62

def usergroups_enable(options = {})
  raise ArgumentError, 'Required arguments :usergroup missing' if options[:usergroup].nil?
  post('usergroups.enable', options)
end

#usergroups_list(options = {}) ⇒ Object

List all User Groups for a team.

Options Hash (options):

  • :include_count (boolean) —

    Include the number of users in each User Group.

  • :include_disabled (boolean) —

    Include results for disabled User Groups.

  • :include_users (boolean) —

    Include the list of users for each User Group.

  • :team_id (string) —

    The user group’s encoded team ID. Required if org token is used.

See Also:



80
81
82
 
# File 'lib/slack/web/api/endpoints/usergroups.rb', line 80

def usergroups_list(options = {})
  post('usergroups.list', options)
end

#usergroups_update(options = {}) ⇒ Object

Update an existing User Group.

Options Hash (options):

  • :channels (array) —

    A comma separated string of encoded channel IDs for which the User Group uses as a default.

  • :additional_channels (array) —

    A comma separated string of encoded channel IDs for which the User Group can custom add usergroup members too.

  • :description (string) —

    A short description of the User Group.

  • :handle (string) —

    A mention handle. Must be unique among channels, users and User Groups.

  • :include_count (boolean) —

    Include the number of users in the User Group.

  • :name (string) —

    A name for the User Group. Must be unique among User Groups.

  • :team_id (Object) —

    encoded team id where the user group exists, required if org token is used.

  • :usergroup (Object) —

    The encoded ID of the User Group to update.

  • :enable_section (boolean) —

    Configure this user group to show as a sidebar section for all group members. Note: Only relevant if group has 1 or more default channels added.

Raises:

  • (ArgumentError)

See Also:



107
108
109
110
 
# File 'lib/slack/web/api/endpoints/usergroups.rb', line 107

def usergroups_update(options = {})
  raise ArgumentError, 'Required arguments :usergroup missing' if options[:usergroup].nil?
  post('usergroups.update', options)
end