Class User

constructor

• new User(collection: UserCollection, id: string): User

  Construct User

  Parameters

  • collection: UserCollection

    Collection
  • id: string

    Id

  Returns User

Readonlyid

$exists

• get $exists(): boolean

  Whether this object exists

  Returns boolean

age

• get age(): number

  How old this user is in milliseconds

  Returns number

animatedAvatarURL

• get animatedAvatarURL(): string

  URL to the user's animated avatar

  Returns string

avatar

• get avatar(): undefined | File

  Avatar

  Returns undefined | File

avatarURL

• get avatarURL(): string

  URL to the user's avatar

  Returns string

badges

• get badges(): number

  Badges

  Returns number

bot

• get bot(): undefined | { owner: string }

  Bot information

  Returns undefined | { owner: string }

createdAt

• get createdAt(): Date

  Time when this user created their account

  Returns Date

defaultAvatarURL

• get defaultAvatarURL(): string

  URL to the user's default avatar

  Returns string

discriminator

• get discriminator(): string

  Discriminator

  Returns string

displayName

• get displayName(): string

  Display Name

  Returns string

flags

• get flags(): number

  Flags

  Returns number

limits

• get limits(): | undefined
  | {
      bots: number;
      file_upload_size_limits: { [key: string]: number };
      message_attachments: number;
      message_length: number;
      outgoing_friend_requests: number;
      servers: number;
      video: boolean;
      video_aspect_ratio: number[];
      video_resolution: number[];
      voice_quality: number;
  }

  Backend enforced limits for a user

  Returns
      | undefined
      | {
          bots: number;
          file_upload_size_limits: { [key: string]: number };
          message_attachments: number;
          message_length: number;
          outgoing_friend_requests: number;
          servers: number;
          video: boolean;
          video_aspect_ratio: number[];
          video_resolution: number[];
          voice_quality: number;
      }

  • undefined
  • {
        bots: number;
        file_upload_size_limits: { [key: string]: number };
        message_attachments: number;
        message_length: number;
        outgoing_friend_requests: number;
        servers: number;
        video: boolean;
        video_aspect_ratio: number[];
        video_resolution: number[];
        voice_quality: number;
    }

    • bots: number

      Format: int64

      Description

      Max Owned Bots

    • file_upload_size_limits: { [key: string]: number }

    • message_attachments: number

      Format: int64

      Description

      max message attachments

    • message_length: number

      Format: int64

      Description

      Max message content length

    • outgoing_friend_requests: number

      Format: int64

      Description

      Max Outgoing Friend Requests

    • servers: number

      Format: int64

      Description

      max servers

    • video: boolean

      Description

      video streaming enabled

    • video_aspect_ratio: number[]

      Description

      min/max aspect ratios

    • video_resolution: number[]

      Description

      max video resolution (vertical, horizontal)

    • voice_quality: number

      Format: int64

      Description

      max audio quality

online

• get online(): boolean

  Whether the user is online

  Returns boolean

permission

• get permission(): number

  Permissions against this user

  Returns number

presence

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

  Presence

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

privileged

• get privileged(): boolean

  Whether the user is privileged

  Returns boolean

pronouns

• get pronouns(): undefined | string

  Pronouns

  Returns undefined | string

relationship

• get relationship(): string

  Relationship with user

  Returns string

self

• get self(): boolean

  Whether this user is ourselves

  Returns boolean

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;
      }

username

• get username(): string

  Username

  Returns string

addFriend

• addFriend(): Promise<User>

  Send a friend request to a user

  Returns Promise<User>

blockUser

• blockUser(): Promise<void>

  Block a user

  Returns Promise<void>

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" }
                  | {
                      animated?: null | boolean;
                      height: number;
                      thumbhash?: null | 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?: number;
          bot?: null
          | { owner: string };
          discriminator: string;
          display_name?: null | string;
          flags?: number;
          online: boolean;
          privileged?: boolean;
          pronouns?: null | string;
          relations?: {
              _id: string;
              status:
                  | "User"
                  | "None"
                  | "Friend"
                  | "Outgoing"
                  | "Incoming"
                  | "Blocked"
                  | "BlockedOther";
          }[];
          relationship: | "User"
          | "None"
          | "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" }
                  | {
                      animated?: null | boolean;
                      height: number;
                      thumbhash?: null | 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?: number;
          bot?: null
          | { owner: string };
          discriminator: string;
          display_name?: null | string;
          flags?: number;
          online: boolean;
          privileged?: boolean;
          pronouns?: null | string;
          relations?: {
              _id: string;
              status:
                  | "User"
                  | "None"
                  | "Friend"
                  | "Outgoing"
                  | "Incoming"
                  | "Blocked"
                  | "BlockedOther";
          }[];
          relationship: | "User"
          | "None"
          | "Friend"
          | "Outgoing"
          | "Incoming"
          | "Blocked"
          | "BlockedOther";
          status?: | null
          | {
              presence?: null
              | "Online"
              | "Idle"
              | "Focus"
              | "Busy"
              | "Invisible";
              text?: null | string;
          };
          username: string;
      },
  >

edit

• edit(
      data: {
          avatar?: null | string;
          badges?: null | number;
          display_name?: null | string;
          flags?: null | number;
          profile?: null | { background?: null | string; content?: null | string };
          pronouns?: null | string;
          remove?: (
              | "Avatar"
              | "StatusText"
              | "StatusPresence"
              | "ProfileContent"
              | "ProfileBackground"
              | "DisplayName"
              | "Pronouns"
              | "Internal"
          )[];
          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 };
        pronouns?: null | string;
        remove?: (
            | "Avatar"
            | "StatusText"
            | "StatusPresence"
            | "ProfileContent"
            | "ProfileBackground"
            | "DisplayName"
            | "Pronouns"
            | "Internal"
        )[];
        status?: | null
        | {
            presence?: null
            | "Online"
            | "Idle"
            | "Focus"
            | "Busy"
            | "Invisible";
            text?: null | string;
        };
    }

    Changes

    • Optionalavatar?: null | string

      Description

      Attachment Id for avatar

    • Optionalbadges?: null | number

      Format: int32

      Description

      Bitfield of user badges

    • Optionaldisplay_name?: null | string

      Description

      New display name

    • Optionalflags?: null | number

      Format: int32

      Description

      Enum of user flags

    • Optionalprofile?: null | { background?: null | string; content?: null | string }

      Description

      New user profile data

      This is applied as a partial.

    • Optionalpronouns?: null | string

      Description

      New pronouns

    • Optionalremove?: (
          | "Avatar"
          | "StatusText"
          | "StatusPresence"
          | "ProfileContent"
          | "ProfileBackground"
          | "DisplayName"
          | "Pronouns"
          | "Internal"
      )[]

      Description

      Fields to remove from user object

      Default

      []
      Copy

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

      Description

      New user status

  Returns Promise<void>

fetchMutual

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

  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<UserProfile>

  Fetch the profile of a user

  Returns Promise<UserProfile>

  The profile of the user

openDM

• openDM(): Promise<Channel>

  Open a DM with a user

  Returns Promise<Channel>

  DM Channel

removeFriend

• removeFriend(): Promise<void>

  Remove a user from the friend list

  Returns Promise<void>

statusMessage

• statusMessage(
      translate?: (
          presence: "Online" | "Idle" | "Focus" | "Busy" | "Invisible",
      ) => string,
  ): undefined | string

  Generate status message

  Parameters

  • translate: (presence: "Online" | "Idle" | "Focus" | "Busy" | "Invisible") => string = ...

    Translation function

  Returns undefined | string

  Status message

toString

• toString(): string

  Write to string as a user mention

  Returns string

  Formatted String

unblockUser

• unblockUser(): Promise<void>

  Unblock a user

  Returns Promise<void>