Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientUser

Extends a regular User, but email is available.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new ClientUser(avatar: null | FileInformation, displayName: string, username: string, description: string, verified: boolean, email: string): ClientUser

Properties

Private #avatar

#avatar: null | FileInformation

Private #description

#description: string

Private #displayName

#displayName: string

Private #email

#email: string

Private #username

#username: string

Private #verified

#verified: boolean

Accessors

avatar

description

  • get description(): string

  • Description of the user. Up to 2048 characters in length, may be empty.

    Returns string

displayName

  • get displayName(): string

  • Display name of the user. May be any Unicode sequence up to 50 characters total.

    Returns string

email

  • get email(): string

username

  • get username(): string

  • Username of the user. Alphanumeric, from 3 up to 50 characters total.

    Returns string

verified

  • get verified(): boolean

  • Boolean value that is true if the user is marked as a verified user.

    Returns boolean

Methods

Protected currentAvatar

Protected updateAvatar

Generated using TypeDoc