Interface LiveTvApiGetRecordingsRequest

Request parameters for getRecordings operation in LiveTvApi.

Export

LiveTvApiGetRecordingsRequest

interface LiveTvApiGetRecordingsRequest {
    channelId?: string;
    enableImages?: boolean;
    enableImageTypes?: ImageType[];
    enableTotalRecordCount?: boolean;
    enableUserData?: boolean;
    fields?: ItemFields[];
    imageTypeLimit?: number;
    isInProgress?: boolean;
    isKids?: boolean;
    isLibraryItem?: boolean;
    isMovie?: boolean;
    isNews?: boolean;
    isSeries?: boolean;
    isSports?: boolean;
    limit?: number;
    seriesTimerId?: string;
    startIndex?: number;
    status?: RecordingStatus;
    userId?: string;
}

Properties

channelId? enableImages? enableImageTypes? enableTotalRecordCount? enableUserData? fields? imageTypeLimit? isInProgress? isKids? isLibraryItem? isMovie? isNews? isSeries? isSports? limit? seriesTimerId? startIndex? status? userId?

Properties

Optional ReadonlychannelId

channelId?: string

Optional. Filter by channel id.

Memberof

LiveTvApiGetRecordings

Optional ReadonlyenableImages

enableImages?: boolean

Optional. Include image information in output.

Memberof

LiveTvApiGetRecordings

Optional ReadonlyenableImageTypes

enableImageTypes?: ImageType[]

Optional. The image types to include in the output.

Memberof

LiveTvApiGetRecordings

Optional ReadonlyenableTotalRecordCount

enableTotalRecordCount?: boolean

Optional. Return total record count.

Memberof

LiveTvApiGetRecordings

Optional ReadonlyenableUserData

enableUserData?: boolean

Optional. Include user data.

Memberof

LiveTvApiGetRecordings

Optional Readonlyfields

fields?: ItemFields[]

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

Memberof

LiveTvApiGetRecordings

Optional ReadonlyimageTypeLimit

imageTypeLimit?: number

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

Memberof

LiveTvApiGetRecordings

Optional ReadonlyisInProgress

isInProgress?: boolean

Optional. Filter by recordings that are in progress, or not.

Memberof

LiveTvApiGetRecordings

Optional ReadonlyisKids

isKids?: boolean

Optional. Filter for kids.

Memberof

LiveTvApiGetRecordings

Optional ReadonlyisLibraryItem

isLibraryItem?: boolean

Optional. Filter for is library item.

Memberof

LiveTvApiGetRecordings

Optional ReadonlyisMovie

isMovie?: boolean

Optional. Filter for movies.

Memberof

LiveTvApiGetRecordings

Optional ReadonlyisNews

isNews?: boolean

Optional. Filter for news.

Memberof

LiveTvApiGetRecordings

Optional ReadonlyisSeries

isSeries?: boolean

Optional. Filter for series.

Memberof

LiveTvApiGetRecordings

Optional ReadonlyisSports

isSports?: boolean

Optional. Filter for sports.

Memberof

LiveTvApiGetRecordings

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

LiveTvApiGetRecordings

Optional ReadonlyseriesTimerId

seriesTimerId?: string

Optional. Filter by recordings belonging to a series timer.

Memberof

LiveTvApiGetRecordings

Optional ReadonlystartIndex

startIndex?: number

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

Memberof

LiveTvApiGetRecordings

Optional Readonlystatus

status?: RecordingStatus

Optional. Filter by recording status.

Memberof

LiveTvApiGetRecordings

Optional ReadonlyuserId

userId?: string

Optional. Filter by user and attach user data.

Memberof

LiveTvApiGetRecordings

Settings

Member Visibility

On This Page

Properties