UsersFacet

Kind: global class

• UsersFacet
  • .getPresence(user, [optCb])
  • .identity([options], [optCb])
  • .info(user, [optCb])
  • .list([opts], [optCb])
  • .setActive([optCb])
  • .setPresence(presence, [optCb])

usersFacet.getPresence(user, [optCb])

Gets user presence information.

Kind: instance method of [UsersFacet](#UsersFacet)
See: users.getPresence

Param	Type	Description
user	?	User to get presence info on. Defaults to the authed user.
[optCb]	function	Optional callback, if not using promises.

usersFacet.identity([options], [optCb])

Get a user’s identity.

Kind: instance method of [UsersFacet](#UsersFacet)
See: users.identity

Param	Type	Description
[options]	Object
opts.user	?	When calling this method with a workspace token, set this to the user ID of the user to retrieve the identity of
[optCb]	function	Optional callback, if not using promises.

usersFacet.info(user, [optCb])

Gets information about a user.

Kind: instance method of [UsersFacet](#UsersFacet)
See: users.info

Param	Type	Description
user	?	User to get info on
[optCb]	function	Optional callback, if not using promises.

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

Lists all users in a Slack team.

Kind: instance method of [UsersFacet](#UsersFacet)
See: users.list

Param	Type	Description
[opts]	Object
opts.presence	?	Whether to include presence data in the output
opts.include_locale	?	Set this to true to receive the locale for users. Defaults to false
[optCb]	function	Optional callback, if not using promises.

usersFacet.setActive([optCb])

Marks a user as active.

Kind: instance method of [UsersFacet](#UsersFacet)
See: users.setActive

Param	Type	Description
[optCb]	function	Optional callback, if not using promises.

usersFacet.setPresence(presence, [optCb])

Manually sets user presence.

Kind: instance method of [UsersFacet](#UsersFacet)
See: users.setPresence

Param	Type	Description
presence	?	Either auto or away
[optCb]	function	Optional callback, if not using promises.