Class User

A GIFBox user.

Hierarchy

User
- ClientUser

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new User(avatar: null | FileInformation, displayName: string, username: string, description: string, verified: boolean): User

- Defined in classes/User.ts:11
Parameters
- avatar: null | FileInformation
- displayName: string
- username: string
- description: string
- verified: boolean
Returns User

Properties

Private #avatar

#avatar: null | FileInformation

Private #description

#description: string

Private #displayName

#displayName: string

Private #username

#username: string

Private #verified

#verified: boolean

Accessors

avatar

get avatar(): null | FileInformation

- Defined in classes/User.ts:26
FileInformation of the user's avatar. May be null.

Returns null | FileInformation

description

get description(): string

- Defined in classes/User.ts:49
Description of the user. Up to 2048 characters in length, may be empty.

Returns string

displayName

get displayName(): string

- Defined in classes/User.ts:39
Display name of the user. May be any Unicode sequence up to 50 characters total.

Returns string

username

get username(): string

- Defined in classes/User.ts:44
Username of the user. Alphanumeric, from 3 up to 50 characters total.

Returns string

verified

get verified(): boolean

- Defined in classes/User.ts:54
Boolean value that is true if the user is marked as a verified user.

Returns boolean

Methods

Protected currentAvatar

currentAvatar(): null | FileInformation

- Defined in classes/User.ts:34
Returns null | FileInformation

Protected updateAvatar

updateAvatar(val: null | FileInformation): void

- Defined in classes/User.ts:30
Parameters
- val: null | FileInformation
Returns void

Generated using TypeDoc