TwitchApi.Chat.GetChatSettings (TwitchApi v0.1.3) View Source
⛔ This module is autogenerated please do not modify manually.
Example request from twitch api docs:
descriptions:
requests:
curl -X GET 'https://api.twitch.tv/helix/chat/settings?broadcaster_id=1234'
-H'Authorization: Bearer 4a4x78f5wqvkybms7mxfist3jmzul'
-H'Client-Id: t214nt8z1rdtbj69hyarjvh5mi6fh'
Example response from twitch api docs:
descriptions:
responses:
{"data":[{"broadcaster_id":"713936733","slow_mode":false,"slow_mode_wait_time":null,"follower_mode":true,"follower_mode_duration":0,"subscriber_mode":false,"emote_mode":false,"unique_chat_mode":false,"non_moderator_chat_delay":true,"non_moderator_chat_delay_duration":4}]}
Link to this section Summary
Types
The ID of the broadcaster whose chat settings you want to get.
Required only to access the non_moderator_chat_delay or non_moderator_chat_delay_duration settings.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 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 chat settings you want to get.
Specs
moderator_id() :: %{moderator_id: String.t()}
Required only to access the non_moderator_chat_delay or non_moderator_chat_delay_duration settings.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 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 chat settings.
Required authentication:
Required authorization:
Requires an App access token. However, to include the non_moderator_chat_delay or non_moderator_chat_delay_duration settings in the response, you must specify a User access token with scope set to moderator:read:chat_settings.