Class ClientUser

The base of all structures in this library. All structures that have an ID will extend this class.

Hierarchy

User
- ClientUser

Index

Constructors

constructor

new ClientUser(client, data): ClientUser
Parameters
- client: Client
- data: {} & {
  botId: string;
  createdBy: string;
  }
Returns ClientUser
Overrides User.constructor
- Defined in guilded.js/lib/structures/User.ts:55

Properties

`Readonly` _createdAt

_createdAt: null | number

When this user was created

avatar

avatar: null | string = null

The avatar image associated with this user

banner

banner: null | string = null

The banner image associated with this user

`Readonly` botId

botId: string

`Readonly` client

client: Client

`Readonly` createdBy

createdBy: string

id

id: string

Identifier of this structrure

name

name: string

The name for this user

raw

raw: UserPayload

Bare data of this structure

`Readonly` type

type: UserType

The type of this user

Accessors

createdAt

get createdAt(): null | Date
Returns null | Date
Inherited from User.createdAt
- Defined in guilded.js/lib/structures/User.ts:31

Methods

_clone

_clone(): ClientUser
Taken from https://github.com/discordjs/discord.js/blob/8e8d9b490a71de6cabe6f16375d7549a7c5c3737/src/structures/Base.js#L20 Licensed under the Apache License 2.0 https://github.com/discordjs/discord.js/blob/8e8d9b490a71de6cabe6f16375d7549a7c5c3737/LICENSE

Returns ClientUser
Inherited from User._clone
- Defined in guilded.js/lib/structures/Base.ts:28

_update

_update(data): ClientUser
Parameters
- data: Partial<UserPayload>
Returns ClientUser
Inherited from User._update
- Defined in guilded.js/lib/structures/User.ts:35

fetch

fetch(): Promise<User>
Returns Promise<User>
- Defined in guilded.js/lib/structures/User.ts:70

Class ClientUser

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

data: {} & {
botId: string;
createdBy: string;
}

Returns ClientUser

Properties

`Readonly` _createdAt

avatar

banner

`Readonly` botId

`Readonly` client

`Readonly` createdBy

id

name

raw

`Readonly` type

Accessors

createdAt

Returns null | Date

Methods

_clone

Returns ClientUser

_update

Parameters

data: Partial<UserPayload>

Returns ClientUser

fetch

Returns Promise<User>

Settings

Member Visibility

Theme

On This Page

Class ClientUser

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

data: {} & { botId: string; createdBy: string; }

Returns ClientUser

Properties

Readonly _createdAt

avatar

banner

Readonly botId

Readonly client

Readonly createdBy

id

name

raw

Readonly type

Accessors

createdAt

Returns null | Date

Methods

_clone

Returns ClientUser

_update

Parameters

data: Partial<UserPayload>

Returns ClientUser

fetch

Returns Promise<User>

Settings

Member Visibility

Theme

On This Page

data: {} & {
botId: string;
createdBy: string;
}

`Readonly` _createdAt

`Readonly` botId

`Readonly` client

`Readonly` createdBy

`Readonly` type