Overview
Can be accessed using client.helix.moderation on an ApiClient instance.
Example
const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
const { data: users } = await api.helix.moderation.getBannedUsers('61369223');
Methods
checkUserBan(channel, user)
asyncChecks whether a given user is banned in a given channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | UserIdResolvable | none | The channel to check for a ban of the given user. | |
| user | UserIdResolvable | none | The user to check for a ban in the given channel. |
checkUserMod(channel, user)
asyncChecks whether a given user is a moderator of a given channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | UserIdResolvable | none | The channel to check. | |
| user | UserIdResolvable | none | The user to check. |
getBanEvents(channel, filter)
asyncRetrieves a list of ban events for a given channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | UserIdResolvable | none | The channel to retrieve the ban events from. | |
| filter | HelixBanFilter | none | Additional filters for the result set. |
getBanEventsPaginated(channel)
Creates a paginator for ban events for a given channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | UserIdResolvable | none | The channel to retrieve the ban events from. |
getBannedUsers(channel, filter)
asyncRetrieves a list of banned users in a given channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | UserIdResolvable | none | The channel to retrieve the banned users from. | |
| filter | HelixBanFilter | none | Additional filters for the result set. |
getBannedUsersPaginated(channel)
Creates a paginator for banned users in a given channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | UserIdResolvable | none | The channel to retrieve the banned users from. |
getModeratorEvents(channel, filter)
asyncRetrieves a list of moderator events for a given channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | UserIdResolvable | none | The channel to retrieve the moderator events from. | |
| filter | HelixModeratorFilter | none | Additional filters for the result set. |
getModeratorEventsPaginated(channel)
Creates a paginator for moderator events for a given channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | UserIdResolvable | none | The channel to retrieve the moderator events from. |
getModerators(channel, filter)
asyncRetrieves a list of moderators in a given channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | UserIdResolvable | none | The channel to retrieve moderators from. | |
| filter | HelixModeratorFilter | none | Additional filters for the result set. |
getModeratorsPaginated(channel)
Creates a paginator for moderators in a given channel.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| channel | UserIdResolvable | none | The channel to retrieve moderators from. |
processHeldAutoModMessage(user, msgId, allow)
asyncProcesses a message held by AutoMod.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| user | UserIdResolvable | none | The user who is processing the message. | |
| msgId | string | none | The ID of the message. | |
| allow | boolean | none | Whether to allow the message - |