Class ExtendedUser

Hierarchy

User
- ExtendedUser

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ExtendedUser(client: Client, data?: APIUser): ExtendedUser

Inherited from User.constructor
- Defined in src/structures/templates/BaseStructure.ts:16
Parameters
- client: Client
- Optional data: APIUser
Returns ExtendedUser

Properties

avatar

avatar: null | string = null

banner

banner: null | string = null

bot

bot: boolean = false

client

client: Client

discriminator

discriminator: string = '0000'

dm

dm: null | DMChannel = null

email

email: null | string = null

emailVerified

emailVerified: null | boolean = null

flags

flags: UserFlags = ...

id

id: string

locale

locale: null | Locale = null

mfaEnabled

mfaEnabled: null | boolean = null

system

system: boolean = false

username

username: string

Accessors

createdAt

get createdAt(): Date

Inherited from User.createdAt
- Defined in src/structures/templates/BaseStructure.ts:12
Returns Date

createdTimestamp

get createdTimestamp(): number

Inherited from User.createdTimestamp
- Defined in src/structures/templates/BaseStructure.ts:9
Returns number

tag

get tag(): string

Inherited from User.tag
- Defined in src/structures/User.ts:14
Returns string

Methods

_deserialise

_deserialise(data: APIUser): ExtendedUser

Overrides User._deserialise
- Defined in src/structures/ExtendedUser.ts:16
Parameters
- data: APIUser
Returns ExtendedUser

createDM

createDM(cache?: boolean): Promise<DMChannel>

Inherited from User.createDM
- Defined in src/structures/User.ts:45
Parameters
- cache: boolean = false
Returns Promise<DMChannel>

edit

edit(data: Partial<Pick<APIUser, "avatar" | "username">>): Promise<ExtendedUser>

- Defined in src/structures/ExtendedUser.ts:28
Parameters
- data: Partial<Pick<APIUser, "avatar" | "username">>
Returns Promise<ExtendedUser>

fetch

fetch(): Promise<ExtendedUser>

Inherited from User.fetch
- Defined in src/structures/User.ts:41
Returns Promise<ExtendedUser>

send

send(content: string | MessagePayload): Promise<Message<TextChannel>>

Inherited from User.send
- Defined in src/structures/User.ts:49
Parameters
- content: string | MessagePayload
Returns Promise<Message<TextChannel>>

setAvatar

setAvatar(avatar: null | FileResolvable): Promise<ExtendedUser>

- Defined in src/structures/ExtendedUser.ts:41
Parameters
- avatar: null | FileResolvable
Returns Promise<ExtendedUser>

setUsername

setUsername(username: string): Promise<ExtendedUser>

- Defined in src/structures/ExtendedUser.ts:37
Parameters
- username: string
Returns Promise<ExtendedUser>

toJSON

toJSON(): APIUser

Overrides User.toJSON
- Defined in src/structures/ExtendedUser.ts:47
Returns APIUser

toString

toString(): string

Inherited from User.toString
- Defined in src/structures/User.ts:37
Returns string

Static toJSON

toJSON(data: any): any

Inherited from User.toJSON
- Defined in src/structures/templates/BaseStructure.ts:32
Parameters
- data: any
Returns any

Generated using TypeDoc