Class Presence

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

Hierarchy

BaseStructure
- Presence

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

Overrides BaseStructure.constructor
- Defined in src/structures/presence.ts:79
Parameters
- client: ShardClient
- Optional data: BaseStructureData
- Optional isClone: boolean
Returns Presence

Properties

Optional _activities

_activities: BaseCollection<string, PresenceActivity>

_guildIds

_guildIds: string | BaseSet<string> = ''

Readonly _keys

_keys: BaseSet<string> = ...

Readonly _keysMerge

_keysMerge: BaseSet<string> = ...

Readonly _keysSkipDifference

_keysSkipDifference: BaseSet<string> = ...

Readonly client

client: ShardClient

Optional clientStatus

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

Type declaration

Optional desktop?: string
Optional mobile?: string
Optional web?: string

lastGuildId

lastGuildId: string = ...

Optional lastModified

lastModified: number

status

status: string = ...

user

user: User

Accessors

_shouldDelete

get _shouldDelete(): boolean

- Defined in src/structures/presence.ts:174
Returns boolean

activities

get activities(): BaseCollection<string, PresenceActivity>

- Defined in src/structures/presence.ts:94
Returns BaseCollection<string, PresenceActivity>

activity

get activity(): null | PresenceActivity

- Defined in src/structures/presence.ts:90
Returns null | PresenceActivity

game

get game(): null | PresenceActivity

- Defined in src/structures/presence.ts:101
Returns null | PresenceActivity

guildIds

get guildIds(): BaseSet<string>

- Defined in src/structures/presence.ts:113
Returns BaseSet<string>

isClone

get isClone(): boolean

- Defined in src/structures/basestructure.ts:317
Returns boolean

isDnd

get isDnd(): boolean

- Defined in src/structures/presence.ts:124
Returns boolean

isIdle

get isIdle(): boolean

- Defined in src/structures/presence.ts:128
Returns boolean

isOffline

get isOffline(): boolean

- Defined in src/structures/presence.ts:132
Returns boolean

isOnline

get isOnline(): boolean

- Defined in src/structures/presence.ts:136
Returns boolean

shardId

get shardId(): number

- Defined in src/structures/basestructure.ts:321
Returns number

showMobileIcon

get showMobileIcon(): boolean

- Defined in src/structures/presence.ts:140
Returns boolean

Methods

[custom]

[custom](): object

Inherited from BaseStructure.[custom]
- Defined in src/structures/basestructure.ts:282
Returns object

_deleteGuildId

_deleteGuildId(guildId: string): void

- Defined in src/structures/presence.ts:178
Parameters
- guildId: string
Returns void

_getFromSnake

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake
- Defined in src/structures/basestructure.ts:33
Parameters
- key: string
Returns any

_hasGuildId

_hasGuildId(guildId: string): boolean

- Defined in src/structures/presence.ts:211
Parameters
- guildId: string
Returns boolean

_setFromSnake

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

Inherited from BaseStructure._setFromSnake
- Defined in src/structures/basestructure.ts:37
Parameters
- key: string
- value: any
Returns any

activitiesFor

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

- Defined in src/structures/presence.ts:160
Parameters
- guildId: string
Returns BaseCollection<string, PresenceActivity>

activityFor

activityFor(guildId: string): null | PresenceActivity

- Defined in src/structures/presence.ts:147
Parameters
- guildId: string
Returns null | PresenceActivity

clone

clone(): Presence

Inherited from BaseStructure.clone
- Defined in src/structures/basestructure.ts:325
Returns Presence

difference

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

Inherited from BaseStructure.difference
- Defined in src/structures/basestructure.ts:41
Parameters
- key: string
- value: any
Returns [boolean, any]

differences

differences(data?: BaseStructureData): null | object

Inherited from BaseStructure.differences
- Defined in src/structures/basestructure.ts:67
Parameters
- Optional data: BaseStructureData
Returns null | object

differencesBetween

differencesBetween(structure: Structure): null | object

Inherited from BaseStructure.differencesBetween
- Defined in src/structures/basestructure.ts:86
Parameters
- structure: Structure
Returns null | object

hasDifference

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

Inherited from BaseStructure.hasDifference
- Defined in src/structures/basestructure.ts:107
Parameters
- key: string
- value: any
Returns boolean

hasDifferences

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences
- Defined in src/structures/basestructure.ts:195
Parameters
- Optional data: BaseStructureData
Returns boolean

hasDifferencesBetween

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween
- Defined in src/structures/basestructure.ts:210
Parameters
- structure: Structure
Returns boolean

merge

merge(data?: BaseStructureData): void

Inherited from BaseStructure.merge
- Defined in src/structures/basestructure.ts:225
Parameters
- Optional data: BaseStructureData
Returns void

mergeValue

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

Overrides BaseStructure.mergeValue
- Defined in src/structures/presence.ts:219
Parameters
- key: string
- value: any
Returns void

toJSON

toJSON(): object

Inherited from BaseStructure.toJSON
- Defined in src/structures/basestructure.ts:259
Returns object

toString

toString(): string

- Defined in src/structures/presence.ts:327
Returns string

Generated using TypeDoc