Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

constructor

Properties

Optional _activities

_activities: BaseCollection<string, PresenceActivity>

_guildIds

_guildIds: BaseSet<string> | string = ""

_keys

_keys: BaseSet<string> = keysPresence

_keysMerge

_keysMerge: BaseSet<string> = keysMergePresence

_keysSkipDifference

_keysSkipDifference: BaseSet<string> = keysSkipDifferencePresence

client

client: ShardClient

Optional clientStatus

clientStatus: undefined | object

lastGuildId

lastGuildId: string = LOCAL_GUILD_ID

Optional lastModified

lastModified: undefined | number

status

status: string = PresenceStatuses.OFFLINE

user

user: User

Accessors

_shouldDelete

  • get _shouldDelete(): boolean
  • Returns boolean

activities

  • Returns BaseCollection<string, PresenceActivity>

activity

game

guildIds

  • get guildIds(): BaseSet<string>
  • Returns BaseSet<string>

isDnd

  • get isDnd(): boolean
  • Returns boolean

isIdle

  • get isIdle(): boolean
  • Returns boolean

isOffline

  • get isOffline(): boolean
  • Returns boolean

isOnline

  • get isOnline(): boolean
  • Returns boolean

shardId

  • get shardId(): number
  • Returns number

showMobileIcon

  • get showMobileIcon(): boolean
  • Returns boolean

Methods

[inspect.custom]

  • [inspect.custom](): object

_deleteGuildId

  • _deleteGuildId(guildId: string): void
  • Parameters

    • guildId: string

    Returns void

_getFromSnake

  • _getFromSnake(key: string): any
  • Parameters

    • key: string

    Returns any

_hasGuildId

  • _hasGuildId(guildId: string): boolean
  • Parameters

    • guildId: string

    Returns boolean

_setFromSnake

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

    • key: string
    • value: any

    Returns any

activitiesFor

  • Parameters

    • guildId: string

    Returns BaseCollection<string, PresenceActivity>

activityFor

  • Parameters

    • guildId: string

    Returns null | PresenceActivity

difference

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

    • key: string
    • value: any

    Returns [boolean, any]

differences

merge

mergeValue

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

    • key: string
    • value: any

    Returns void

toJSON

  • toJSON(): object
  • Returns object

toString

  • toString(): string
  • Returns string

Generated using TypeDoc