Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PresenceActivity

Presence Activity Structure, used in [Presence]

Hierarchy

Index

Constructors

constructor

Properties

_guildIds

_guildIds: BaseSet<string> | string = ""

_keys

_keys: BaseSet<string> = keysPresenceActivity

_keysMerge

_keysMerge: BaseSet<string> = keysMergePresenceActivity

_keysSkipDifference

_keysSkipDifference: BaseSet<string> = keysSkipDifferencePresenceActivity

Optional applicationId

applicationId: undefined | string

Optional assets

client

client: ShardClient

Optional createdAt

createdAt: undefined | number

Optional details

details: undefined | string

Optional emoji

emoji: Emoji

flags

flags: number = 0

id

id: string = ""

Optional instance

instance: undefined | false | true

Optional metadata

metadata: any

name

name: string = ""

Optional party

party: undefined | object

Optional platform

position

position: number = 0

Optional secrets

secrets: undefined | object

Optional sessionId

sessionId: undefined | string

Optional state

state: undefined | string

Optional syncId

syncId: undefined | string

Optional timestamps

type

type: number = 0

Optional url

url: undefined | string

user

user: User

Accessors

_shouldDelete

  • get _shouldDelete(): boolean
  • Returns boolean

application

  • Returns Application | null

applicationIsXbox

  • get applicationIsXbox(): boolean
  • Returns boolean

canInstance

  • get canInstance(): boolean
  • Returns boolean

canJoin

  • get canJoin(): boolean
  • Returns boolean

canJoinRequest

  • get canJoinRequest(): boolean
  • Returns boolean

canPlay

  • get canPlay(): boolean
  • Returns boolean

canSpectate

  • get canSpectate(): boolean
  • Returns boolean

canSync

  • get canSync(): boolean
  • Returns boolean

group

  • get group(): BaseCollection<string, User>
  • Returns BaseCollection<string, User>

guildIds

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

imageUrl

  • get imageUrl(): null | string
  • Returns null | string

isCustomStatus

  • get isCustomStatus(): boolean
  • Returns boolean

isListening

  • get isListening(): boolean
  • Returns boolean

isOnAndroid

  • get isOnAndroid(): boolean
  • Returns boolean

isOnIOS

  • get isOnIOS(): boolean
  • Returns boolean

isOnSamsung

  • get isOnSamsung(): boolean
  • Returns boolean

isOnSpotify

  • get isOnSpotify(): boolean
  • Returns boolean

isOnXbox

  • get isOnXbox(): boolean
  • Returns boolean

isPlaying

  • get isPlaying(): boolean
  • Returns boolean

isStreaming

  • get isStreaming(): boolean
  • Returns boolean

isWatching

  • get isWatching(): boolean
  • Returns boolean

partyIsFull

  • get partyIsFull(): boolean
  • Returns boolean

partyIsSpotify

  • get partyIsSpotify(): boolean
  • Returns boolean

partyMaxSize

  • get partyMaxSize(): number | null
  • Returns number | null

partySize

  • get partySize(): number | null
  • Returns number | null

platformDiscordUrl

  • get platformDiscordUrl(): null | string
  • Returns null | string

platformType

  • get platformType(): string
  • Returns string

shardId

  • get shardId(): number
  • Returns number

spotifyTrackUrl

  • get spotifyTrackUrl(): null | string
  • Returns null | string

typeText

  • get typeText(): string
  • Returns string

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

difference

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

    • key: string
    • value: any

    Returns [boolean, any]

differences

fetchApplication

  • Returns Promise<Application | null>

fetchMetadata

  • fetchMetadata(): Promise<any>
  • Returns Promise<any>

hasFlag

  • hasFlag(flag: number): boolean
  • Parameters

    • flag: number

    Returns boolean

imageUrlFormat

  • imageUrlFormat(format?: null | string, query?: UrlQuery): null | string
  • Parameters

    • Optional format: null | string
    • Optional query: UrlQuery

    Returns null | string

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