Class Presence

Represents the presence of a user, including their status and custom text.

Hierarchy (View Summary)

Base
- Presence

Index

Constructors

Properties

client id status text

Methods

_clone _update equals

Constructors

constructor

new Presence(client: client): Presence
Creates a new Base instance.
Parameters
- client: client
  The client instance.
Returns Presence
Inherited from Base.constructor
- Defined in work/revbot.js/revbot.js/src/struct/base.ts:21

Properties

`Readonly`client

client: client

The client instance.

id

id: string

The unique identifier for the object.

status

status: Status = Status.Invisible

The current status of the user (e.g., Online, Idle, Busy, Invisible).

text

text: null | string = null

The custom status text of the user, or null if none is set.

Methods

_clone

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

Returns this
A clone of the object.
Inherited from Base._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 Base._update
- Defined in work/revbot.js/revbot.js/src/struct/base.ts:56

equals

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