HasConduitsMethods

trait Zairakai\LaravelTwitch\Services\Concerns\HasConduitsMethods

Twitch Conduits API methods.

Conduits are a transport for EventSub that enables high-scale, multi-shard deployments.

Source: src/Services/Concerns/HasConduitsMethods.php

Methods

createConduit()

public function createConduit(int $shardCount): Conduit

Create a new conduit for routing EventSub subscriptions to multiple shards.

Parameter	Description
$shardCount	Number of shards (1-20000)

deleteConduit()

public function deleteConduit(string $conduitId): void

Delete a specified conduit.

getConduits()

public function getConduits(): DataCollection

Get information about conduits for the app access token.

Returns DataCollection<int, Conduit>

getConduitShards()

public function getConduitShards(string $conduitId, string $status = null, string $after = null): PaginatedResult

Get the shards associated with a conduit.

Parameter	Description
$status	Filter by shard status (enabled, webhook_callback_verification_pending, etc.)

Returns PaginatedResult<ConduitShard>

updateConduit()

public function updateConduit(string $conduitId, int $shardCount): Conduit

Update the number of shards for a conduit.

Parameter	Description
$shardCount	New number of shards

updateConduitShards()

public function updateConduitShards(string $conduitId, array $shards): DataCollection

Update the transport for shards of a conduit.

Parameter	Description
$shards	Shards to update

Returns DataCollection<int, ConduitShard>