Xlack.Web.Users (xlack v0.1.0) View Source
Link to this section Summary
Functions
Returns a list of all channel-like conversations accessible to the user or app tied to the presented token, as part of Conversations API.
Gets user presence information.
Gets information about a user.
Lists all users in a Xlack team.
Retrieve a single user by looking them up by their registered email address. Requires users:read.email.
Marks a user as active.
Manually sets user presence.
Link to this section Functions
Returns a list of all channel-like conversations accessible to the user or app tied to the presented token, as part of Conversations API.
Optional Params
cursor- Paginate through collections of data by setting the cursor parameter to anext_cursorattribute returned by a previous request'sresponse_metadata. Default value fetches the first "page" of the collection. See pagination for more detail. ex:dXNlcjpVMDYxTkZUVDI=exclude_archived- Set this totrueto exclude archived channels from the list ex:truelimit- The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000. ex:20types- Mix and match channel types by providing a comma-separated list of any combination ofpublic_channel,private_channel,mpim,imex:public_channel,private_channeluser- Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership. ex:W0B2345D
Errors the API can return:
method_not_supported_for_channel_type- This type of conversation cannot be used with this method.
Gets user presence information.
Required Params
user- User to get presence info on. Defaults to the authed user.
Errors the API can return:
Gets information about a user.
Required Params
user- User to get info on
Errors the API can return:
user_not_found- Value passed foruserwas invalid.user_not_visible- The requested user is not visible to the calling user
Lists all users in a Xlack team.
Optional Params
presence- Whether to include presence data in the output ex:1
Retrieve a single user by looking them up by their registered email address. Requires users:read.email.
Required Params
email- User's email address
Errors the API can return:
missing_scope- The token used is not granted the specific scope permissions required to complete this request. Need:users:read.email.user_not_found- Value passed foruserwas invalid.
Marks a user as active.
Errors the API can return:
Manually sets user presence.
Required Params
presence- Eitherautoorawayex:away
Errors the API can return:
invalid_presence- Value passed forpresencewas invalid.