DiscordPHP Documentation

VoiceStateUpdate extends Part
in package

Application

Notifies the client of voice state updates about users.

$channel read-only


    public
        Channel|null
    $channel

Channel that the voice state came from, or null if the user is leaving a channel.

$channel_id


    public
        Array|null
    $channel_id

Channel ID that the voice state came from, or null if the user is leaving a channel.

$created

Is the part already created in the Discord servers?


    public
        bool
    $created
     = false

Whether the part has been created.

$deaf


    public
        bool
    $deaf

Whether this user is deafened by the server.

$guild read-only


    public
        Guild|null
    $guild

Guild that the voice state came from, or null if it is for a DM channel.

$guild_id


    public
        string|null
    $guild_id

Guild ID that the voice state came from, or null if it is for a DM channel.

$member


    public
        Member|null
    $member

Member object the voice state is for, null if the voice state is for a DM channel or the member object is not cached.

$mute


    public
        bool
    $mute

Whether this user is muted by the server.

$request_to_speak_timestamp


    public
        Carbon|null
    $request_to_speak_timestamp

The time at which the user requested to speak.

$scriptData

Custom script data.


    public
        mixed
    $scriptData

Used for storing custom information, used by end products.

$self_deaf


    public
        bool
    $self_deaf

Whether this user is locally deafened.

$self_mute


    public
        bool
    $self_mute

Whether this user is locally muted.

$self_stream


    public
        bool|null
    $self_stream

Whether this user is streaming using "Go Live".

$self_video


    public
        bool
    $self_video

Whether this user's camera is enabled.

$session_id


    public
        string
    $session_id

Session ID for the voice state.

$suppress


    public
        bool
    $suppress

Whether this user is muted by the current user.

$user read-only


    public
        User|null
    $user

User the voice state is for, or null if it is not cached.

$user_id


    public
        string
    $user_id

User ID the voice state is for.

$attributes

The parts attributes.


    protected
        array<string|int, mixed>
    $attributes
     = []

The parts attributes and content.

$discord

The Discord client.


    protected
        Discord
    $discord

Client.

$factory

The factory.


    protected
        Factory
    $factory

Factory.

$fillable

The parts fillable attributes.


    protected
        array<string|int, mixed>
    $fillable
     = ['guild_id', 'channel_id', 'user_id', 'member', 'session_id', 'deaf', 'mute', 'self_deaf', 'self_mute', 'self_stream', 'self_video', 'suppress', 'request_to_speak_timestamp']

The array of attributes that can be mass-assigned.

$hidden

Attributes that are hidden from debug info.


    protected
        array<string|int, mixed>
    $hidden
     = []

Attributes that are hidden from public.

$http

The HTTP client.


    protected
        Http
    $http

Client.

$repositories

An array of repositories that can exist in a part.


    protected
        array<string|int, mixed>
    $repositories
     = []

Repositories.

$repositories_cache

An array of repositories.


    protected
        array<string|int, mixed>
    $repositories_cache
     = []

$visible

Attributes which are visible from debug info.


    protected
        array<string|int, mixed>
    $visible
     = []

__construct()

Create a new part instance.


    public
                    __construct(Discord $discord[, array<string|int, mixed> $attributes = [] ][, bool $created = false ]) : mixed

Parameters

$discord : Discord: The Discord client.
$attributes : array<string|int, mixed> = []: An array of attributes to build the part.
$created : bool = false: Whether the part has already been created.

Return values

mixed —

__debugInfo()

Handles debug calls from var_dump and similar functions.


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

Return values

array<string|int, mixed> —

An array of public attributes.

__get()

Handles dynamic get calls onto the part.


    public
                    __get(string $key) : mixed

Parameters

$key : string: The attributes key.

Return values

mixed —

The value of the attribute.

__serialize()


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

Return values

array<string|int, mixed> —

__set()

Handles dynamic set calls onto the part.


    public
                    __set(string $key, mixed $value) : void

Parameters

$key : string: The attributes key.
$value : mixed: The attributes value.

Return values

void —

__toString()

Converts the part to a string.


    public
                    __toString() : string

Return values

string —

A JSON string of attributes.

__unserialize()


    public
                    __unserialize(array<string|int, mixed> $data) : void

Parameters

$data : array<string|int, mixed>

Return values

void —

fetch()

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


    public
                    fetch() : ExtendedPromiseInterface<string|int, self>

Return values

ExtendedPromiseInterface<string|int, self> —

fill()

Fills the parts attributes from an array.


    public
                    fill(array<string|int, mixed> $attributes) : void

Parameters

$attributes : array<string|int, mixed>: An array of attributes to build the part.

Return values

void —

getCreatableAttributes()

Returns the attributes needed to create.


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

Return values

array<string|int, mixed> —

getPublicAttributes()

Returns an array of public attributes.


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

Return values

array<string|int, mixed> —

An array of public attributes.

getRawAttributes()

Returns an array of raw attributes.


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

Return values

array<string|int, mixed> —

Raw attributes.

getRepositoryAttributes()

Gets the attributes to pass to repositories.


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

Note: The order matters for repository tree (top to bottom).

Return values

array<string|int, mixed> —

Attributes.

getUpdatableAttributes()

Returns the updatable attributes.


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

Return values

array<string|int, mixed> —

isPartial()

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


    public
                    isPartial() : bool

Return values

bool —

jsonSerialize()

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


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

Return values

array<string|int, mixed> —

An array of public attributes.

offsetExists()

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


    public
                    offsetExists(string $key) : bool

Parameters

$key : string: The attribute key.

Return values

bool —

Whether the offset exists.

offsetGet()

Gets an attribute via key. Used for ArrayAccess.


    public
                    offsetGet(string $key) : mixed

Parameters

$key : string: The attribute key.

Return values

mixed —

offsetSet()

Sets an attribute via key. Used for ArrayAccess.


    public
                    offsetSet(string $key, mixed $value) : void

Parameters

$key : string: The attribute key.
$value : mixed: The attribute value.

Return values

void —

offsetUnset()

Unsets an attribute via key. Used for ArrayAccess.


    public
                    offsetUnset(string $key) : void

Parameters

$key : string: The attribute key.

Return values

void —

serialize()

Serializes the data. Used for Serializable.


    public
                    serialize() : string|null

Return values

string|null —

A string of serialized data.

unserialize()

Unserializes some data and stores it. Used for Serializable.


    public
                    unserialize(string $data) : void

Parameters

$data : string: Some serialized data.

Return values

void —

afterConstruct()

Called after the part has been constructed.


    protected
                    afterConstruct() : void

Return values

void —

getChannelAttribute()

Gets the channel attribute.


    protected
                    getChannelAttribute() : Channel|null

Return values

Channel|null —

The channel attribute.

getGuildAttribute()

Gets the guild attribute.


    protected
                    getGuildAttribute() : Guild|null

Return values

Guild|null —

The guild attribute.

getMemberAttribute()

Gets the member attribute.


    protected
                    getMemberAttribute() : Member|null

Return values

Member|null —

The member attribute.

getRequestToSpeakTimestampAttribute()

Gets the request_to_speak_timestamp attribute.


    protected
                    getRequestToSpeakTimestampAttribute() : Carbon|null

Return values

Carbon|null —

getUserAttribute()

Gets the user attribute.


    protected
                    getUserAttribute() : User|null

Return values

User|null —

The user attribute.

checkForMutator()

Checks if there is a mutator present.


    private
                    checkForMutator(string $key, string $type) : string|false

Parameters

$key : string: The attribute name to check.
$type : string: Either get or set.

Return values

string|false —

Either a string if it is callable or false.

getAttribute()

Gets an attribute on the part.


    private
                    getAttribute(string $key) : mixed

Parameters

$key : string: The key to the attribute.

Return values

mixed —

Either the attribute if it exists or void.

setAttribute()

Sets an attribute on the part.


    private
                    setAttribute(string $key, mixed $value) : void

Parameters

$key : string: The key to the attribute.
$value : mixed: The value of the attribute.

Return values

void —

studly()

Converts a string to studlyCase.


    private
            static        studly(string $string) : string

This is a port of updated Laravel's implementation, a non-regex with static cache. The Discord\studly() is kept due to unintended bug and we do not want to introduce BC by replacing it. This method is private static as we may move it outside this class in future.

Parameters

$string : string: The string to convert.

Return values

string —

VoiceStateUpdate extends Part in package Application

Tags

Table of Contents

Properties

$channel read-only

$channel_id

$created

$deaf

$guild read-only

$guild_id

$member

$mute

$request_to_speak_timestamp

$scriptData

Tags

$self_deaf

$self_mute

$self_stream

$self_video

$session_id

$suppress

$user read-only

$user_id

$attributes

$discord

$factory

$fillable

$hidden

$http

$repositories

$repositories_cache

$visible

Methods

__construct()

Parameters

Return values

__debugInfo()

Tags

Return values

__get()

Parameters

Tags

Return values

__serialize()

Return values

__set()

Parameters

Tags

Return values

__toString()

Tags

Return values

__unserialize()

Parameters

Return values

fetch()

Tags

Return values

fill()

Parameters

Return values

getCreatableAttributes()

Return values

getPublicAttributes()

Tags

Return values

getRawAttributes()

Return values

getRepositoryAttributes()

Return values

getUpdatableAttributes()

Return values

isPartial()

Return values

jsonSerialize()

Tags

Return values

offsetExists()

Parameters

Return values

VoiceStateUpdate extends Part
in package

Application