Class User

Hierarchy

BaseObject<API.User>
- User

Index

Constructors

Properties

Accessors

_id avatar badges bot createdAt defaultAvatarURL discriminator displayName flags id online permissionsAgainst presence privileged relationship source status tag username

Methods

addFriend block fetchMutual fetchProfile fireUpdate generateAvatarURL offUpdate onUpdate openDM removeFriend toString unblock update

Constructors

constructor

new User(client: Client, data: {
    _id: string;
    avatar?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    badges?: number;
    bot?: {
        owner: string;
    };
    discriminator: string;
    display_name?: string;
    flags?: number;
    online?: boolean;
    privileged?: boolean;
    profile?: {
        background?: {
            _id: string;
            content_type: string;
            deleted?: boolean;
            filename: string;
            message_id?: string;
            metadata: {
                type: "File";
            } | {
                type: "Text";
            } | {
                height: number;
                type: "Image";
                width: number;
            } | {
                height: number;
                type: "Video";
                width: number;
            } | {
                type: "Audio";
            };
            object_id?: string;
            reported?: boolean;
            server_id?: string;
            size: number;
            tag: string;
            user_id?: string;
        };
        content?: string;
    };
    relations?: {
        _id: string;
        status: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther";
    }[];
    relationship?: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther";
    status?: {
        presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
        text?: string;
    };
    username: string;
}): User
Parameters
- client: Client
- data: {
      _id: string;
      avatar?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      badges?: number;
      bot?: {
          owner: string;
      };
      discriminator: string;
      display_name?: string;
      flags?: number;
      online?: boolean;
      privileged?: boolean;
      profile?: {
          background?: {
              _id: string;
              content_type: string;
              deleted?: boolean;
              filename: string;
              message_id?: string;
              metadata: {
                  type: "File";
              } | {
                  type: "Text";
              } | {
                  height: number;
                  type: "Image";
                  width: number;
              } | {
                  height: number;
                  type: "Video";
                  width: number;
              } | {
                  type: "Audio";
              };
              object_id?: string;
              reported?: boolean;
              server_id?: string;
              size: number;
              tag: string;
              user_id?: string;
          };
          content?: string;
      };
      relations?: {
          _id: string;
          status: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther";
      }[];
      relationship?: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther";
      status?: {
          presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
          text?: string;
      };
      username: string;
  }
  - _id: string
    
    Description
    Unique Id
  - Optional avatar?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    }
    
    Description
    Avatar attachment
    - _id: string
      
      Description
      Unique Id
    - content_type: string
      
      Description
      Raw content type of this file
    - Optional deleted?: boolean
      
      Description
      Whether this file was deleted
    - filename: string
      
      Description
      Original filename
    - Optional message_id?: string
    - metadata: {
          type: "File";
      } | {
          type: "Text";
      } | {
          height: number;
          type: "Image";
          width: number;
      } | {
          height: number;
          type: "Video";
          width: number;
      } | {
          type: "Audio";
      }
      
      Description
      Parsed metadata of this file
    - Optional object_id?: string
      
      Description
      Id of the object this file is associated with
    - Optional reported?: boolean
      
      Description
      Whether this file was reported
    - Optional server_id?: string
    - size: number
      
      Format: int
      
      Description
      Size of this file (in bytes)
    - tag: string
      
      Description
      Tag / bucket this file was uploaded to
    - Optional user_id?: string
  - Optional badges?: number
    
    Format: int32
    
    Description
    Bitfield of user badges
  - Optional bot?: {
    owner: string;
    }
    
    Description
    Bot information
    - owner: string
      
      Description
      Id of the owner of this bot
  - discriminator: string
    
    Description
    Discriminator
  - Optional display_name?: string
    
    Description
    Display name
  - Optional flags?: number
    
    Format: int32
    
    Description
    Enum of user flags
  - Optional online?: boolean
    
    Description
    Whether this user is currently online
  - Optional privileged?: boolean
    
    Description
    Whether this user is privileged
  - Optional profile?: {
        background?: {
            _id: string;
            content_type: string;
            deleted?: boolean;
            filename: string;
            message_id?: string;
            metadata: {
                type: "File";
            } | {
                type: "Text";
            } | {
                height: number;
                type: "Image";
                width: number;
            } | {
                height: number;
                type: "Video";
                width: number;
            } | {
                type: "Audio";
            };
            object_id?: string;
            reported?: boolean;
            server_id?: string;
            size: number;
            tag: string;
            user_id?: string;
        };
        content?: string;
    }
    
    Description
    User's profile page
    - Optional background?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      }
      
      Description
      Background visible on user's profile
      
      _id: string
      
      Description
      Unique Id
      
      content_type: string
      
      Description
      Raw content type of this file
      
      Optional deleted?: boolean
      
      Description
      Whether this file was deleted
      
      filename: string
      
      Description
      Original filename
      
      Optional message_id?: string
      
      metadata: {
          type: "File";
      } | {
          type: "Text";
      } | {
          height: number;
          type: "Image";
          width: number;
      } | {
          height: number;
          type: "Video";
          width: number;
      } | {
          type: "Audio";
      }
      
      Description
      Parsed metadata of this file
      
      Optional object_id?: string
      
      Description
      Id of the object this file is associated with
      
      Optional reported?: boolean
      
      Description
      Whether this file was reported
      
      Optional server_id?: string
      
      size: number
      
      Format: int
      
      Description
      Size of this file (in bytes)
      
      tag: string
      
      Description
      Tag / bucket this file was uploaded to
      
      Optional user_id?: string
    - Optional content?: string
      
      Description
      Text content on user's profile
  - Optional relations?: {
    _id: string;
    status: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther";
    }[]
    
    Description
    Relationships with other users
  - Optional relationship?: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther"
    
    Description
    Current session user's relationship with this user
  - Optional status?: {
    presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
    text?: string;
    }
    
    Description
    User's current status
    - Optional presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible"
      
      Description
      Current presence option
    - Optional text?: string
      
      Description
      Custom status text
  - username: string
    
    Description
    Username
Returns User
Overrides BaseObject.constructor
- Defined in core/src/objects/User.ts:33

Properties

client

client: Client

deleted

deleted: boolean = false

Accessors

`Protected` _id

get _id(): ""
Returns ""
Inherited from BaseObject._id
- Defined in core/src/objects/BaseObject.ts:10

avatar

get avatar(): Attachment
Returns Attachment
- Defined in core/src/objects/User.ts:69

badges

get badges(): UserBadges
Returns UserBadges
- Defined in core/src/objects/User.ts:62

bot

get bot(): Bot
If this user is a bot, their bot information.

Returns Bot
- Defined in core/src/objects/User.ts:53

createdAt

get createdAt(): number
Returns number
Inherited from BaseObject.createdAt
- Defined in core/src/objects/BaseObject.ts:19

defaultAvatarURL

get defaultAvatarURL(): string
Returns string
- Defined in core/src/objects/User.ts:72

discriminator

get discriminator(): string
Four-digit discrimator for this user.

Returns string
- Defined in core/src/objects/User.ts:41

displayName

get displayName(): string
This user's display name. (if any)

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

flags

get flags(): UserFlags
Returns UserFlags
- Defined in core/src/objects/User.ts:65

id

get id(): string
Returns string
Inherited from BaseObject.id
- Defined in core/src/objects/BaseObject.ts:16

online

get online(): boolean
Returns boolean
- Defined in core/src/objects/User.ts:56

permissionsAgainst

get permissionsAgainst(): UserPermissionFlags
Returns UserPermissionFlags
- Defined in core/src/objects/User.ts:143

presence

get presence(): "Online" | "Idle" | "Focus" | "Busy" | "Invisible"
Returns "Online" | "Idle" | "Focus" | "Busy" | "Invisible"
- Defined in core/src/objects/User.ts:86

privileged

get privileged(): boolean
Returns boolean
- Defined in core/src/objects/User.ts:59

relationship

get relationship(): RelationshipStatus
Returns RelationshipStatus
- Defined in core/src/objects/User.ts:80

source

get source(): APIType
Original API object.

Returns APIType
Inherited from BaseObject.source
- Defined in core/src/objects/BaseObject.ts:7

status

get status(): string
Returns string
- Defined in core/src/objects/User.ts:83

username

get username(): string
Username for this user.

Returns string
- Defined in core/src/objects/User.ts:37

Methods

addFriend

addFriend(): Promise<void>
Send this user a friend request.

Returns Promise<void>
- Defined in core/src/objects/User.ts:91

block

block(): Promise<void>
Block this user.

Returns Promise<void>
- Defined in core/src/objects/User.ts:103

fetchMutual

fetchMutual(): Promise<UserMutuals>
Fetch your mutual friends/servers with this user.

Returns Promise<UserMutuals>
- Defined in core/src/objects/User.ts:135

fetchProfile

fetchProfile(): Promise<UserProfile>
Fetch this user's profile information.

Returns Promise<UserProfile>
- Defined in core/src/objects/User.ts:121

fireUpdate

fireUpdate(updated?: any[]): void
Runs all of the callbacks for this emitter. (meant to run when an update occurs)
Parameters
- Optional updated: any[]
  
  The objects that caused this update.
Returns void
Inherited from BaseObject.fireUpdate
- Defined in core/src/utils/MiniEmitter.ts:33

generateAvatarURL

generateAvatarURL(...args: AttachmentArgs): string
Parameters
- Rest ...args: AttachmentArgs
Returns string
- Defined in core/src/objects/User.ts:75

offUpdate

offUpdate(callback: MiniEmitterCallback<any>): User
Stops listening for Map updates.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<any>
  
  The callback to stop listening for updates on.
Returns User
Inherited from BaseObject.offUpdate
- Defined in core/src/utils/MiniEmitter.ts:24

onUpdate

onUpdate(callback: MiniEmitterCallback<any>): User
Listen for an update to this Map.

Returns
this, useful for chaining.
Parameters
- callback: MiniEmitterCallback<any>
  
  The callback to run when an update occurs.
Returns User
Inherited from BaseObject.onUpdate
- Defined in core/src/utils/MiniEmitter.ts:15

openDM

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

Returns Promise<Channel>
- Defined in core/src/objects/User.ts:111

removeFriend

removeFriend(): Promise<void>
Unfriend this user.

Returns Promise<void>
- Defined in core/src/objects/User.ts:99

toString

toString(): string
Returns
The user formatted for markdown. <@id>

Returns string
Overrides BaseObject.toString
- Defined in core/src/objects/User.ts:176

unblock

unblock(): Promise<void>
Unblock this user.

Returns Promise<void>
- Defined in core/src/objects/User.ts:107

update

update(data?: Partial<{
    _id: string;
    avatar?: {
        _id: string;
        content_type: string;
        deleted?: boolean;
        filename: string;
        message_id?: string;
        metadata: {
            type: "File";
        } | {
            type: "Text";
        } | {
            height: number;
            type: "Image";
            width: number;
        } | {
            height: number;
            type: "Video";
            width: number;
        } | {
            type: "Audio";
        };
        object_id?: string;
        reported?: boolean;
        server_id?: string;
        size: number;
        tag: string;
        user_id?: string;
    };
    badges?: number;
    bot?: {
        owner: string;
    };
    discriminator: string;
    display_name?: string;
    flags?: number;
    online?: boolean;
    privileged?: boolean;
    profile?: {
        background?: {
            _id: string;
            content_type: string;
            deleted?: boolean;
            filename: string;
            message_id?: string;
            metadata: {
                type: "File";
            } | {
                type: "Text";
            } | {
                height: number;
                type: "Image";
                width: number;
            } | {
                height: number;
                type: "Video";
                width: number;
            } | {
                type: "Audio";
            };
            object_id?: string;
            reported?: boolean;
            server_id?: string;
            size: number;
            tag: string;
            user_id?: string;
        };
        content?: string;
    };
    relations?: {
        _id: string;
        status: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther";
    }[];
    relationship?: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther";
    status?: {
        presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
        text?: string;
    };
    username: string;
}>): User
Update this object with new API data.
Parameters
- data: Partial<{
      _id: string;
      avatar?: {
          _id: string;
          content_type: string;
          deleted?: boolean;
          filename: string;
          message_id?: string;
          metadata: {
              type: "File";
          } | {
              type: "Text";
          } | {
              height: number;
              type: "Image";
              width: number;
          } | {
              height: number;
              type: "Video";
              width: number;
          } | {
              type: "Audio";
          };
          object_id?: string;
          reported?: boolean;
          server_id?: string;
          size: number;
          tag: string;
          user_id?: string;
      };
      badges?: number;
      bot?: {
          owner: string;
      };
      discriminator: string;
      display_name?: string;
      flags?: number;
      online?: boolean;
      privileged?: boolean;
      profile?: {
          background?: {
              _id: string;
              content_type: string;
              deleted?: boolean;
              filename: string;
              message_id?: string;
              metadata: {
                  type: "File";
              } | {
                  type: "Text";
              } | {
                  height: number;
                  type: "Image";
                  width: number;
              } | {
                  height: number;
                  type: "Video";
                  width: number;
              } | {
                  type: "Audio";
              };
              object_id?: string;
              reported?: boolean;
              server_id?: string;
              size: number;
              tag: string;
              user_id?: string;
          };
          content?: string;
      };
      relations?: {
          _id: string;
          status: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther";
      }[];
      relationship?: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther";
      status?: {
          presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible";
          text?: string;
      };
      username: string;
  }> = {}
Returns User
Inherited from BaseObject.update
- Defined in core/src/objects/BaseObject.ts:24

Class User

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: Client

_id: string

Description

Description

_id: string

Description

content_type: string

Description

Optional deleted?: boolean

Description

filename: string

Description

Optional message_id?: string

metadata: { type: "File"; } | { type: "Text"; } | { height: number; type: "Image"; width: number; } | { height: number; type: "Video"; width: number; } | { type: "Audio"; }

Description

Optional object_id?: string

Description

Optional reported?: boolean

Description

Optional server_id?: string

size: number

Description

tag: string

Description

Optional user_id?: string

Optional badges?: number

Description

Optional bot?: { owner: string; }

Description

owner: string

Description

discriminator: string

Description

Optional display_name?: string

Description

Optional flags?: number

Description

Optional online?: boolean

Description

Optional privileged?: boolean

Description

Description

Description

_id: string

Description

content_type: string

Description

Optional deleted?: boolean

Description

filename: string

Description

Optional message_id?: string

metadata: { type: "File"; } | { type: "Text"; } | { height: number; type: "Image"; width: number; } | { height: number; type: "Video"; width: number; } | { type: "Audio"; }

Description

Optional object_id?: string

Description

Optional reported?: boolean

Description

Optional server_id?: string

size: number

Description

tag: string

Description

Optional user_id?: string

Optional content?: string

Description

Optional relations?: { _id: string; status: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther"; }[]

Description

Optional relationship?: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther"

Description

`Optional` deleted?: boolean

`Optional` message_id?: string

metadata: {
type: "File";
} | {
type: "Text";
} | {
height: number;
type: "Image";
width: number;
} | {
height: number;
type: "Video";
width: number;
} | {
type: "Audio";
}

`Optional` object_id?: string

`Optional` reported?: boolean

`Optional` server_id?: string

`Optional` user_id?: string

`Optional` badges?: number

`Optional` bot?: {
owner: string;
}

`Optional` display_name?: string

`Optional` flags?: number

`Optional` online?: boolean

`Optional` privileged?: boolean

`Optional` deleted?: boolean

`Optional` message_id?: string

metadata: {
type: "File";
} | {
type: "Text";
} | {
height: number;
type: "Image";
width: number;
} | {
height: number;
type: "Video";
width: number;
} | {
type: "Audio";
}

`Optional` object_id?: string

`Optional` reported?: boolean

`Optional` server_id?: string

`Optional` user_id?: string

`Optional` content?: string

`Optional` relations?: {
_id: string;
status: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther";
}[]

`Optional` relationship?: "Blocked" | "Friend" | "Incoming" | "None" | "Outgoing" | "User" | "BlockedOther"

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

`Optional` presence?: "Online" | "Idle" | "Focus" | "Busy" | "Invisible"

`Optional` text?: string

`Protected` _id

`Optional` updated: any[]