ClassUser

Description

Represents a user.

Hierarchy (view full)

Properties

connectionStatus friendDiscoveryKey friendName isActive lastSeenAt metaData nickname plainProfileUrl preferredLanguages requireAuth userId

Accessors

profileUrl

Methods

createMetaData deleteAllMetaData deleteMetaData serialize updateMetaData

Properties

connectionStatus

connectionStatus: UserOnlineState

User connection status.

friendDiscoveryKey

friendDiscoveryKey: null | string

Represents friend discovery key.

friendName

friendName: null | string

The friend name.

isActive

isActive: boolean

Whether the user is active.

lastSeenAt

lastSeenAt: null | number

The time this User has been last seen at. Zero if this User is online.

metaData

metaData: object

All meta data of the user.

nickname

nickname: string

The nickname of the user.

plainProfileUrl

plainProfileUrl: string

The plain profile image URL, which does not contain sendbirdChat.eKey as a parameter. If the file encryption feature is enabled, accessing this plainProfileUrl will be denied.

preferredLanguages

preferredLanguages: null | string[]

The preferred languages of the user.

ReadonlyrequireAuth

requireAuth: boolean

ReadonlyuserId

userId: string

The ID of the user.

Accessors

profileUrl

  • get profileUrl(): string

  • Returns string

    Description

    The profile image URL. If the file encryption feature is enabled, this will have sendbirdChat.eKey combined with the plainProfileUrl so the file can be accessed. For caching the file, it is recommended to use plainProfileUrl as the key of the file cache.

Methods

createMetaData

  • createMetaData(input): Promise<object>

  • Parameters

    Returns Promise<object>

    Description

    Creates meta data. This can be used to customize the user.

deleteAllMetaData

  • deleteAllMetaData(): Promise<void>

  • Returns Promise<void>

    Description

    Deletes all meta data.

deleteMetaData

  • deleteMetaData(metadataKey): Promise<object>

  • Parameters

    • metadataKey: string

    Returns Promise<object>

    Description

    Deletes a meta data.

serialize

  • serialize(): object

  • Returns object

    Description

    Serializes the User instance. The instance can be restored by sendbirdChat.buildUserFromSerializedData().

updateMetaData

  • updateMetaData(input, upsert?): Promise<object>

  • Parameters

    Returns Promise<object>

    Description

    Updates meta data.

Settings

Member Visibility

On This Page

Properties
Accessors
Methods