TwitchApi v0.1.0
TwitchApi

TwitchApi.Schedule.GetChanneliCalendar (TwitchApi v0.1.0) View Source

⛔ This module is autogenerated please do not modify manually.

Example request from twitch api docs:

descriptions:

Returns all scheduled broadcasts from the TwitchDev channel’s stream schedule as an iCalendar.

requests:

curl -X GET 'https://api.twitch.tv/helix/schedule/icalendar?broadcaster_id=141981764'

Example response from twitch api docs:

descriptions:

responses:

BEGIN:VCALENDAR PRODID:-//twitch.tv//StreamSchedule//1.0 VERSION:2.0 CALSCALE:GREGORIAN REFRESH-INTERVAL;VALUE=DURATION:PT1H NAME:TwitchDev BEGIN:VEVENT UID:e4acc724-371f-402c-81ca-23ada79759d4 DTSTAMP:20210323T040131Z DTSTART;TZID=/America/New_York:20210701T140000 DTEND;TZID=/America/New_York:20210701T150000 SUMMARY:TwitchDev Monthly Update // July 1, 2021 DESCRIPTION:Science & Technology. CATEGORIES:Science & Technology END:VEVENT END:VCALENDAR%

Link to this section Summary

Types

broadcaster_id()
user_info()

Functions

call(map, user_info)

Description:

NEW Gets all scheduled broadcasts from a channel’s stream schedule as an iCalendar.

Link to this section Types

Link to this type

broadcaster_id()

View Source

Specs

broadcaster_id() :: %{broadcaster_id: String.t()}
Link to this type

user_info()

View Source

Specs

user_info() :: %{user_id: integer() | binary()} | %{user_name: binary()}

Link to this section Functions

Link to this function

call(map, user_info)

View Source

Specs

call(broadcaster_id(), user_info()) ::
  {:ok, Finch.Response.t()} | {:error, Exception.t()}

Description:

NEW Gets all scheduled broadcasts from a channel’s stream schedule as an iCalendar.

Required authentication:

Required authorization:

None. OAuth token and Client ID not required.