User object

User represents a single user in a chat.

Properties

User has the following properties:

1class User {
2    id: string,
3    name?: string,
4    externalId?: string,
5    profileUrl?: string,
6    email?: string,
7    custom?: ObjectCustom,
8    status?: string,
9    type?: string,
10    updated?: string,
11    lastActiveTimestamp?: number
12}

Parameter	Description
id Type: string	Unique ID of the user.
name Type: string or undefined	Display name or username of the user (must not be empty or consist only of whitespace characters).
externalId Type: string or undefined	Identifier for the user from an external system, such as a third-party authentication provider or a user directory.
profileUrl Type: string or undefined	URL to the user's profile or avatar image.
email Type: string or undefined	User's email address.
custom Type: ObjectCustom or undefined	Any custom properties or metadata associated with the user in the form of a JSON. Values must be scalar only; arrays or objects are not supported. App Context filtering language doesn't support filtering by custom properties.
status Type: string or undefined	Current status of the user, like online, offline, or away.
type Type: string or undefined	Type of the user, like admin, member, guest.
updated Type: string or undefined	Timestamp (a number of seconds since January 1, 1970) for the last time the user information was updated or modified.
lastActiveTimestamp Type: number or undefined	Timestamp for the last time the user was active in a chat app.

API limits

To learn about the maximum length of parameters used to set user metadata, refer to REST API docs.

Methods

Available methods:

• (getter) active
• delete()
• getChannelRestrictions()
• getChannelsRestrictions()
• getMemberships()
• isPresentOn()
• setRestrictions()
• streamUpdates()
• (static) streamUpdatesOn()
• update()
• wherePresent()

Use case

User methods enable:

• Creating and managing users
• Configuring channel memberships
• Mentioning others in conversations
• Checking user presence status