Documentation/detritus-client/Structures

Presenceclass

Presence Structure, used to detail a user's presence in a guild (or general if you have them added (non-bots only))

On this page

Overview
Constructor1
Properties8
Accessors12
Methods18

Presence Structure, used to detail a user's presence in a guild (or general if you have them added (non-bots only))

import { Structures } from 'detritus-client';

Structures.Presence;

Hierarchy

StructureBaseStructurePresence

14 properties4 methods15 inheritedsrc/structures/presence.ts:71

Constructor

new Presence

src/structures/presence.ts:84

new Presence(client: ShardClient, data?: BaseStructureData, isClone?: boolean)

Properties

_activities?

BaseCollection<string, PresenceActivity>

optional

_guildIds

string | BaseSet<string>

Default ''

client

ShardClient

readonly

Inherited from BaseStructure.client

clientStatus?

{ desktop?: string; mobile?: string; web?: string }

optional

lastGuildId

string

Default LOCAL_GUILD_ID

lastModified?

number

optional

status

string

Default PresenceStatuses.OFFLINE

user

User

Accessors

_shouldDelete

boolean

get

activities

BaseCollection<string, PresenceActivity>

get

activity

PresenceActivity | null

get

game

PresenceActivity | null

get

guildIds

BaseSet<string>

get

isClone

boolean

get

Inherited from BaseStructure.isClone

isDnd

boolean

get

isIdle

boolean

get

isOffline

boolean

get

isOnline

boolean

get

shardId

number

get

Inherited from BaseStructure.shardId

showMobileIcon

boolean

get

Methods

_deleteGuildId()

src/structures/presence.ts:181

_deleteGuildId(guildId: string): void

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake

_hasGuildId()

src/structures/presence.ts:214

_hasGuildId(guildId: string): boolean

_setFromSnake()

src/structures/basestructure.ts:142

_setFromSnake(key: string, value: any): any

Inherited from BaseStructure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from BaseStructure.[custom]

activitiesFor()

src/structures/presence.ts:163

activitiesFor(guildId: string): BaseCollection<string, PresenceActivity>

activityFor()

src/structures/presence.ts:150

activityFor(guildId: string): PresenceActivity | null

clone()

src/structures/basestructure.ts:431

clone(): this

Inherited from BaseStructure.clone

difference()

src/structures/basestructure.ts:146

difference(key: string, value: any): [boolean, any]

Inherited from BaseStructure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from BaseStructure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from BaseStructure.differencesBetween

hasDifference()

src/structures/basestructure.ts:218

hasDifference(key: string, value: any): boolean

Inherited from BaseStructure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween

merge()

src/structures/presence.ts:222

merge(data?: BaseStructureData): void

Overrides BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

mergeValue(key: string, value: any): void

Inherited from BaseStructure.mergeValue

toJSON()

src/structures/basestructure.ts:357

toJSON(): object

Inherited from BaseStructure.toJSON

toString()

src/structures/presence.ts:352

toString(): string

Returns a string representation of an object.