HasGuestStarMethods

trait Zairakai\LaravelTwitch\Services\Concerns\HasGuestStarMethods

Twitch Guest Star API methods.

Source: src/Services/Concerns/HasGuestStarMethods.php

Methods

assignGuestStarSlot()

public function assignGuestStarSlot(string $broadcasterId, string $moderatorId, string $sessionId, string $guestId, string $slotId): void

Assign a user to a slot in the active Guest Star session.

createGuestStarSession()

public function createGuestStarSession(string $broadcasterId): GuestStarSession

Create a new Guest Star session for the broadcaster.

deleteGuestStarInvite()

public function deleteGuestStarInvite(string $broadcasterId, string $moderatorId, string $sessionId, string $guestId): void

Revoke a previously sent Guest Star invitation for a user.

deleteGuestStarSlot()

public function deleteGuestStarSlot(string $broadcasterId, string $moderatorId, string $sessionId, string $guestId, string $slotId): void

Remove a user from their slot in the active Guest Star session.

endGuestStarSession()

public function endGuestStarSession(string $broadcasterId, string $sessionId): GuestStarSession

End an active Guest Star session for the broadcaster.

getChannelGuestStarSettings()

public function getChannelGuestStarSettings(string $broadcasterId, string $moderatorId): GuestStarSettings

Get settings for the broadcaster's Guest Star feature.

getGuestStarInvites()

public function getGuestStarInvites(string $broadcasterId, string $moderatorId, string $sessionId): DataCollection

Get a list of pending invitations for a Guest Star session.

Returns DataCollection<int, GuestStarInvite>

getGuestStarSession()

public function getGuestStarSession(string $broadcasterId, string $moderatorId): GuestStarSession

Get the active Guest Star session for the broadcaster's channel.

sendGuestStarInvite()

public function sendGuestStarInvite(string $broadcasterId, string $moderatorId, string $sessionId, string $guestId): void

Send an invitation to a specified user to be a guest for a Guest Star session.

updateChannelGuestStarSettings()

public function updateChannelGuestStarSettings(string $broadcasterId, string $moderatorId, UpdateGuestStarSettingsRequest $updateGuestStarSettingsRequest): void

Update settings for the broadcaster's Guest Star feature.

updateGuestStarSlot()

public function updateGuestStarSlot(string $broadcasterId, string $moderatorId, string $sessionId, string $sourceSlotId, string $destinationSlotId = null): void

Move a user from one Guest Star slot to another in the active session.

updateGuestStarSlotSettings()

public function updateGuestStarSlotSettings(string $broadcasterId, string $moderatorId, string $sessionId, string $slotId, UpdateGuestStarSlotSettingsRequest $updateGuestStarSlotSettingsRequest): void

Update settings for a Guest Star slot in the active session.