Interface TvShowsApiGetUpcomingEpisodesRequest

Request parameters for getUpcomingEpisodes operation in TvShowsApi.

Export

TvShowsApiGetUpcomingEpisodesRequest

interface TvShowsApiGetUpcomingEpisodesRequest {
    enableImages?: boolean;
    enableImageTypes?: ImageType[];
    enableUserData?: boolean;
    fields?: ItemFields[];
    imageTypeLimit?: number;
    limit?: number;
    parentId?: string;
    startIndex?: number;
    userId?: string;
}

Properties

enableImages? enableImageTypes? enableUserData? fields? imageTypeLimit? limit? parentId? startIndex? userId?

Properties

Optional ReadonlyenableImages

enableImages?: boolean

Optional. Include image information in output.

Memberof

TvShowsApiGetUpcomingEpisodes

Optional ReadonlyenableImageTypes

enableImageTypes?: ImageType[]

Optional. The image types to include in the output.

Memberof

TvShowsApiGetUpcomingEpisodes

Optional ReadonlyenableUserData

enableUserData?: boolean

Optional. Include user data.

Memberof

TvShowsApiGetUpcomingEpisodes

Optional Readonlyfields

fields?: ItemFields[]

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

Memberof

TvShowsApiGetUpcomingEpisodes

Optional ReadonlyimageTypeLimit

imageTypeLimit?: number

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

Memberof

TvShowsApiGetUpcomingEpisodes

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

TvShowsApiGetUpcomingEpisodes

Optional ReadonlyparentId

parentId?: string

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

Memberof

TvShowsApiGetUpcomingEpisodes

Optional ReadonlystartIndex

startIndex?: number

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

Memberof

TvShowsApiGetUpcomingEpisodes

Optional ReadonlyuserId

userId?: string

The user id of the user to get the upcoming episodes for.

Memberof

TvShowsApiGetUpcomingEpisodes

Settings

Member Visibility

On This Page

Properties