Interface LiveTvApiGetRecommendedProgramsRequest

Request parameters for getRecommendedPrograms operation in LiveTvApi.

Export

LiveTvApiGetRecommendedProgramsRequest

interface LiveTvApiGetRecommendedProgramsRequest {
    enableImages?: boolean;
    enableImageTypes?: ImageType[];
    enableTotalRecordCount?: boolean;
    enableUserData?: boolean;
    fields?: ItemFields[];
    genreIds?: string[];
    hasAired?: boolean;
    imageTypeLimit?: number;
    isAiring?: boolean;
    isKids?: boolean;
    isMovie?: boolean;
    isNews?: boolean;
    isSeries?: boolean;
    isSports?: boolean;
    limit?: number;
    userId?: string;
}

Properties

enableImages? enableImageTypes? enableTotalRecordCount? enableUserData? fields? genreIds? hasAired? imageTypeLimit? isAiring? isKids? isMovie? isNews? isSeries? isSports? limit? userId?

Properties

Optional ReadonlyenableImages

enableImages?: boolean

Optional. Include image information in output.

Memberof

LiveTvApiGetRecommendedPrograms

Optional ReadonlyenableImageTypes

enableImageTypes?: ImageType[]

Optional. The image types to include in the output.

Memberof

LiveTvApiGetRecommendedPrograms

Optional ReadonlyenableTotalRecordCount

enableTotalRecordCount?: boolean

Retrieve total record count.

Memberof

LiveTvApiGetRecommendedPrograms

Optional ReadonlyenableUserData

enableUserData?: boolean

Optional. include user data.

Memberof

LiveTvApiGetRecommendedPrograms

Optional Readonlyfields

fields?: ItemFields[]

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

Memberof

LiveTvApiGetRecommendedPrograms

Optional ReadonlygenreIds

genreIds?: string[]

The genres to return guide information for.

Memberof

LiveTvApiGetRecommendedPrograms

Optional ReadonlyhasAired

hasAired?: boolean

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

Memberof

LiveTvApiGetRecommendedPrograms

Optional ReadonlyimageTypeLimit

imageTypeLimit?: number

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

Memberof

LiveTvApiGetRecommendedPrograms

Optional ReadonlyisAiring

isAiring?: boolean

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

Memberof

LiveTvApiGetRecommendedPrograms

Optional ReadonlyisKids

isKids?: boolean

Optional. Filter for kids.

Memberof

LiveTvApiGetRecommendedPrograms

Optional ReadonlyisMovie

isMovie?: boolean

Optional. Filter for movies.

Memberof

LiveTvApiGetRecommendedPrograms

Optional ReadonlyisNews

isNews?: boolean

Optional. Filter for news.

Memberof

LiveTvApiGetRecommendedPrograms

Optional ReadonlyisSeries

isSeries?: boolean

Optional. Filter for series.

Memberof

LiveTvApiGetRecommendedPrograms

Optional ReadonlyisSports

isSports?: boolean

Optional. Filter for sports.

Memberof

LiveTvApiGetRecommendedPrograms

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

LiveTvApiGetRecommendedPrograms

Optional ReadonlyuserId

userId?: string

Optional. filter by user id.

Memberof

LiveTvApiGetRecommendedPrograms

Settings

Member Visibility

On This Page

Properties