TwitchApi.Schedule.GetChannelStreamSchedule (TwitchApi v0.1.2) View Source

⛔ This module is autogenerated please do not modify manually.

Example request from twitch api docs:

descriptions:

Returns all scheduled events from the TwitchDev channel’s stream schedule.

requests:

curl -X GET 'https://api.twitch.tv/helix/schedule?broadcaster_id=141981764'
-H'Authorization: Bearer cfabdegwdoklmawdzdo98xt2fo512y'
-H'Client-Id: uo6dggojyb8d6soh92zknwmi5ej1q2'

Example response from twitch api docs:

descriptions:

responses:

{"data":{"segments":[{"id":"eyJzZWdtZW50SUQiOiJlNGFjYzcyNC0zNzFmLTQwMmMtODFjYS0yM2FkYTc5NzU5ZDQiLCJpc29ZZWFyIjoyMDIxLCJpc29XZWVrIjoyNn0=","start_time":"2021-07-01T18:00:00Z","end_time":"2021-07-01T19:00:00Z","title":"TwitchDev Monthly Update // July 1, 2021","canceled_until":null,"category":{"id":"509670","name":"Science & Technology"},"is_recurring":false},...],"broadcaster_id":"141981764","broadcaster_name":"TwitchDev","broadcaster_login":"twitchdev","vacation":null},"pagination":{}}

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. The cursor value specified here is from the pagination response field of a prior query.

User ID of the broadcaster who owns the channel streaming schedule.Maximum: 1

Maximum number of stream segments to return.Maximum: 25. Default: 20.

The ID of the stream segment to return.Maximum: 100.

A timestamp in RFC3339 format to start returning stream segments from. If not specified, the current date and time is used.

A timezone offset for the requester specified in minutes. This is recommended to ensure stream segments are returned for the correct week. For example, a timezone that is +4 hours from GMT would be “240.” If not specified, “0” is used for GMT.

Functions

Description:

NEW Gets all scheduled broadcasts or specific scheduled broadcasts from a channel’s stream schedule.

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. The cursor value specified here is from the pagination response field of a prior query.

Specs

broadcaster_id() :: %{broadcaster_id: String.t()}

User ID of the broadcaster who owns the channel streaming schedule.Maximum: 1

Specs

first() :: %{first: integer()}

Maximum number of stream segments to return.Maximum: 25. Default: 20.

Specs

id() :: %{id: String.t()}

The ID of the stream segment to return.Maximum: 100.

Specs

start_time() :: %{start_time: String.t()}

A timestamp in RFC3339 format to start returning stream segments from. If not specified, the current date and time is used.

Specs

utc_offset() :: %{utc_offset: String.t()}

A timezone offset for the requester specified in minutes. This is recommended to ensure stream segments are returned for the correct week. For example, a timezone that is +4 hours from GMT would be “240.” If not specified, “0” is used for GMT.

Link to this section Functions

Specs

call(
  broadcaster_id()
  | id()
  | start_time()
  | utc_offset()
  | first()
  | after_query_param()
) :: {:ok, Finch.Response.t()} | {:error, Exception.t()}

Description:

NEW Gets all scheduled broadcasts or specific scheduled broadcasts from a channel’s stream schedule.

Required authentication:

Required authorization:

User OAuth Token or App Access Token