Tsarr Documentation - v2.16.0
    Preparing search index...

    Type Alias GetResumeItemsData

    type GetResumeItemsData = {
        body?: never;
        path?: never;
        query?: {
            userId?: string;
            startIndex?: number;
            limit?: number;
            searchTerm?: string;
            parentId?: string;
            fields?: ItemFields[];
            mediaTypes?: MediaType[];
            enableUserData?: boolean;
            imageTypeLimit?: number;
            enableImageTypes?: ImageType[];
            excludeItemTypes?: BaseItemKind[];
            includeItemTypes?: BaseItemKind[];
            enableTotalRecordCount?: boolean;
            enableImages?: boolean;
            excludeActiveSessions?: boolean;
        };
        url: "/UserItems/Resume";
    }
    Index
    body? path? query? url

    Optionalbody

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

    Type Declaration

    • OptionaluserId?: string

      The user id.

    • OptionalstartIndex?: number

      The start index.

    • Optionallimit?: number

      The item limit.

    • OptionalsearchTerm?: string

      The search term.

    • OptionalparentId?: string

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

    • Optionalfields?: 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.

    • OptionalmediaTypes?: MediaType[]

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

    • OptionalenableUserData?: boolean

      Optional. Include user data.

    • OptionalimageTypeLimit?: number

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

    • OptionalenableImageTypes?: ImageType[]

      Optional. The image types to include in the output.

    • OptionalexcludeItemTypes?: BaseItemKind[]

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

    • OptionalincludeItemTypes?: BaseItemKind[]

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

    • OptionalenableTotalRecordCount?: boolean

      Optional. Enable the total record count.

    • OptionalenableImages?: boolean

      Optional. Include image information in output.

    • OptionalexcludeActiveSessions?: boolean

      Optional. Whether to exclude the currently active sessions.

    url: "/UserItems/Resume"

    Settings
    Member Visibility

    On This Page
    Properties