Documentation/detritus-client/Structures

PresenceActivityclass

Presence Activity Structure, used in [Presence]

On this page

Overview
Constructor1
Properties24
Accessors32
Methods21

Presence Activity Structure, used in [Presence]

import { Structures } from 'detritus-client';

Structures.PresenceActivity;

Hierarchy

StructureBaseStructurePresenceActivity

51 properties7 methods15 inheritedsrc/structures/presence.ts:397

Constructor

new PresenceActivity

src/structures/presence.ts:427

new PresenceActivity(user: User, data: BaseStructureData)

Properties

_guildIds

string | BaseSet<string>

Default ''

applicationId?

string

optional

assets?

PresenceActivityAssets

optional

buttons?

string[]

optional

client

ShardClient

readonly

Inherited from BaseStructure.client

createdAt?

number

optional

details?

string

optional

emoji?

Emoji

optional

flags

number

Default 0

string

Default ''

instance?

boolean

optional

metadata?

any

optional

name

string

Default ''

party?

{ id?: string; size?: [number, number] }

optional

platform?

ActivityPlatformTypes

optional

position

number

Default 0

secrets?

{ join?: string; match?: string; spectate?: string }

optional

sessionId?

string

optional

state?

string

optional

syncId?

string

optional

timestamps?

PresenceActivityTimestamps

optional

type

number

Default 0

url?

string

optional

user

User

readonly

Accessors

_shouldDelete

boolean

get

application

Application | null

get

applicationIsXbox

boolean

get

canInstance

boolean

get

canJoin

boolean

get

canJoinRequest

boolean

get

canPlay

boolean

get

canSpectate

boolean

get

canSync

boolean

get

group

BaseCollection<string, User>

get

guildIds

BaseSet<string>

get

imageUrl

string | null

get

isClone

boolean

get

Inherited from BaseStructure.isClone

isCustomStatus

boolean

get

isListening

boolean

get

isOnAndroid

boolean

get

isOnIOS

boolean

get

isOnSamsung

boolean

get

isOnSpotify

boolean

get

isOnXbox

boolean

get

isPlaying

boolean

get

isStreaming

boolean

get

isWatching

boolean

get

partyIsFull

boolean

get

partyIsSpotify

boolean

get

partyMaxSize

number | null

get

partySize

number | null

get

platformDiscordUrl

string | null

get

platformType

string

get

shardId

number

get

Inherited from BaseStructure.shardId

spotifyTrackUrl

string | null

get

typeText

string

get

Methods

_deleteGuildId()

src/structures/presence.ts:683

_deleteGuildId(guildId: string): void

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake

_hasGuildId()

src/structures/presence.ts:700

_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]

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

fetchApplication()

async src/structures/presence.ts:640

fetchApplication(): Promise<Application | null>

fetchButtonUrls()

async src/structures/presence.ts:647

fetchButtonUrls(): Promise<any>

fetchMetadata()

async src/structures/presence.ts:664

fetchMetadata(): Promise<any>

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

hasFlag()

src/structures/presence.ts:625

hasFlag(flag: number): boolean

imageUrlFormat()

src/structures/presence.ts:629

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

merge()

src/structures/presence.ts:708

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:803

toString(): string

Returns a string representation of an object.