Interface LiveTvApiGetLiveTvProgramsRequest

Request parameters for getLiveTvPrograms operation in LiveTvApi.

Export

LiveTvApiGetLiveTvProgramsRequest

interface LiveTvApiGetLiveTvProgramsRequest {
    channelIds?: string[];
    enableImages?: boolean;
    enableImageTypes?: ImageType[];
    enableTotalRecordCount?: boolean;
    enableUserData?: boolean;
    fields?: ItemFields[];
    genreIds?: string[];
    genres?: string[];
    hasAired?: boolean;
    imageTypeLimit?: number;
    isAiring?: boolean;
    isKids?: boolean;
    isMovie?: boolean;
    isNews?: boolean;
    isSeries?: boolean;
    isSports?: boolean;
    librarySeriesId?: string;
    limit?: number;
    maxEndDate?: string;
    maxStartDate?: string;
    minEndDate?: string;
    minStartDate?: string;
    seriesTimerId?: string;
    sortBy?: ItemSortBy[];
    sortOrder?: SortOrder[];
    startIndex?: number;
    userId?: string;
}

Properties

channelIds? enableImages? enableImageTypes? enableTotalRecordCount? enableUserData? fields? genreIds? genres? hasAired? imageTypeLimit? isAiring? isKids? isMovie? isNews? isSeries? isSports? librarySeriesId? limit? maxEndDate? maxStartDate? minEndDate? minStartDate? seriesTimerId? sortBy? sortOrder? startIndex? userId?

Properties

Optional ReadonlychannelIds

channelIds?: string[]

The channels to return guide information for.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlyenableImages

enableImages?: boolean

Optional. Include image information in output.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlyenableImageTypes

enableImageTypes?: ImageType[]

Optional. The image types to include in the output.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlyenableTotalRecordCount

enableTotalRecordCount?: boolean

Retrieve total record count.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlyenableUserData

enableUserData?: boolean

Optional. Include user data.

Memberof

LiveTvApiGetLiveTvPrograms

Optional Readonlyfields

fields?: ItemFields[]

Optional. Specify additional fields of information to return in the output.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlygenreIds

genreIds?: string[]

The genre ids to return guide information for.

Memberof

LiveTvApiGetLiveTvPrograms

Optional Readonlygenres

genres?: string[]

The genres to return guide information for.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlyhasAired

hasAired?: boolean

Optional. Filter by programs that have completed airing, or not.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlyimageTypeLimit

imageTypeLimit?: number

Optional. The max number of images to return, per image type.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlyisAiring

isAiring?: boolean

Optional. Filter by programs that are currently airing, or not.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlyisKids

isKids?: boolean

Optional. Filter for kids.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlyisMovie

isMovie?: boolean

Optional. Filter for movies.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlyisNews

isNews?: boolean

Optional. Filter for news.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlyisSeries

isSeries?: boolean

Optional. Filter for series.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlyisSports

isSports?: boolean

Optional. Filter for sports.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlylibrarySeriesId

librarySeriesId?: string

Optional. Filter by library series id.

Memberof

LiveTvApiGetLiveTvPrograms

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlymaxEndDate

maxEndDate?: string

Optional. The maximum premiere end date.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlymaxStartDate

maxStartDate?: string

Optional. The maximum premiere start date.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlyminEndDate

minEndDate?: string

Optional. The minimum premiere end date.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlyminStartDate

minStartDate?: string

Optional. The minimum premiere start date.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlyseriesTimerId

seriesTimerId?: string

Optional. Filter by series timer id.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlysortBy

sortBy?: ItemSortBy[]

Optional. Specify one or more sort orders, comma delimited. Options: Name, StartDate.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlysortOrder

sortOrder?: SortOrder[]

Sort Order - Ascending,Descending.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlystartIndex

startIndex?: number

Optional. The record index to start at. All items with a lower index will be dropped from the results.

Memberof

LiveTvApiGetLiveTvPrograms

Optional ReadonlyuserId

userId?: string

Optional. Filter by user id.

Memberof

LiveTvApiGetLiveTvPrograms

Settings

Member Visibility

On This Page

Properties