Interface ItemsApiGetResumeItemsRequest

Request parameters for getResumeItems operation in ItemsApi.

Export

ItemsApiGetResumeItemsRequest

interface ItemsApiGetResumeItemsRequest {
    enableImages?: boolean;
    enableImageTypes?: ImageType[];
    enableTotalRecordCount?: boolean;
    enableUserData?: boolean;
    excludeActiveSessions?: boolean;
    excludeItemTypes?: BaseItemKind[];
    fields?: ItemFields[];
    imageTypeLimit?: number;
    includeItemTypes?: BaseItemKind[];
    limit?: number;
    mediaTypes?: MediaType[];
    parentId?: string;
    searchTerm?: string;
    startIndex?: number;
    userId?: string;
}

Properties

enableImages? enableImageTypes? enableTotalRecordCount? enableUserData? excludeActiveSessions? excludeItemTypes? fields? imageTypeLimit? includeItemTypes? limit? mediaTypes? parentId? searchTerm? startIndex? userId?

Properties

Optional ReadonlyenableImages

enableImages?: boolean

Optional. Include image information in output.

Memberof

ItemsApiGetResumeItems

Optional ReadonlyenableImageTypes

enableImageTypes?: ImageType[]

Optional. The image types to include in the output.

Memberof

ItemsApiGetResumeItems

Optional ReadonlyenableTotalRecordCount

enableTotalRecordCount?: boolean

Optional. Enable the total record count.

Memberof

ItemsApiGetResumeItems

Optional ReadonlyenableUserData

enableUserData?: boolean

Optional. Include user data.

Memberof

ItemsApiGetResumeItems

Optional ReadonlyexcludeActiveSessions

excludeActiveSessions?: boolean

Optional. Whether to exclude the currently active sessions.

Memberof

ItemsApiGetResumeItems

Optional ReadonlyexcludeItemTypes

excludeItemTypes?: BaseItemKind[]

Optional. If specified, results will be filtered based on item type. This allows multiple, comma delimited.

Memberof

ItemsApiGetResumeItems

Optional Readonlyfields

fields?: ItemFields[]

Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines.

Memberof

ItemsApiGetResumeItems

Optional ReadonlyimageTypeLimit

imageTypeLimit?: number

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

Memberof

ItemsApiGetResumeItems

Optional ReadonlyincludeItemTypes

includeItemTypes?: BaseItemKind[]

Optional. If specified, results will be filtered based on the item type. This allows multiple, comma delimited.

Memberof

ItemsApiGetResumeItems

Optional Readonlylimit

limit?: number

The item limit.

Memberof

ItemsApiGetResumeItems

Optional ReadonlymediaTypes

mediaTypes?: MediaType[]

Optional. Filter by MediaType. Allows multiple, comma delimited.

Memberof

ItemsApiGetResumeItems

Optional ReadonlyparentId

parentId?: string

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

Memberof

ItemsApiGetResumeItems

Optional ReadonlysearchTerm

searchTerm?: string

The search term.

Memberof

ItemsApiGetResumeItems

Optional ReadonlystartIndex

startIndex?: number

The start index.

Memberof

ItemsApiGetResumeItems

Optional ReadonlyuserId

userId?: string

The user id.

Memberof

ItemsApiGetResumeItems

Settings

Member Visibility

On This Page

Properties