TwitchApi.Moderation.GetAutoModSettings (TwitchApi v0.1.3) View Source
⛔ This module is autogenerated please do not modify manually.
Example request from twitch api docs:
descriptions:
This example gets the broadcaster’s AutoMod settings. This example shows what the response looks like if the broadcaster hasn’t enabled AutoMod.
requests:
curl -X GET 'https://api.twitch.tv/helix/moderation/automod/settings?broadcaster_id=1234&moderator_id=5678'
-H'Authorization: Bearer 4a4x78f5wqvkybms7mxfist3jmzul'
-H'Client-Id: t214nt8z1rdtbj69hyarjvh5mi6fh'
Example response from twitch api docs:
descriptions:
responses:
{"data":[{"broadcaster_id":"1234","moderator_id":"5678","overall_level":null,"disability":0,"aggression":0,"sexuality_sex_or_gender":0,"misogyny":0,"bullying":0,"swearing":0,"race_ethnicity_or_religion":0,"sex_based_terms":0}]}
Link to this section Summary
Types
The ID of the broadcaster whose AutoMod settings you want to get.
The ID of a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID associated with the user OAuth token.If the broadcaster wants to get their own AutoMod settings (instead of having the moderator do it), set this parameter to the broadcaster’s ID, too.
Link to this section Types
Specs
broadcaster_id() :: %{broadcaster_id: String.t()}
The ID of the broadcaster whose AutoMod settings you want to get.
Specs
moderator_id() :: %{moderator_id: String.t()}
The ID of a user that has permission to moderate the broadcaster’s chat room. This ID must match the user ID associated with the user OAuth token.If the broadcaster wants to get their own AutoMod settings (instead of having the moderator do it), set this parameter to the broadcaster’s ID, too.
Link to this section Functions
Specs
call(broadcaster_id() | moderator_id()) :: {:ok, Finch.Response.t()} | {:error, Exception.t()}
Description:
Gets the broadcaster’s AutoMod settings.
Required authentication:
Required authorization:
Requires a User access token with scope set to moderator:read:automod_settings.