Class User

Hierarchy

User

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new User(client: Client, data: User): User

- Defined in src/maps/Users.ts:50
Parameters
- client: Client
- data: User
Returns User

Properties

_id

_id: string

avatar

avatar: Nullable<Attachment>

badges

badges: Nullable<number>

bot

bot: Nullable<BotInformation>

client

client: Client

flags

flags: Nullable<number>

online

online: Nullable<boolean>

relationship

relationship: Nullable<RelationshipStatus>

status

status: Nullable<Status>

username

username: string

Accessors

createdAt

get createdAt(): number

- Defined in src/maps/Users.ts:46
Get timestamp when this user was created.

Returns number

defaultAvatarURL

get defaultAvatarURL(): string

- Defined in src/maps/Users.ts:186
Get the default avatar URL of a user

Returns string

permission

get permission(): number

- Defined in src/maps/Users.ts:197
Returns number

Methods

addFriend

addFriend(): Promise<void>

- Defined in src/maps/Users.ts:124
Send a friend request to a user

Returns Promise<void>

blockUser

blockUser(): Promise<void>

- Defined in src/maps/Users.ts:144
Block a user

Returns Promise<void>

fetchMutual

fetchMutual(): Promise<{ servers: string[]; users: string[] }>

- Defined in src/maps/Users.ts:176
Fetch the mutual connections of the current user and a target user

Returns Promise<{ servers: string[]; users: string[] }>

The mutual connections of the current user and a target user

fetchProfile

fetchProfile(): Promise<Profile>

- Defined in src/maps/Users.ts:165
Fetch the profile of a user

Returns Promise<Profile>

The profile of the user

generateAvatarURL

generateAvatarURL(...args: FileArgs): string

- Defined in src/maps/Users.ts:190
Parameters
- Rest ...args: FileArgs
Returns string

openDM

openDM(): Promise<Channel>

- Defined in src/maps/Users.ts:113
Open a DM with a user

Returns Promise<Channel>

DM Channel

removeFriend

removeFriend(): Promise<void>

- Defined in src/maps/Users.ts:134
Remove a user from the friend list

Returns Promise<void>

unblockUser

unblockUser(): Promise<void>

- Defined in src/maps/Users.ts:154
Unblock a user

Returns Promise<void>

update

update(data: Partial<User>, clear?: RemoveUserField): void

- Defined in src/maps/Users.ts:70
Parameters
- data: Partial<User>
- Optional clear: RemoveUserField
Returns void

Generated using TypeDoc