DiscordPHP Documentation

VoiceStateRepository extends AbstractRepository
in package

Application

Contains voice states of users in a guild.

Properties

$cache : CacheWrapper
$discrim : string
$class : string: Class type allowed into the collection.
$discord : mixed
$endpoints : array<string|int, mixed>: Endpoints for interacting with the Discord servers.
$factory : Factory: The parts factory.
$http : Http: The HTTP client.
$items : array<string|int, mixed>: The items contained in the collection.
$vars : array<string|int, mixed>: Variables that are related to the repository.

Methods

__call() : mixed: This method checks if a method with the name "__Collection__{$name}" exists within the class. If it does, it calls that method with the provided arguments.
__construct() : mixed: AbstractRepository constructor.
__debugInfo() : array<string|int, mixed>
__get() : mixed
clear() : void: Clears the repository.
create() : Part: Builds a new, empty part.
delete() : PromiseInterface<string|int, Part>: Attempts to delete a part on the Discord servers.
fetch() : PromiseInterface<string|int, VoiceStateUpdate>: Gets a part from the repository or Discord servers.
filter() : ExCollectionInterface: Runs a filter callback over the repository and returns a new collection based on the response of the callback.
find() : VoiceStateUpdate|null
first() : VoiceStateUpdate|null
fresh() : PromiseInterface<string|int, VoiceStateUpdate>: Returns a part with fresh values.
freshen() : PromiseInterface<string|int, static>: Freshens the repository cache.
get() : VoiceStateUpdate|null
getCurrentUserVoiceState() : PromiseInterface<string|int, VoiceStateUpdate>: Returns the current user's voice state in the guild.
getIterator() : Traversable: Returns an iterator for the cache.
getUserVoiceState() : PromiseInterface<string|int, VoiceStateUpdate>: Returns the specified user's voice state in the guild.
getVoiceRegions() : PromiseInterface<string|int, Collection>: Gets the voice regions available.
has() : bool: Checks if the array has an object.
jsonSerialize() : array<string|int, mixed>
keys() : array<string|int, int>|array<string|int, string>: Get the keys of the items.
last() : VoiceStateUpdate|null
modifyCurrentUserVoiceState() : PromiseInterface: Modify the current user's voice state in the guild.
modifyUserVoiceState() : PromiseInterface: Updates another user's voice state.
offsetExists() : bool: If the repository has an offset.
offsetGet() : Part|null: Gets a part from the repository.
offsetSet() : void: Sets a part into the repository.
offsetUnset() : void: Unsets an index from the repository.
pull() : VoiceStateUpdate|null
pushItem() : self: Pushes a single item to the repository.
save() : PromiseInterface<string|int, VoiceStateUpdate>: Attempts to save a part to the Discord servers.
set() : mixed: Sets a part in the repository.
toArray() : array<string|int, mixed>: Converts the weak caches to array.
values() : array<string|int, mixed>: Get the values of the items.
cacheFreshen() : PromiseInterface<string|int, static>

$cache read-only


        public
            CacheWrapper
    $cache

The react/cache wrapper.

$discrim


        public
            string
    $discrim

The discriminator.

$class

Class type allowed into the collection.


        protected
            string
    $class
     = \Discord\Parts\WebSockets\VoiceStateUpdate::class

$discord


        protected
            mixed
    $discord

$endpoints

Endpoints for interacting with the Discord servers.


        protected
            array<string|int, mixed>
    $endpoints
     = ['get' => \Discord\Http\Endpoint::GUILD_USER_VOICE_STATE, 'update' => \Discord\Http\Endpoint::GUILD_USER_VOICE_STATE]

Endpoints.

$factory

The parts factory.


        protected
            Factory
    $factory

Parts factory.

$http

The HTTP client.


        protected
            Http
    $http

Client.

$items

The items contained in the collection.


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

$vars

Variables that are related to the repository.


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

Variables.

__call()

This method checks if a method with the name "__Collection__{$name}" exists within the class. If it does, it calls that method with the provided arguments.


    public
                    __call(string $name, array<string|int, mixed> $arguments) : mixed

If the method does not exist, it throws a BadMethodCallException.

Previously, this class utilized parent::method to call methods from the parent class. This was changed to use the __Collection__method naming convention to avoid conflicts

Parameters

$name : string: The name of the method being called.
$arguments : array<string|int, mixed>: The arguments passed to the method.

Return values

mixed —

The result of the called method.

__construct()

AbstractRepository constructor.


    public
                    __construct(Discord $discord[, array<string|int, mixed> $vars = [] ]) : mixed

Parameters

$discord : Discord
$vars : array<string|int, mixed> = []: An array of variables used for the endpoint.

__debugInfo()


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

Return values

array<string|int, mixed>

__get()


    public
                    __get(string $key) : mixed

Parameters

$key : string

clear()

Clears the repository.


    public
                    clear() : void

Use async $repository->cache->clear()

create()

Builds a new, empty part.


    public
                    create([array<string|int, mixed>|object $attributes = [] ][, bool $created = false ]) : Part

Parameters

$attributes : array<string|int, mixed>|object = []: The attributes for the new part.
$created : bool = false

Return values

Part —

The new part.

delete()

Attempts to delete a part on the Discord servers.


    public
                    delete(Part|string $part[, string|null $reason = null ]) : PromiseInterface<string|int, Part>

Parameters

$part : Part|string: The part to delete.
$reason : string|null = null: Reason for Audit Log (if supported).

Return values

PromiseInterface<string|int, Part>

fetch()

Gets a part from the repository or Discord servers.


    public
                    fetch(string $id[, bool $fresh = false ]) : PromiseInterface<string|int, VoiceStateUpdate>

Parameters

$id : string: The ID to search for.
$fresh : bool = false: Whether we should skip checking the cache.

Return values

PromiseInterface<string|int, VoiceStateUpdate>

filter()

Runs a filter callback over the repository and returns a new collection based on the response of the callback.


    public
                    filter(callable $callback) : ExCollectionInterface

Parameters

$callback : callable

Return values

ExCollectionInterface

find()


    public
                    find(callable $callback) : VoiceStateUpdate|null

Parameters

$callback : callable

Return values

VoiceStateUpdate|null

first()


    public
                    first() : VoiceStateUpdate|null

Return values

VoiceStateUpdate|null

fresh()

Returns a part with fresh values.


    public
                    fresh(VoiceStateUpdate $part[, array<string|int, mixed> $queryparams = [] ]) : PromiseInterface<string|int, VoiceStateUpdate>

Parameters

$part : VoiceStateUpdate: The part to get fresh values.
$queryparams : array<string|int, mixed> = []: Query string params to add to the request (no validation)

Return values

PromiseInterface<string|int, VoiceStateUpdate>

freshen()

Freshens the repository cache.


    public
                    freshen([array<string|int, mixed> $queryparams = [] ]) : PromiseInterface<string|int, static>

Parameters

$queryparams : array<string|int, mixed> = []: Query string params to add to the request (no validation)

Return values

PromiseInterface<string|int, static>

get()


    public
                    get(string $discrim, mixed $key) : VoiceStateUpdate|null

Parameters

$discrim : string
$key : mixed

Return values

VoiceStateUpdate|null

getCurrentUserVoiceState()

Returns the current user's voice state in the guild.


    public
                    getCurrentUserVoiceState(Guild|string $guild) : PromiseInterface<string|int, VoiceStateUpdate>

Parameters

$guild : Guild|string: The guild or guild ID.

Return values

PromiseInterface<string|int, VoiceStateUpdate>

getIterator()

Returns an iterator for the cache.


    public
                &    getIterator() : Traversable

Return values

Traversable

getUserVoiceState()

Returns the specified user's voice state in the guild.


    public
                    getUserVoiceState(Guild|string $guild, Member|User|string $user) : PromiseInterface<string|int, VoiceStateUpdate>

Parameters

$guild : Guild|string: The guild or guild ID.
$user : Member|User|string: The user or user ID.

Return values

PromiseInterface<string|int, VoiceStateUpdate>

getVoiceRegions()

Gets the voice regions available.


    public
                    getVoiceRegions() : PromiseInterface<string|int, Collection>

Use Discord::listVoiceRegions instead.

Return values

PromiseInterface<string|int, Collection>

has()

Checks if the array has an object.


    public
                    has(string|int ...$keys) : bool

Use async $repository->cache->has()

Parameters

$keys : string|int

Return values

bool

jsonSerialize()


    public
                    jsonSerialize([bool $assoc = true ]) : array<string|int, mixed>

Parameters

$assoc : bool = true

Return values

array<string|int, mixed>

keys()

Get the keys of the items.


    public
                    keys() : array<string|int, int>|array<string|int, string>

Return values

array<string|int, int>|array<string|int, string>

last()


    public
                    last() : VoiceStateUpdate|null

Return values

VoiceStateUpdate|null

modifyCurrentUserVoiceState()

Modify the current user's voice state in the guild.


    public
                    modifyCurrentUserVoiceState(Guild|string $guild, array<string|int, mixed> $data) : PromiseInterface

Caveats:

channel_id must currently point to a stage channel.
Current user must already have joined channel_id.
You must have the MUTE_MEMBERS permission to unsuppress yourself. You can always suppress yourself.
You must have the REQUEST_TO_SPEAK permission to request to speak. You can always clear your own request to speak.
You are able to set request_to_speak_timestamp to any present or future time.

Parameters

$guild : Guild|string: The guild or guild ID.
$data : array<string|int, mixed>

Return values

PromiseInterface

modifyUserVoiceState()

Updates another user's voice state.


    public
                    modifyUserVoiceState(Guild|string $guild, Mmeber|User|string $user, array<string|int, mixed> $data) : PromiseInterface

Caveats:

channel_id must currently point to a stage channel.
User must already have joined channel_id.
You must have the MUTE_MEMBERS permission. (Since suppression is the only thing that is available currently.)
When unsuppressed, non-bot users will have their request_to_speak_timestamp set to the current time. Bot users will not.
When suppressed, the user will have their request_to_speak_timestamp removed.

Parameters

$guild : Guild|string: The guild or guild ID.
$user : Mmeber|User|string: The user ID.
$data : array<string|int, mixed>

Return values

PromiseInterface

offsetExists()

If the repository has an offset.


    public
                    offsetExists(string|int $offset) : bool

Use async $repository->cache->has() This method is deprecated for userland code but can still be used internally within the library.

Parameters

$offset : string|int

Return values

bool

offsetGet()

Gets a part from the repository.


    public
                    offsetGet(string|int $offset) : Part|null

Use async $repository->cacheGet() or sync $repository->get() This method is deprecated for userland code but can still be used internally within the library.

Parameters

$offset : string|int

Return values

Part|null

offsetSet()

Sets a part into the repository.


    public
                    offsetSet(string|int $offset, Part|null $value) : void

Use async $repository->cache->set()

Parameters

$offset : string|int
$value : Part|null

offsetUnset()

Unsets an index from the repository.


    public
                    offsetUnset(string|int $offset) : void

Use async $repository->cache->delete()

Parameters

$offset : string|int

pull()


    public
                    pull(string|int $key[, mixed $default =  = 'null' ]) : VoiceStateUpdate|null

Parameters

$key : string|int
$default : mixed = = 'null'

Return values

VoiceStateUpdate|null

pushItem()

Pushes a single item to the repository.


    public
                    pushItem(Part $item) : self

Use async $repository->cache->set() This method is deprecated for userland code but can still be used internally within the library.

Parameters

$item : Part

Return values

self

save()

Attempts to save a part to the Discord servers.


    public
                    save(VoiceStateUpdate $part[, string|null $reason = null ]) : PromiseInterface<string|int, VoiceStateUpdate>

Parameters

$part : VoiceStateUpdate: The part to save.
$reason : string|null = null: Reason for Audit Log (if supported).

Return values

PromiseInterface<string|int, VoiceStateUpdate>

set()

Sets a part in the repository.


    public
                    set(string|int $offset, Part $value) : mixed

Parameters

$offset : string|int
$value : Part

toArray()

Converts the weak caches to array.


    public
                    toArray([bool $assoc = true ]) : array<string|int, mixed>

Use jsonSerialize

Parameters

$assoc : bool = true

Return values

array<string|int, mixed>

values()

Get the values of the items.


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

Return values

array<string|int, mixed>

cacheFreshen()


    protected
                    cacheFreshen(object $response) : PromiseInterface<string|int, static>

Parameters

$response : object

Return values

PromiseInterface<string|int, static>

VoiceStateRepository extends AbstractRepository in package Application

Tags

Table of Contents

Properties

Methods

Properties

$cache read-only

$discrim

$class

Tags

$discord

$endpoints

Tags

$factory

$http

$items

$vars

Methods

__call()

Parameters

Tags

Return values

__construct()

Parameters

__debugInfo()

Return values

__get()

Parameters

clear()

create()

Parameters

Tags

Return values

delete()

Parameters

Tags

Return values

fetch()

Parameters

Tags

Return values

filter()

Parameters

Tags

Return values

find()

Parameters

Return values

first()

Return values

fresh()

Parameters

Tags

Return values

freshen()

Parameters

Tags

Return values

get()

Parameters

Return values

getCurrentUserVoiceState()

Parameters

Tags

Return values

getIterator()

Return values

getUserVoiceState()

Parameters

Tags

Return values

getVoiceRegions()

Tags

Return values

has()

Parameters

Return values

jsonSerialize()

Parameters

Tags

VoiceStateRepository extends AbstractRepository
in package

Application