Class User

API User model.

Hierarchy (View Summary)

default<APIUser>
- User
  - ClientUser

Index

Constructors

constructor

new User(client: Client, data: APIUser): User
Parameters
- client: Client
- data: APIUser
Returns User
Overrides Data<APIUser>.constructor
- Defined in packages/foxochat.js/src/models/User.ts:60

Properties

avatar

avatar: null | Avatar

The avatar of the user.

banner: null | Avatar

The banner of the user.

bio

bio: string

The bio of the user.

`Readonly`client

client: Client

The client that instantiated this Model.

createdAt

createdAt: Date

The time when user created at.

displayName

displayName: string

The display name of the user.

flags

flags: UserFlags

The flags of the user.

`Readonly`id

id: number

The id of the model.

status

status: UserStatus

The status of the user.

statusUpdatedAt

statusUpdatedAt: Date

The timestamp when the user's status was last updated.

type

type: UserType

The type of the user.

username

username: string

The username of the user.

Methods

_clone

_clone(): User
Returns User
Inherited from Data._clone
- Defined in packages/foxochat.js/src/models/Base.ts:17

_patch

_patch(data: Partial<APIUser>): void
Parameters
- data: Partial<APIUser>
Returns void
Overrides Data._patch
- Defined in packages/foxochat.js/src/models/User.ts:73

_update

_update(data: Partial<T>): User
Parameters
- data: Partial<T>
Returns User
Inherited from Data._update
- Defined in packages/foxochat.js/src/models/Base.ts:21

fetch

fetch(force?: boolean): Promise<User>
Fetch this user.
Parameters
- force: boolean = true
Returns Promise<User>
- Defined in packages/foxochat.js/src/models/User.ts:69

toJson

toJson(): APIUser
Returns APIUser
Overrides Data.toJson
- Defined in packages/foxochat.js/src/models/User.ts:86

Class User

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns User

Properties

avatar

banner

bio

`Readonly`client

createdAt

displayName

flags

`Readonly`id

status

statusUpdatedAt

type

username

Methods

_clone

Returns User

_patch

Parameters

Returns void

_update

Parameters

Returns User

fetch

Parameters

Returns Promise<User>

toJson

Returns APIUser

Settings

On This Page

Class User

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns User

Properties

avatar

banner

bio

Readonlyclient

createdAt

displayName

flags

Readonlyid

status

statusUpdatedAt

type

username

Methods

_clone

Returns User

_patch

Parameters

Returns void

_update

Parameters

Returns User

fetch

Parameters

Returns Promise<User>

toJson

Returns APIUser

Settings

On This Page

`Readonly`client

`Readonly`id