helix/io.github.captnblubber.twitchkt.helix.resource/ScheduleResource/getSchedule

getSchedule

suspend fun getSchedule(broadcasterId: String, ids: List<String> = emptyList(), startTime: String? = null, first: Int = 20, after: String? = null): StreamSchedule

Twitch API: Get Channel Stream Schedule

Gets the broadcaster's streaming schedule. You can get the entire schedule or specific segments of the schedule.

Return

the StreamSchedule for the channel.

Parameters

broadcasterId

the ID of the broadcaster that owns the streaming schedule you want to get.

ids

the ID of the scheduled segment to return. You may specify a maximum of 100 IDs.

startTime

the UTC date and time that identifies when in the broadcaster's schedule to start returning segments. If not specified, the request returns segments starting after the current UTC date and time. Specify the date and time in RFC3339 format.

first

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 25 items per page. The default is 20.

after

the cursor used to get the next page of results.