DiscordPHP Documentation

Activity extends Part

in package

• Application

implements Stringable

The Activity part describes activities the member is undertaking.

Tags

see

https://support.discord.com/hc/en-us/articles/7931156448919-Activity-Sharing-on-Discord-FAQ

link

https://docs.discord.com/developers/events/gateway-events#activity-object

since

5.0.0

Renamed from Game to Activity

3.2.2

phpstan-property

ExCollectionInterface<Button>|null $buttons

Table of Contents

Interfaces

Stringable

Constants

FLAG_EMBEDDED  : mixed = 1 << 8

FLAG_INSTANCE  : mixed = 1 << 0

FLAG_JOIN  : mixed = 1 << 1

FLAG_JOIN_REQUEST  : mixed = 1 << 3

FLAG_PARTY_PRIVACY_FRIENDS  : mixed = 1 << 6

FLAG_PARTY_PRIVACY_VOICE_CHANNEL  : mixed = 1 << 7

FLAG_PLAY  : mixed = 1 << 5

FLAG_SPECTATE  : mixed = 1 << 2

FLAG_SYNC  : mixed = 1 << 4

STATUS_DISPLAY_TYPE_DETAILS  : mixed = 2

"Listening to Never Gonna Give You Up"

STATUS_DISPLAY_TYPE_NAME  : mixed = 0

"Listening to Spotify"

STATUS_DISPLAY_TYPE_STATE  : mixed = 1

"Listening to Rick Astley"

STATUS_DND  : mixed = 'dnd'

Do Not Disturb.

STATUS_IDLE  : mixed = 'idle'

AFK.

STATUS_INVISIBLE  : mixed = 'invisible'

Invisible and shown as offline.

STATUS_OFFLINE  : mixed = 'offline'

Offline.

STATUS_ONLINE  : mixed = 'online'

Online.

TYPE_COMPETING  : mixed = 5

Competing in {name}

TYPE_CUSTOM  : mixed = 4

{emoji} {name}

TYPE_GAME  : mixed = self::TYPE_PLAYING

TYPE_LISTENING  : mixed = 2

Listening to {name}

TYPE_PLAYING  : mixed = 0

Playing {name}

TYPE_STREAMING  : mixed = 1

Streaming {details}

TYPE_WATCHING  : mixed = 3

Watching {name}

Properties

$application_id  : ?string|null

$assets  : ?Assets|null

$buttons  : ?ExCollectionInterface<string|int, Button>|array<string|int, Button>|null

$created  : bool

Is the part already created in the Discord servers?

$created_at  : Carbon|null

$details  : ?string|null

$details_url  : ?string|null

$emoji  : ?Emoji|null

$flags  : ?int|null

$instance  : ?bool|null

$name  : string

$party  : ?Party|null

$scriptData  : mixed

Custom script data.

$secrets  : ?Secrets|null

$state  : ?string|null

$state_url  : ?string|null

$status_display_type  : ?int|null

$timestamps  : ?Timestamps|null

$type  : int

$url  : ?string|null

$attributes  : array<string|int, mixed>

The parts attributes.

$discord  : Discord

The Discord client.

$factory  : Factory

The factory.

$fillable  : array<string|int, mixed>

The parts fillable attributes.

$hidden  : array<string|int, mixed>

Attributes that are hidden from debug info.

$http  : Http

The HTTP client.

$repositories  : array<string|int, mixed>

An array of repositories that can exist in a part.

$repositories_cache  : array<string|int, mixed>

An array of repositories.

$visible  : array<string|int, mixed>

Attributes which are visible from debug info.

Methods

__construct()  : mixed

Create a new part instance.

__debugInfo()  : array<string|int, mixed>

Debug representation for `var_dump()`.

__get()  : mixed

Handles dynamic get calls onto the part.

__isset()  : bool

Handles isset() and empty() on the part's magic properties.

__serialize()  : array<string|int, mixed>

The raw attributes, for PHP native serialization.

__set()  : void

Handles dynamic set calls onto the part.

__toString()  : string

Converts the activity to a string.

__unserialize()  : void

Restores attributes from PHP native unserialization.

fetch()  : PromiseInterface<string|int, static>

Fetches any missing information about the part from Discord's servers.

fill()  : void

Fills the parts attributes from an array.

getConstants()  : array<string|int, mixed>

Returns an array of constant names and their values.

getCreatableAttributes()  : array<string|int, mixed>

Returns the attributes needed to create.

getDiscord()  : Discord

Get the Discord instance that owns this Part.

getPublicAttributes()  : array<string|int, mixed>

Returns an array of public attributes.

getRawAttributes()  : array<string|int, mixed>

Returns an array of raw attributes.

getRepository()  : AbstractRepository|null

Gets the originating repository of the part.

getRepositoryAttributes()  : array<string|int, mixed>

Gets the attributes to pass to repositories.

getUpdatableAttributes()  : array<string|int, mixed>

Returns the updatable attributes.

isPartial()  : bool

Whether the part is considered partial i.e. missing information which can be fetched from Discord.

jsonSerialize()  : array<string|int, mixed>

Provides data when the part is encoded into JSON. Used for JsonSerializable.

offsetExists()  : bool

Checks if an attribute exists via key. Used for ArrayAccess.

offsetGet()  : mixed

Gets an attribute via key. Used for ArrayAccess.

offsetSet()  : void

Sets an attribute via key. Used for ArrayAccess.

offsetUnset()  : void

Unsets an attribute via key. Used for ArrayAccess.

save()  : PromiseInterface<string|int, Part>

Save the part with its originating repository.

serialize()  : ?string

Serializes the data. Used for Serializable.

unserialize()  : void

Unserializes some data and stores it. Used for Serializable.

afterConstruct()  : void

Called after the part has been constructed.

attributeCarbonHelper()  : Carbon|null

Helps with getting ISO8601 timestamp attributes.

attributeCollectionHelper()  : ExCollectionInterface

Helps with getting Part attributes.

attributePartHelper()  : Part|null

Helps with getting Part attributes.

attributeTypedCollectionHelper()  : ExCollectionInterface

Helps with getting Part attributes for classes with extended types.

checkForGetMutator()  : string|false

Checks if there is a get mutator present.

checkForSetMutator()  : string|false

Checks if there is a set mutator present.

getAssetsAttribute()  : Assets|null

Gets the assets object of the activity.

getAttribute()  : mixed

Gets an attribute on the part.

getButtonsAttribute()  : ExCollectionInterface<string|int, Button>|array<string|int, Button>|null

Gets the buttons array of the activity.

getCreatedAtAttribute()  : Carbon|null

Gets the created at timestamp.

getEmojiAttribute()  : Emoji|null

Gets the emoji object of the activity.

getPartyAttribute()  : Party|null

Gets the party object of the activity.

getSecretsAttribute()  : Secrets|null

Gets the secrets object of the activity.

getTimestampsAttribute()  : Timestamps|null

Gets the timestamps object of the activity.

makeOptionalAttributes()  : array<string|int, mixed>

Return key-value attributes if it has been filled.

setAttribute()  : void

Sets an attribute on the part.

studly()  : string

Converts a string to studlyCase.