Appearance
HasModerationMethods
php
trait Zairakai\LaravelTwitch\Services\Concerns\HasModerationMethodsTwitch Moderation API methods.
Source: src/Services/Concerns/HasModerationMethods.php
Methods
addBlockedTerm()
php
public function addBlockedTerm(string $broadcasterId, string $moderatorId, string $text): BlockedTermAdd a blocked term to the broadcaster's channel.
addModerator()
php
public function addModerator(string $broadcasterId, string $userId): voidAdd a moderator to a broadcaster's channel.
addSuspiciousUser()
php
public function addSuspiciousUser(string $broadcasterId, string $moderatorId, string $targetUserId, string $status): SuspiciousUserMark a user as suspicious or restricted in the broadcaster's channel.
| Parameter | Description |
|---|---|
$status | suspicious or restricted |
addVip()
php
public function addVip(string $broadcasterId, string $userId): voidAdd a VIP to the broadcaster's channel.
banUser()
php
public function banUser(string $broadcasterId, string $moderatorId, string $userId, string $reason = null): BanResultBan a user from a broadcaster's chat permanently.
checkAutoModStatus()
php
public function checkAutoModStatus(string $broadcasterId, array $messages): DataCollectionCheck whether AutoMod would flag the specified messages.
| Parameter | Description |
|---|---|
$messages | Messages to check |
Returns DataCollection<int, AutoModCheckResult>
getAutoModSettings()
php
public function getAutoModSettings(string $broadcasterId, string $moderatorId): AutoModSettingsGet the broadcaster's AutoMod settings.
getBannedUsers()
php
public function getBannedUsers(string $broadcasterId, string $userId = null, int $first = 20, string $after = null): PaginatedResultGet the list of banned or timed out users for a broadcaster.
Returns PaginatedResult<BannedUser>
getBlockedTerms()
php
public function getBlockedTerms(string $broadcasterId, string $moderatorId, int $first = 20, string $after = null): PaginatedResultGet the broadcaster's blocked terms.
Returns PaginatedResult<BlockedTerm>
getModeratedChannels()
php
public function getModeratedChannels(string $userId, string $after = null, int $first = 20): PaginatedResultGet the list of channels where the user has moderator privileges.
Returns PaginatedResult<ModeratedChannel>
getModerators()
php
public function getModerators(string $broadcasterId, string $userId = null, int $first = 20, string $after = null): PaginatedResultGet the list of moderators for a broadcaster's channel.
Returns PaginatedResult<Moderator>
getShieldMode()
php
public function getShieldMode(string $broadcasterId, string $moderatorId): ShieldModeGet the broadcaster's Shield Mode status.
getUnbanRequests()
php
public function getUnbanRequests(string $broadcasterId, string $moderatorId, string $status, string $userId = null, string $after = null, int $first = 20): PaginatedResultGet a list of unban requests for a broadcaster's channel.
| Parameter | Description |
|---|---|
$status | pending, approved, denied, acknowledged, or cancelled |
Returns PaginatedResult<UnbanRequest>
getVips()
php
public function getVips(string $broadcasterId, string $userId = null, int $first = 20, string $after = null): PaginatedResultGet the list of VIPs for a broadcaster's channel.
Returns PaginatedResult<Vip>
manageHeldMessage()
php
public function manageHeldMessage(string $userId, string $msgId, string $action): voidAllow or deny a message that AutoMod flagged.
| Parameter | Description |
|---|---|
$action | ALLOW or DENY |
removeBlockedTerm()
php
public function removeBlockedTerm(string $broadcasterId, string $moderatorId, string $termId): voidRemove a blocked term from the broadcaster's channel.
removeModerator()
php
public function removeModerator(string $broadcasterId, string $userId): voidRemove a moderator from a broadcaster's channel.
removeSuspiciousUser()
php
public function removeSuspiciousUser(string $broadcasterId, string $moderatorId, string $targetUserId): voidRemove the suspicious or restricted status from a user.
removeVip()
php
public function removeVip(string $broadcasterId, string $userId): voidRemove a VIP from the broadcaster's channel.
resolveUnbanRequest()
php
public function resolveUnbanRequest(string $broadcasterId, string $moderatorId, string $unbanRequestId, string $status, string $resolution = null): UnbanRequestResolve an unban request (approve or deny).
| Parameter | Description |
|---|---|
$status | approved or denied |
$resolution | Optional resolution message (max 500 chars) |
setShieldMode()
php
public function setShieldMode(string $broadcasterId, string $moderatorId, bool $isActive): ShieldModeActivate or deactivate the broadcaster's Shield Mode.
timeoutUser()
php
public function timeoutUser(string $broadcasterId, string $moderatorId, string $userId, int $duration, string $reason = null): BanResultTimeout a user in a broadcaster's chat for a given duration.
| Parameter | Description |
|---|---|
$duration | Duration in seconds (max 1,209,600 = 2 weeks) |
unbanUser()
php
public function unbanUser(string $broadcasterId, string $moderatorId, string $userId): voidRemove the ban or timeout that was placed on a user.
updateAutoModSettings()
php
public function updateAutoModSettings(string $broadcasterId, string $moderatorId, UpdateAutoModSettingsRequest $updateAutoModSettingsRequest): AutoModSettingsUpdate the broadcaster's AutoMod settings.
warnUser()
php
public function warnUser(string $broadcasterId, string $moderatorId, string $userId, string $reason = null): WarnedUserWarn a user in the broadcaster's chat.