Skip to main content

Schedule

FunctionReturns
getSchedulePromise<PaginatedScheduleResult>
getScheduleSegmentsByIdsPromise<Array<ScheduleSegment>>
getScheduleSegmentByIdPromise<ScheduleSegment | null>
getScheduleAsIcalPromise<string>
updateScheduleSettingsPromise<void>
createScheduleSegmentPromise<ScheduleSegment>
updateScheduleSegmentPromise<ScheduleSegment>
deleteScheduleSegmentPromise<void>

Functions​

getSchedule​

twitch.schedule.getSchedule(filter?: PaginatedScheduleFilter): Promise<PaginatedScheduleResult>

getScheduleSegmentsByIds​

twitch.schedule.getScheduleSegmentsByIds(segmentIds: Array<string>): Promise<Array<ScheduleSegment>>

getScheduleSegmentById​

twitch.schedule.getScheduleSegmentById(segmentId: string): Promise<ScheduleSegment | null>

getScheduleAsIcal​

twitch.schedule.getScheduleAsIcal(): Promise<string>

updateScheduleSettings​

twitch.schedule.updateScheduleSettings(settings: ScheduleSettingsUpdate): Promise<void>

createScheduleSegment​

twitch.schedule.createScheduleSegment(data: CreateScheduleSegment): Promise<ScheduleSegment>

updateScheduleSegment​

twitch.schedule.updateScheduleSegment(segmentId: string, data: UpdateScheduleSegment): Promise<ScheduleSegment>

deleteScheduleSegment​

twitch.schedule.deleteScheduleSegment(segmentId: string): Promise<void>

Types​

CreateScheduleSegment​

type CreateScheduleSegment = {
	startDate: string
	timezone: string
	isRecurring: boolean
	duration?: number
	categoryId?: string
	title?: string
}

PaginatedScheduleFilter​

type PaginatedScheduleFilter = {
	startDate?: string
	utcOffset?: number
	limit?: number
	after?: string
}

PaginatedScheduleResult​

type PaginatedScheduleResult = {
	data: Schedule
	cursor?: string
}

Schedule​

type Schedule = {
	segments: Array<ScheduleSegment> | null
	broadcasterId: string
	broadcasterName: string
	broadcasterLogin: string
	vacation: ScheduleVacation | null
}

ScheduleSegment​

type ScheduleSegment = {
	id: string
	startTime: string
	endTime: string
	title: string
	canceledUntil: string | null
	category: ScheduleSegmentCategory | null
	isRecurring: boolean
}

ScheduleSegmentCategory​

type ScheduleSegmentCategory = {
	id: string
	name: string
}

ScheduleSettingsUpdate​

type ScheduleSettingsUpdate = {
	vacation?: ScheduleSettingsUpdateVacation
}

ScheduleSettingsUpdateVacation​

type ScheduleSettingsUpdateVacation = {
	startDate: string
	endDate: string
	timezone: string
}

ScheduleVacation​

type ScheduleVacation = {
	startTime: string
	endTime: string
}

UpdateScheduleSegment​

type UpdateScheduleSegment = {
	startDate?: string
	timezone?: string
	duration?: number
	categoryId?: string
	title?: string
	isCanceled?: boolean
}