TwitchApi.Chat.GetChatters (TwitchApi v0.1.3) View Source
⛔ This module is autogenerated please do not modify manually.
Example request from twitch api docs:
descriptions:
Gets the list of users that are connected to the specified broadcaster’s chat room.
requests:
curl -X GET 'https://api.twitch.tv/helix/chat/chatters?broadcaster_id=123456&moderator_id=654321'
-H'Authorization: Bearer kpvy3cjboyptmiacwr0c19hotn5s'
-H'Client-Id: hof5gwx0su6owfn0nyan9c87zr6t'
Example response from twitch api docs:
descriptions:
responses:
{"data":[{"user_login":"smittysmithers"},...],"pagination":{"cursor":"eyJiIjpudWxsLCJhIjp7Ik9mZnNldCI6NX19"},"total":8}
Link to this section Summary
Types
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read More
The ID of the broadcaster whose list of chatters you want to get.
The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 1,000. The default is 100.
The ID of the moderator or the specified broadcaster that’s requesting the list of chatters. This ID must match the user ID associated with the user access token.The moderator must have permission to moderate the broadcaster’s chat room.
Link to this section Types
Specs
after_query_param() :: %{after_query_param: String.t()}
The cursor used to get the next page of results. The Pagination object in the response contains the cursor’s value. Read More
Specs
broadcaster_id() :: %{broadcaster_id: String.t()}
The ID of the broadcaster whose list of chatters you want to get.
Specs
first() :: %{first: integer()}
The maximum number of items to return per page in the response. The minimum page size is 1 item per page and the maximum is 1,000. The default is 100.
Specs
moderator_id() :: %{moderator_id: String.t()}
The ID of the moderator or the specified broadcaster that’s requesting the list of chatters. This ID must match the user ID associated with the user access token.The moderator must have permission to moderate the broadcaster’s chat room.
Link to this section Functions
Specs
call(broadcaster_id() | moderator_id() | first() | after_query_param()) :: {:ok, Finch.Response.t()} | {:error, Exception.t()}
Description:
BETA Gets the list of users that are connected to the specified broadcaster’s chat session.
Required authentication:
Required authorization:
Requires a user access token that includes the moderator:read:chatters scope.