Class ClientUser

Represents the client user, which is the authenticated user or bot.

Hierarchy (View Summary)

User
- ClientUser

Index

Constructors

constructor

new ClientUser(
    client: client,
    data: {
        _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?: number;
        bot?: null
        | { owner: string };
        discriminator: string;
        display_name?: null | string;
        flags?: number;
        online: boolean;
        privileged?: boolean;
        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;
    },
): ClientUser
Creates a new User instance.
Parameters
- client: client
  The client instance.
- data: {
      _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?: number;
      bot?: null
      | { owner: string };
      discriminator: string;
      display_name?: null | string;
      flags?: number;
      online: boolean;
      privileged?: boolean;
      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;
  }
  The raw data for the user from the API.
  - _id: string
    Description
    Unique Id
  - Optionalavatar?:
        | 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;
        }
    Description
    Avatar attachment
  - Optionalbadges?: number
    Format: uint32
    
    Description
    Bitfield of user badges
    
    https://docs.rs/revolt-models/latest/revolt_models/v0/enum.UserBadges.html
  - Optionalbot?: null | { owner: string }
    Description
    Bot information
  - discriminator: string
    Description
    Discriminator
  - Optionaldisplay_name?: null | string
    Description
    Display name
  - Optionalflags?: number
    Format: uint32
    
    Description
    Enum of user flags
    
    https://docs.rs/revolt-models/latest/revolt_models/v0/enum.UserFlags.html
  - online: boolean
    Description
    Whether this user is currently online
  - Optionalprivileged?: boolean
    Description
    Whether this user is privileged
  - Optionalrelations?: {
        _id: string;
        status:
            | "User"
            | "None"
            | "Friend"
            | "Outgoing"
            | "Incoming"
            | "Blocked"
            | "BlockedOther";
    }[]
    Description
    Relationships with other users
  - relationship:
        | "User"
        | "None"
        | "Friend"
        | "Outgoing"
        | "Incoming"
        | "Blocked"
        | "BlockedOther"
    Description
    Current session user's relationship with this user
  - Optionalstatus?:
        | null
        | {
            presence?: null
            | "Online"
            | "Idle"
            | "Focus"
            | "Busy"
            | "Invisible";
            text?: null | string;
        }
    Description
    User's current status
  - username: string
    Description
    Username
Returns ClientUser
Inherited from User.constructor
- Defined in work/revbot.js/revbot.js/src/struct/user.ts:37

Properties

avatar

avatar: null | Attachment = null

The avatar of the user, or null if none is set.

badges

badges: Badges

The badges associated with the user.

bot

bot: boolean = false

Whether the user is a bot.

`Readonly`client

client: client

The client instance.

id

id: string

The unique identifier for the object.

notes

notes: null | NotesChannel = null

The notes channel associated with the client user, if any.

presence

presence: Presence = ...

The presence status of the user.

username

username: string

The username of the user.

Accessors

createdAt

get createdAt(): Date
Gets the creation date of the user.

Returns Date
The date when the user was created.
Inherited from User.createdAt
- Defined in work/revbot.js/revbot.js/src/struct/user.ts:91

createdTimestamp

get createdTimestamp(): number
Gets the creation timestamp of the user in milliseconds.

Returns number
The timestamp of when the user was created.
Inherited from User.createdTimestamp
- Defined in work/revbot.js/revbot.js/src/struct/user.ts:100

Methods

_clone

_clone(): this
Creates a deep clone of the object.

Returns this
A clone of the object.
Inherited from User._clone
- Defined in work/revbot.js/revbot.js/src/struct/base.ts:84

_update

_update(data: PartialObject, clear?: string[]): this
Updates the object with new data and returns a clone of the object.
Parameters
- data: PartialObject
  The data to update the object with.
- Optionalclear: string[]
  Fields to clear in the object.
Returns this
A clone of the updated object.
Inherited from User._update
- Defined in work/revbot.js/revbot.js/src/struct/base.ts:56

block

block(): Promise<void>
Blocks the user.

Returns Promise<void>
A promise that resolves when the user is blocked.
Example
```
await user.block();
```
Inherited from User.block
- Defined in work/revbot.js/revbot.js/src/struct/user.ts:114

createDM

createDM(): Promise<DMChannel>
Creates a direct message (DM) channel with the user.

Returns Promise<DMChannel>
A promise that resolves with the created DM channel.
Example
```
const dmChannel = await user.createDM();
```
Inherited from User.createDM
- Defined in work/revbot.js/revbot.js/src/struct/user.ts:142

equals

equals(obj?: null | ClientUser): boolean
Compares this object with another to determine if they are equal.
Parameters
- Optionalobj: null | ClientUser
  The object to compare with.
Returns boolean
true if the objects are equal, otherwise false.
Inherited from User.equals
- Defined in work/revbot.js/revbot.js/src/struct/base.ts:29

fetch

fetch(force?: boolean): Promise<User>
Fetches the latest data for the user from the API.
Parameters
- Optionalforce: boolean = true
  Whether to force a fetch even if the user is cached.
Returns Promise<User>
A promise that resolves with the updated user instance.
Inherited from User.fetch
- Defined in work/revbot.js/revbot.js/src/struct/user.ts:170

setStatus

setStatus(text: null | string, presence?: Status): Promise<void>
Updates the status of the client user.
Parameters
- text: null | string
  The status text to set, or null to clear the status.
- Optionalpresence: Status
  The presence status (e.g., online, idle, etc.).
Returns Promise<void>
A promise that resolves when the status has been successfully updated.
Example
```
await clientUser.setStatus("Available", "online");
```
- Defined in work/revbot.js/revbot.js/src/struct/clientUser.ts:47

setUsername

setUsername(username: string, password?: string): Promise<void>
Updates the username of the client user.
Parameters
- username: string
  The new username to set.
- Optionalpassword: string
  The current password of the user (required for non-bot accounts).
Returns Promise<void>
A promise that resolves when the username has been successfully updated.
Throws
Throws an error if the client user is a bot and a password is provided.
Example
```
await clientUser.setUsername("NewUsername", "CurrentPassword");
```
- Defined in work/revbot.js/revbot.js/src/struct/clientUser.ts:25

toString

toString(): string
Converts the user to a string representation.

Returns string
A string representation of the user in the format <@userId>.
Inherited from User.toString
- Defined in work/revbot.js/revbot.js/src/struct/user.ts:179

unblock

unblock(): Promise<void>
Unblocks the user.

Returns Promise<void>
A promise that resolves when the user is unblocked.
Example
```
await user.unblock();
```
Inherited from User.unblock
- Defined in work/revbot.js/revbot.js/src/struct/user.ts:128

Class ClientUser

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_id: string

Description

Description

Optionalbadges?: number

Description

Optionalbot?: null | { owner: string }

Description

discriminator: string

Description

Optionaldisplay_name?: null | string

Description

Optionalflags?: number

Description

online: boolean

Description

Optionalprivileged?: boolean

Description

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

Description

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

Description

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

Description

username: string

Description

Returns ClientUser

Properties

avatar

badges

bot

Readonlyclient

id

notes

presence

username

Accessors

createdAt

Returns Date

createdTimestamp

Returns number

Methods

_clone

Returns this

_update

Parameters

Returns this

block

Returns Promise<void>

Example

createDM

Returns Promise<DMChannel>

Example

equals

Parameters

Returns boolean

fetch

Parameters

Returns Promise<User>

setStatus

Parameters

Returns Promise<void>

Example

setUsername

Parameters

Returns Promise<void>

Throws

Example

toString

Returns string

unblock

`Optional`badges?: number

`Optional`bot?: null | { owner: string }

`Optional`display_name?: null | string

`Optional`flags?: number

`Optional`privileged?: boolean

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

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

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

`Readonly`client