Interface TvShowsApiGetNextUpRequest

Request parameters for getNextUp operation in TvShowsApi.

Export

TvShowsApiGetNextUpRequest

interface TvShowsApiGetNextUpRequest {
    disableFirstEpisode?: boolean;
    enableImages?: boolean;
    enableImageTypes?: ImageType[];
    enableResumable?: boolean;
    enableRewatching?: boolean;
    enableTotalRecordCount?: boolean;
    enableUserData?: boolean;
    fields?: ItemFields[];
    imageTypeLimit?: number;
    limit?: number;
    nextUpDateCutoff?: string;
    parentId?: string;
    seriesId?: string;
    startIndex?: number;
    userId?: string;
}

Properties

disableFirstEpisode? enableImages? enableImageTypes? enableResumable? enableRewatching? enableTotalRecordCount? enableUserData? fields? imageTypeLimit? limit? nextUpDateCutoff? parentId? seriesId? startIndex? userId?

Properties

Optional ReadonlydisableFirstEpisode

disableFirstEpisode?: boolean

Whether to disable sending the first episode in a series as next up.

Memberof

TvShowsApiGetNextUp

Optional ReadonlyenableImages

enableImages?: boolean

Optional. Include image information in output.

Memberof

TvShowsApiGetNextUp

Optional ReadonlyenableImageTypes

enableImageTypes?: ImageType[]

Optional. The image types to include in the output.

Memberof

TvShowsApiGetNextUp

Optional ReadonlyenableResumable

enableResumable?: boolean

Whether to include resumable episodes in next up results.

Memberof

TvShowsApiGetNextUp

Optional ReadonlyenableRewatching

enableRewatching?: boolean

Whether to include watched episodes in next up results.

Memberof

TvShowsApiGetNextUp

Optional ReadonlyenableTotalRecordCount

enableTotalRecordCount?: boolean

Whether to enable the total records count. Defaults to true.

Memberof

TvShowsApiGetNextUp

Optional ReadonlyenableUserData

enableUserData?: boolean

Optional. Include user data.

Memberof

TvShowsApiGetNextUp

Optional Readonlyfields

fields?: ItemFields[]

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

Memberof

TvShowsApiGetNextUp

Optional ReadonlyimageTypeLimit

imageTypeLimit?: number

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

Memberof

TvShowsApiGetNextUp

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

TvShowsApiGetNextUp

Optional ReadonlynextUpDateCutoff

nextUpDateCutoff?: string

Optional. Starting date of shows to show in Next Up section.

Memberof

TvShowsApiGetNextUp

Optional ReadonlyparentId

parentId?: string

Optional. Specify this to localize the search to a specific item or folder. Omit to use the root.

Memberof

TvShowsApiGetNextUp

Optional ReadonlyseriesId

seriesId?: string

Optional. Filter by series id.

Memberof

TvShowsApiGetNextUp

Optional ReadonlystartIndex

startIndex?: number

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

Memberof

TvShowsApiGetNextUp

Optional ReadonlyuserId

userId?: string

The user id of the user to get the next up episodes for.

Memberof

TvShowsApiGetNextUp

Settings

Member Visibility

On This Page

Properties