Teac.Api.Channels (teac v0.2.0)
View SourceSummary
Functions
Gets information about one or more channels.
Modify Channel Information Updates a channel’s properties.
Functions
@spec get( opts :: [ broadcaster_ids: [integer()], token: String.t(), client_id: String.t() | nil ] ) :: {:ok, map()} | {:error, any()}
@spec get( opts :: [ broadcaster_id: String.t(), token: String.t(), client_id: String.t() | nil ] ) :: {:ok, map()} | {:error, any()}
Gets information about one or more channels.
Authorization
Requires an app access token or user access token.
Opts Arrgument keys
broadcaster_ids : required list of one of more broadcaster_ids Max 100 IDs, ignores duplicates and not found.
token : required (app or user)
client_id : optinal (defaults to Teac.client_id())
Examples
iex> Teac.Api.Channels.get([123, 234], "some_token")
iex> Teac.Api.Channels.get([123, 234], "some_token", "some_client_id")
{:ok,
{
"broadcaster_id" => "1",
"broadcaster_login" => "twitchdev",
"broadcaster_name" => "TwitchDev",
"broadcaster_language" => "en",
"game_id" => "509670",
"game_name" => "Science & Technology",
"title" => "TwitchDev Monthly Update // May 6, 2021",
"delay" => 0,
"tags" => ["DevsInTheKnow"],
"content_classification_labels" => ["Gambling", "DrugsIntoxication", "MatureGame"],
"is_branded_content" => false
}...
}
Modify Channel Information Updates a channel’s properties.
Authorization
Requires a user access token that includes the channel:manage:broadcast scope.
Opts Arrgument keys
- token : required user token
- client_id : optinal (defaults to Teac.client_id())
- broadcaster_id: String - required
The ID of the broadcaster whose channel you want to update. This ID must match the user ID in the user access token.
- form : required - Map (At leaste one key is required)
- game_id: String - optional - Unset with 0 or ""
- broadcaster_language: - String - optinal (ISO 639-1 two-letter language code)
- title: String - optional
- delay: integer - optional
- tags: list of strings - optional (max 10 tax, max 25 chars per tag)
- content_classification_labels - Map - optional
id: String - required
is_enabled: boolean - requiredcan be one of the following: * DebatedSocialIssuesAndPolitics * DrugsIntoxication * SexualThemes * ViolentGraphic * Gambling * ProfanityVulgarity
- is_branded_content: boolean - optional