Interface LiveTvApiGetLiveTvChannelsRequest

Request parameters for getLiveTvChannels operation in LiveTvApi.

Export

LiveTvApiGetLiveTvChannelsRequest

interface LiveTvApiGetLiveTvChannelsRequest {
    addCurrentProgram?: boolean;
    enableFavoriteSorting?: boolean;
    enableImages?: boolean;
    enableImageTypes?: ImageType[];
    enableUserData?: boolean;
    fields?: ItemFields[];
    imageTypeLimit?: number;
    isDisliked?: boolean;
    isFavorite?: boolean;
    isKids?: boolean;
    isLiked?: boolean;
    isMovie?: boolean;
    isNews?: boolean;
    isSeries?: boolean;
    isSports?: boolean;
    limit?: number;
    sortBy?: ItemSortBy[];
    sortOrder?: SortOrder;
    startIndex?: number;
    type?: ChannelType;
    userId?: string;
}

Properties

addCurrentProgram? enableFavoriteSorting? enableImages? enableImageTypes? enableUserData? fields? imageTypeLimit? isDisliked? isFavorite? isKids? isLiked? isMovie? isNews? isSeries? isSports? limit? sortBy? sortOrder? startIndex? type? userId?

Properties

Optional ReadonlyaddCurrentProgram

addCurrentProgram?: boolean

Optional. Adds current program info to each channel.

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlyenableFavoriteSorting

enableFavoriteSorting?: boolean

Optional. Incorporate favorite and like status into channel sorting.

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlyenableImages

enableImages?: boolean

Optional. Include image information in output.

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlyenableImageTypes

enableImageTypes?: ImageType[]

"Optional. The image types to include in the output.

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlyenableUserData

enableUserData?: boolean

Optional. Include user data.

Memberof

LiveTvApiGetLiveTvChannels

Optional Readonlyfields

fields?: ItemFields[]

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

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlyimageTypeLimit

imageTypeLimit?: number

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

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlyisDisliked

isDisliked?: boolean

Optional. Filter by channels that are disliked, or not.

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlyisFavorite

isFavorite?: boolean

Optional. Filter by channels that are favorites, or not.

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlyisKids

isKids?: boolean

Optional. Filter for kids.

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlyisLiked

isLiked?: boolean

Optional. Filter by channels that are liked, or not.

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlyisMovie

isMovie?: boolean

Optional. Filter for movies.

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlyisNews

isNews?: boolean

Optional. Filter for news.

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlyisSeries

isSeries?: boolean

Optional. Filter for series.

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlyisSports

isSports?: boolean

Optional. Filter for sports.

Memberof

LiveTvApiGetLiveTvChannels

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlysortBy

sortBy?: ItemSortBy[]

Optional. Key to sort by.

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlysortOrder

sortOrder?: SortOrder

Optional. Sort order.

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlystartIndex

startIndex?: number

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

Memberof

LiveTvApiGetLiveTvChannels

Optional Readonlytype

type?: ChannelType

Optional. Filter by channel type.

Memberof

LiveTvApiGetLiveTvChannels

Optional ReadonlyuserId

userId?: string

Optional. Filter by user and attach user data.

Memberof

LiveTvApiGetLiveTvChannels

Settings

Member Visibility

On This Page

Properties