Class ClientPresence<T>

The presence for the client user.

since: 0.0.1
see: https://discord.com/developers/docs/topics/gateway#presence

Type parameters

T

Hierarchy

Presence
- ClientPresence

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ClientPresence(client: Client, data: APIPresenceUpdateData): ClientPresence

Inherited from Presence.constructor

Overrides Structure.constructor
- Defined in src/lib/caching/structures/guilds/Presence.ts:33
Parameters
- client: Client
- data: APIPresenceUpdateData
Returns ClientPresence

Properties

activities

activities: APIActivityData[]

The member's current activities.

since: 0.0.1

Readonly client

client: T

clientStatus

clientStatus: APIClientStatusData | null

The member's platform-dependent status.

since: 0.0.1

Readonly id

id: string

The member's ID this presence corresponds to.

since: 0.0.1

status

status: PresenceUpdateStatus | null

The member's status.

since: 0.0.1

Accessors

createdAt

get createdAt(): Date

Inherited from Structure.createdAt
- Defined in src/lib/caching/structures/base/Structure.ts:20
The Date when this object was created at

Returns Date

createdTimestamp

get createdTimestamp(): number

Inherited from Structure.createdTimestamp
- Defined in src/lib/caching/structures/base/Structure.ts:27
The time when this object was created at

Returns number

Methods

Protected _patch

_patch(data: APIPresenceUpdateData): this

Inherited from Presence._patch

Overrides Structure._patch
- Defined in src/lib/caching/structures/guilds/Presence.ts:41
Parameters
- data: APIPresenceUpdateData
Returns this

clone

clone(): this

Inherited from Structure.clone
- Defined in src/lib/caching/structures/base/Structure.ts:34
Basic clone method

Returns this

modify

modify(game: PresenceUpdateData, shards?: number | number[]): this
modify(builder: (presence: PresenceBuilder) => PresenceBuilder, shards?: number | number[]): this

- Defined in src/lib/caching/structures/presences/ClientPresence.ts:19
Sets the client presence.

since

0.0.1

see

https://discord.com/developers/docs/topics/gateway#update-status

Parameters
- game: PresenceUpdateData
- Optional shards: number | number[]
Returns this
- Defined in src/lib/caching/structures/presences/ClientPresence.ts:25
Sets the client presence with a builder, and returns it.

since

0.0.1

Parameters
- builder: (presence: PresenceBuilder) => PresenceBuilder
  
  The builder to aid building the game.
  - - (presence: PresenceBuilder): PresenceBuilder
    - Parameters
      - presence: PresenceBuilder
      Returns PresenceBuilder
- Optional shards: number | number[]
Returns this

toJSON

toJSON(): Record<string, any>

Inherited from Structure.toJSON
- Defined in src/lib/caching/structures/base/Structure.ts:54
The JSON representation of this object.

Returns Record<string, any>

valueOf

valueOf(): string

Inherited from Structure.valueOf
- Defined in src/lib/caching/structures/base/Structure.ts:47
The basic value of this Structure

Returns string

Generated using TypeDoc