Represents user information.

Hierarchy

  • User

Properties

alert: number

The number of important notifications that are unread.

  • A numerical indicator is displayed on the channel button to signify this count.
avatarUrl: string

URL representing the user's avatar image.

id: string

Unique identifier for the user.

language: string

The language setting for the user.

  • Utilized for translation purposes.
  • Configurable via the updateUser method or the language boot option.
  • Supports the following 32 languages:
    • 'de'(German), 'hi'(Hindi), 'no'(Norwegian), 'ru'(Russian), 'fi'(Finnish), 'pt'(Portuguese), 'hr'(Croatian), 'fr'(French), 'hu'(Hungarian), 'uk'(Ukrainian), 'sk'(Slovak), 'ca'(Catalan), 'sv'(Swedish), 'ko'(Korean), 'id'(Indonesian), 'ms'(Malay), 'el'(Greek), 'en'(English), 'it'(Italian), 'es'(Spanish), 'he'(Hebrew), 'zh'(Chinese), 'cs'(Czech), 'ar'(Arabic), 'vi'(Vietnamese),'th'(Thai), 'ja'(Japanese), 'pl'(Polish), 'ro'(Romanian), 'da'(Danish), 'nl'(Dutch), 'tr'(Turkish)
memberId: string

Unique identifier for member user.

  • If memberId is specified in the boot option, the user is considered a member.
name?: string

The user's name.

  • Configurable via the updateUser method.
profile?: null | Profile

The user's profile information.

  • Configurable via the updateUser method or the profile boot option.
tags?: null | string[]

An array of tags associated with the user.

  • All tags are in lowercase.
  • Configurable via the updateUser, addTags, or removeTags methods.
unread: number

The total count of unread notifications for the user.

  • If you have 'unread' notifications but no 'alert', a red dot is displayed on the channel button to signify unread messages.
unsubscribeEmail: boolean

Whether the user has opted out of receiving marketing emails.

  • Configurable via the updateUser method or the unsubscribeEmail boot option.
unsubscribeTexting: boolean

Whether the user has opted out of receiving marketing text messages.

  • Configurable via the updateUser method or the unsubscribeTexting boot option.

Generated using TypeDoc