TwitchApi.Moderation.GetModerators (TwitchApi v0.1.3) View Source
⛔ This module is autogenerated please do not modify manually.
Example request from twitch api docs:
descriptions:
This request returns any moderators for Broadcaster ID 198704263.
requests:
curl -X GET 'https://api.twitch.tv/helix/moderation/moderators?broadcaster_id=198704263'
-H'Authorization: Bearer cfabdegwdoklmawdzdo98xt2fo512y'
-H'Client-Id: uo6dggojyb8d6soh92zknwmi5ej1q2'
Example response from twitch api docs:
descriptions:
responses:
{"data":[{"user_id":"424596340","user_login":"quotrok","user_name":"quotrok"},...],"pagination":{"cursor":"eyJiIjpudWxsLCJhIjp7IkN1cnNvciI6IjEwMDQ3MzA2NDo4NjQwNjU3MToxSVZCVDFKMnY5M1BTOXh3d1E0dUdXMkJOMFcifX0"}}
Link to this section Summary
Types
Cursor for forward pagination: tells the server where to start fetching the next set of results in a multi-page response. This applies only to queries without user_id. If a user_id is specified, it supersedes any cursor/offset combinations. The cursor value specified here is from the pagination response field of a prior query.
Provided broadcaster_id must match the user_id in the auth token. Maximum: 1
Maximum number of objects to return. Maximum: 100. Default: 20.
Filters the results and only returns a status object for users who are moderators in this channel and have a matching user_id.Format: Repeated Query Parameter, eg. /moderation/moderators?broadcaster_id=1&user_id=2&user_id=3Maximum: 100
Link to this section Types
Specs
after_query_param() :: %{after_query_param: String.t()}
Cursor for forward pagination: tells the server where to start fetching the next set of results in a multi-page response. This applies only to queries without user_id. If a user_id is specified, it supersedes any cursor/offset combinations. The cursor value specified here is from the pagination response field of a prior query.
Specs
broadcaster_id() :: %{broadcaster_id: String.t()}
Provided broadcaster_id must match the user_id in the auth token. Maximum: 1
Specs
first() :: %{first: String.t()}
Maximum number of objects to return. Maximum: 100. Default: 20.
Specs
user_id() :: %{user_id: String.t()}
Filters the results and only returns a status object for users who are moderators in this channel and have a matching user_id.Format: Repeated Query Parameter, eg. /moderation/moderators?broadcaster_id=1&user_id=2&user_id=3Maximum: 100
Link to this section Functions
Specs
call(broadcaster_id() | user_id() | first() | after_query_param()) :: {:ok, Finch.Response.t()} | {:error, Exception.t()}
Description:
Returns all moderators in a channel.
Required authentication:
Required authorization:
Requires a user access token that includes the moderation:read scope. If your app also adds and removes moderators, you can use the channel:manage:moderators scope instead. The ID in the broadcaster_id query parameter must match the user ID in the access token.