Module slacker_usergroup

Function Index

create/3Create a user group.
disable/3Disable a user group.
enable/3Enable a disabled user group.
list/2List user groups.
list_users/3List users in a user group.
update/3Update a user group.
update_users/4Update the list of users.

Function Details

create/3

create(Token::string(), Name::string(), Options::list()) -> http_response()

Create a user group.

Options can be: handle: mention handle description: short description channels: comma separated string of encoded channel IDs for which the user group uses as a default include_count: include the number of users in each user group

disable/3

disable(Token::string(), Usergroup::string(), Options::list()) -> http_response()

Disable a user group.

Options can be: include_count: include the number of users in each user group

enable/3

enable(Token::string(), Usergroup::string(), Options::list()) -> http_response()

Enable a disabled user group.

Options can be: include_count: include the number of users in each user group

list/2

list(Token::string(), Options::list()) -> http_response()

List user groups.

Options can be: include_disabled: include disabled user groups include_count: include the number of users in each user group include_users: include the list of users in each user group

list_users/3

list_users(Token::string(), Usergroup::string(), Options::list()) -> http_response()

List users in a user group.

Options can be: include_disabled: include the disabled user groups

update/3

update(Token::string(), Usergroup::string(), Options::list()) -> http_response()

Update a user group.

Options can be: name: user group name handle: mention handle description: short description channels: comma separated string of encoded channel IDs for which the user group uses as a default include_count: include the number of users in each user group

update_users/4

update_users(Token::string(), Usergroup::string(), Users::[string()], Options::list()) -> http_response()

Update the list of users.

Options can be: include_count: include the number of users in the user group


Generated by EDoc, Feb 3 2016, 17:11:45.