Class User

User Class

Hierarchy

User

Index

Constructors

constructor

new User(collection: UserCollection, id: string): User
Construct User
Parameters
- collection: UserCollection
  
  Collection
- id: string
  
  Id
Returns User
- Defined in src/classes/User.ts:19

Properties

`Private` `Readonly` #collection

#collection: UserCollection

`Readonly` id

id: string

Accessors

$exists

get $exists(): boolean
Whether this object exists

Returns boolean
- Defined in src/classes/User.ts:35

animatedAvatarURL

get animatedAvatarURL(): string
URL to the user's animated avatar

Returns string
- Defined in src/classes/User.ts:154

avatar

get avatar(): undefined | File
Avatar

Returns undefined | File
- Defined in src/classes/User.ts:73

avatarURL

get avatarURL(): string
URL to the user's avatar

Returns string
- Defined in src/classes/User.ts:145

badges

get badges(): UserBadges
Badges

Returns UserBadges
- Defined in src/classes/User.ts:80

bot

get bot(): undefined | {
owner: string;
}
Bot information

Returns undefined | {
owner: string;
}
- Defined in src/classes/User.ts:122

createdAt

get createdAt(): Date
Time when this user created their account

Returns Date
- Defined in src/classes/User.ts:42

defaultAvatarURL

get defaultAvatarURL(): string
URL to the user's default avatar

Returns string
- Defined in src/classes/User.ts:136

discriminator

get discriminator(): string
Discriminator

Returns string
- Defined in src/classes/User.ts:56

displayName

get displayName(): string
Display Name

Returns string
- Defined in src/classes/User.ts:63

flags

get flags(): UserFlags
Flags

Returns UserFlags
- Defined in src/classes/User.ts:115

online

get online(): boolean
Whether the user is online

Returns boolean
- Defined in src/classes/User.ts:101

permission

get permission(): number
Permissions against this user

Returns number
- Defined in src/classes/User.ts:183

presence

get presence(): "Online" | "Idle" | "Focus" | "Busy" | "Invisible"
Presence

Returns "Online" | "Idle" | "Focus" | "Busy" | "Invisible"
- Defined in src/classes/User.ts:164

privileged

get privileged(): boolean
Whether the user is privileged

Returns boolean
- Defined in src/classes/User.ts:108

relationship

get relationship(): "None" | "User" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"
Relationship with user

Returns "None" | "User" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"
- Defined in src/classes/User.ts:94

self

get self(): boolean
Whether this user is ourselves

Returns boolean
- Defined in src/classes/User.ts:129

status

get status(): undefined | {
presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
text?: null | string;
}
User Status

Returns undefined | {
presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
text?: null | string;
}
- Defined in src/classes/User.ts:87

username

get username(): string
Username

Returns string
- Defined in src/classes/User.ts:49

Methods

addFriend

addFriend(): Promise<User>
Send a friend request to a user

Returns Promise<User>
- Defined in src/classes/User.ts:273

blockUser

blockUser(): Promise<void>
Block a user

Returns Promise<void>
- Defined in src/classes/User.ts:291

changeUsername

changeUsername(username: string, password: string): Promise<{
    _id: string;
    avatar?: null | {
        _id: string;
        content_type: string;
        deleted?: null | boolean;
        filename: string;
        message_id?: null | string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: null | string;
        reported?: null | boolean;
        server_id?: null | string;
        size: number;
        tag: string;
        user_id?: null | string;
    };
    badges?: null | number;
    bot?: null | {
        owner: string;
    };
    discriminator: string;
    display_name?: null | string;
    flags?: null | number;
    online?: null | boolean;
    privileged?: boolean;
    profile?: null | {
        background?: null | {
            _id: string;
            content_type: string;
            deleted?: null | boolean;
            filename: string;
            message_id?: null | string;
            metadata: {
                type: "File";
            } | {
                type: "Text";
            } | {
                height: number;
                type: "Image";
                width: number;
            } | {
                height: number;
                type: "Video";
                width: number;
            } | {
                type: "Audio";
            };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        };
        content?: null | string;
    };
    relations?: null | {
        _id: string;
        status: "None" | "User" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther";
    }[];
    relationship?: null | "None" | "User" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther";
    status?: null | {
        presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
        text?: null | string;
    };
    username: string;
}>
Change the username of the current user
Parameters
- username: string
  
  New username
- password: string
  
  Current password
Returns Promise<{
    _id: string;
    avatar?: null | {
        _id: string;
        content_type: string;
        deleted?: null | boolean;
        filename: string;
        message_id?: null | string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: null | string;
        reported?: null | boolean;
        server_id?: null | string;
        size: number;
        tag: string;
        user_id?: null | string;
    };
    badges?: null | number;
    bot?: null | {
        owner: string;
    };
    discriminator: string;
    display_name?: null | string;
    flags?: null | number;
    online?: null | boolean;
    privileged?: boolean;
    profile?: null | {
        background?: null | {
            _id: string;
            content_type: string;
            deleted?: null | boolean;
            filename: string;
            message_id?: null | string;
            metadata: {
                type: "File";
            } | {
                type: "Text";
            } | {
                height: number;
                type: "Image";
                width: number;
            } | {
                height: number;
                type: "Video";
                width: number;
            } | {
                type: "Audio";
            };
            object_id?: null | string;
            reported?: null | boolean;
            server_id?: null | string;
            size: number;
            tag: string;
            user_id?: null | string;
        };
        content?: null | string;
    };
    relations?: null | {
        _id: string;
        status: "None" | "User" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther";
    }[];
    relationship?: null | "None" | "User" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther";
    status?: null | {
        presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
        text?: null | string;
    };
    username: string;
}>
- Defined in src/classes/User.ts:235

edit

edit(data: {
    avatar?: null | string;
    badges?: null | number;
    display_name?: null | string;
    flags?: null | number;
    profile?: null | {
        background?: null | string;
        content?: null | string;
    };
    remove?: null | ("Avatar" | "StatusText" | "StatusPresence" | "ProfileContent" | "ProfileBackground" | "DisplayName")[];
    status?: null | {
        presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
        text?: null | string;
    };
}): Promise<void>
Edit the user
Parameters
- data: {
      avatar?: null | string;
      badges?: null | number;
      display_name?: null | string;
      flags?: null | number;
      profile?: null | {
          background?: null | string;
          content?: null | string;
      };
      remove?: null | ("Avatar" | "StatusText" | "StatusPresence" | "ProfileContent" | "ProfileBackground" | "DisplayName")[];
      status?: null | {
          presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
          text?: null | string;
      };
  }
  
  Changes
  - Optional avatar?: null | string
    
    Description
    Attachment Id for avatar
  - Optional badges?: null | number
    
    Format: int32
    
    Description
    Bitfield of user badges
  - Optional display_name?: null | string
    
    Description
    New display name
  - Optional flags?: null | number
    
    Format: int32
    
    Description
    Enum of user flags
  - Optional profile?: null | {
    background?: null | string;
    content?: null | string;
    }
    
    Description
    New user profile data
    
    This is applied as a partial.
  - Optional remove?: null | ("Avatar" | "StatusText" | "StatusPresence" | "ProfileContent" | "ProfileBackground" | "DisplayName")[]
    
    Description
    Fields to remove from user object
  - Optional status?: null | {
    presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
    text?: null | string;
    }
    
    Description
    New user status
Returns Promise<void>
- Defined in src/classes/User.ts:221

fetchMutual

fetchMutual(): Promise<{
servers: string[];
users: string[];
}>
Fetch the mutual connections of the current user and a target user

Returns
The mutual connections of the current user and a target user

Returns Promise<{
servers: string[];
users: string[];
}>
- Defined in src/classes/User.ts:316

fetchProfile

fetchProfile(): Promise<{
    background?: null | {
        _id: string;
        content_type: string;
        deleted?: null | boolean;
        filename: string;
        message_id?: null | string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: null | string;
        reported?: null | boolean;
        server_id?: null | string;
        size: number;
        tag: string;
        user_id?: null | string;
    };
    content?: null | string;
}>
Fetch the profile of a user

Returns
The profile of the user

Returns Promise<{
    background?: null | {
        _id: string;
        content_type: string;
        deleted?: null | boolean;
        filename: string;
        message_id?: null | string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: null | string;
        reported?: null | boolean;
        server_id?: null | string;
        size: number;
        tag: string;
        user_id?: null | string;
    };
    content?: null | string;
}>
- Defined in src/classes/User.ts:306

openDM

openDM(): Promise<Channel>
Open a DM with a user

Returns
DM Channel

Returns Promise<Channel>
- Defined in src/classes/User.ts:246

removeFriend

removeFriend(): Promise<void>
Remove a user from the friend list

Returns Promise<void>
- Defined in src/classes/User.ts:284

statusMessage

statusMessage(translate?: ((presence: "Online" | "Idle" | "Focus" | "Busy" | "Invisible") => string)): undefined | string
Generate status message

Returns
Status message
Parameters
- translate: ((presence: "Online" | "Idle" | "Focus" | "Busy" | "Invisible") => string) = ...
  
  Translation function
  - - (presence: "Online" | "Idle" | "Focus" | "Busy" | "Invisible"): string
    - Parameters
      
      presence: "Online" | "Idle" | "Focus" | "Busy" | "Invisible"
      
      Returns string
Returns undefined | string
- Defined in src/classes/User.ts:173

toString

toString(): string
Write to string as a user mention

Returns
Formatted String

Returns string
- Defined in src/classes/User.ts:28

unblockUser

unblockUser(): Promise<void>
Unblock a user

Returns Promise<void>
- Defined in src/classes/User.ts:298

Class User

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

collection: UserCollection

id: string

Returns User

Properties

Private Readonly #collection

Readonly id

Accessors

$exists

Returns boolean

animatedAvatarURL

Returns string

avatar

Returns undefined | File

avatarURL

Returns string

badges

Returns UserBadges

bot

Returns undefined | { owner: string; }

createdAt

Returns Date

defaultAvatarURL

Returns string

discriminator

Returns string

displayName

Returns string

flags

Returns UserFlags

online

Returns boolean

permission

Returns number

presence

Returns "Online" | "Idle" | "Focus" | "Busy" | "Invisible"

privileged

Returns boolean

relationship

Returns "None" | "User" | "Friend" | "Outgoing" | "Incoming" | "Blocked" | "BlockedOther"

self

Returns boolean

status

Returns undefined | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string; }

username

Returns string

Methods

addFriend

Returns Promise<User>

blockUser

Returns Promise<void>

changeUsername

Parameters

username: string

password: string

edit

Parameters

Optional avatar?: null | string

Description

Optional badges?: null | number

Description

Optional display_name?: null | string

Description

Optional flags?: null | number

Description

Optional profile?: null | { background?: null | string; content?: null | string; }

Description

Optional remove?: null | ("Avatar" | "StatusText" | "StatusPresence" | "ProfileContent" | "ProfileBackground" | "DisplayName")[]

Description

Optional status?: null | { presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible"; text?: null | string; }

Description

`Private` `Readonly` #collection

`Readonly` id

Returns undefined | {
owner: string;
}

Returns undefined | {
presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
text?: null | string;
}

`Optional` avatar?: null | string

`Optional` badges?: null | number

`Optional` display_name?: null | string

`Optional` flags?: null | number

`Optional` profile?: null | {
background?: null | string;
content?: null | string;
}

`Optional` remove?: null | ("Avatar" | "StatusText" | "StatusPresence" | "ProfileContent" | "ProfileBackground" | "DisplayName")[]

`Optional` status?: null | {
presence?: null | "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
text?: null | string;
}

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