@jellyfin/sdk
    Preparing search index...

    Interface ItemsApiGetResumeItemsRequest

    Request parameters for getResumeItems operation in ItemsApi.

    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;
    }
    Index

    Properties

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

    Properties

    enableImages?: boolean

    Optional. Include image information in output.

    ItemsApiGetResumeItems

    enableImageTypes?: ImageType[]

    Optional. The image types to include in the output.

    ItemsApiGetResumeItems

    enableTotalRecordCount?: boolean

    Optional. Enable the total record count.

    ItemsApiGetResumeItems

    enableUserData?: boolean

    Optional. Include user data.

    ItemsApiGetResumeItems

    excludeActiveSessions?: boolean

    Optional. Whether to exclude the currently active sessions.

    ItemsApiGetResumeItems

    excludeItemTypes?: BaseItemKind[]

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

    ItemsApiGetResumeItems

    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.

    ItemsApiGetResumeItems

    imageTypeLimit?: number

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

    ItemsApiGetResumeItems

    includeItemTypes?: BaseItemKind[]

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

    ItemsApiGetResumeItems

    limit?: number

    The item limit.

    ItemsApiGetResumeItems

    mediaTypes?: MediaType[]

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

    ItemsApiGetResumeItems

    parentId?: string

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

    ItemsApiGetResumeItems

    searchTerm?: string

    The search term.

    ItemsApiGetResumeItems

    startIndex?: number

    The start index.

    ItemsApiGetResumeItems

    userId?: string

    The user id.

    ItemsApiGetResumeItems

    Settings

    Member Visibility

    On This Page

    Properties