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

    Type Alias GetRemoteImagesData

    type GetRemoteImagesData = {
        body?: never;
        path: { itemId: string };
        query?: {
            type?:
                | "Primary"
                | "Art"
                | "Backdrop"
                | "Banner"
                | "Logo"
                | "Thumb"
                | "Disc"
                | "Box"
                | "Screenshot"
                | "Menu"
                | "Chapter"
                | "BoxRear"
                | "Profile";
            startIndex?: number;
            limit?: number;
            providerName?: string;
            includeAllLanguages?: boolean;
        };
        url: "/Items/{itemId}/RemoteImages";
    }
    Index
    body? path query? url

    Optionalbody

    body?: never
    path: { itemId: string }

    Type Declaration

    • itemId: string

      Item Id.

    query?: {
        type?:
            | "Primary"
            | "Art"
            | "Backdrop"
            | "Banner"
            | "Logo"
            | "Thumb"
            | "Disc"
            | "Box"
            | "Screenshot"
            | "Menu"
            | "Chapter"
            | "BoxRear"
            | "Profile";
        startIndex?: number;
        limit?: number;
        providerName?: string;
        includeAllLanguages?: boolean;
    }

    Type Declaration

    • Optionaltype?:
          | "Primary"
          | "Art"
          | "Backdrop"
          | "Banner"
          | "Logo"
          | "Thumb"
          | "Disc"
          | "Box"
          | "Screenshot"
          | "Menu"
          | "Chapter"
          | "BoxRear"
          | "Profile"

      The image type.

    • OptionalstartIndex?: number

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

    • Optionallimit?: number

      Optional. The maximum number of records to return.

    • OptionalproviderName?: string

      Optional. The image provider to use.

    • OptionalincludeAllLanguages?: boolean

      Optional. Include all languages.

    url: "/Items/{itemId}/RemoteImages"

    Settings
    Member Visibility

    On This Page
    Properties