UsergroupsFacet

Kind: global class

• UsergroupsFacet
  • .create(name, [opts], [optCb])
  • .disable(usergroup, [opts], [optCb])
  • .enable(usergroup, [opts], [optCb])
  • .list([opts], [optCb])
  • .update(usergroup, [opts], [optCb])

usergroupsFacet.create(name, [opts], [optCb])

Create a User Group

Kind: instance method of [UsergroupsFacet](#UsergroupsFacet)
See: usergroups.create

Param	Type	Description
name	?	A name for the User Group. Must be unique among User Groups.
[opts]	Object
opts.handle	?	A mention handle. Must be unique among channels, users and User Groups.
opts.description	?	A short description of the User Group.
opts.channels	?	A comma separated string of encoded channel IDs for which the User Group uses as a default.
opts.include_count	?	Include the number of users in each User Group.
[optCb]	function	Optional callback, if not using promises.

usergroupsFacet.disable(usergroup, [opts], [optCb])

Disable an existing User Group

Kind: instance method of [UsergroupsFacet](#UsergroupsFacet)
See: usergroups.disable

Param	Type	Description
usergroup	?	The encoded ID of the User Group to disable.
[opts]	Object
opts.include_count	?	Include the number of users in the User Group.
[optCb]	function	Optional callback, if not using promises.

usergroupsFacet.enable(usergroup, [opts], [optCb])

Enable a User Group

Kind: instance method of [UsergroupsFacet](#UsergroupsFacet)
See: usergroups.enable

Param	Type	Description
usergroup	?	The encoded ID of the User Group to enable.
[opts]	Object
opts.include_count	?	Include the number of users in the User Group.
[optCb]	function	Optional callback, if not using promises.

usergroupsFacet.list([opts], [optCb])

List all User Groups for a team

Kind: instance method of [UsergroupsFacet](#UsergroupsFacet)
See: usergroups.list

Param	Type	Description
[opts]	Object
opts.include_disabled	?	Include disabled User Groups.
opts.include_count	?	Include the number of users in each User Group.
opts.include_users	?	Include the list of users for each User Group.
[optCb]	function	Optional callback, if not using promises.

usergroupsFacet.update(usergroup, [opts], [optCb])

Update an existing User Group

Kind: instance method of [UsergroupsFacet](#UsergroupsFacet)
See: usergroups.update

Param	Type	Description
usergroup	?	The encoded ID of the User Group to update.
[opts]	Object
opts.name	?	A name for the User Group. Must be unique among User Groups.
opts.handle	?	A mention handle. Must be unique among channels, users and User Groups.
opts.description	?	A short description of the User Group.
opts.channels	?	A comma separated string of encoded channel IDs for which the User Group uses as a default.
opts.include_count	?	Include the number of users in the User Group.
[optCb]	function	Optional callback, if not using promises.