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

    Type Alias GetLatestMediaData

    type GetLatestMediaData = {
        body?: never;
        path?: never;
        query?: {
            userId?: string;
            parentId?: string;
            fields?: ItemFields[];
            includeItemTypes?: BaseItemKind[];
            isPlayed?: boolean;
            enableImages?: boolean;
            imageTypeLimit?: number;
            enableImageTypes?: ImageType[];
            enableUserData?: boolean;
            limit?: number;
            groupItems?: boolean;
        };
        url: "/Items/Latest";
    }
    Index
    body? path? query? url

    Optionalbody

    body?: never
    path?: never
    query?: {
        userId?: string;
        parentId?: string;
        fields?: ItemFields[];
        includeItemTypes?: BaseItemKind[];
        isPlayed?: boolean;
        enableImages?: boolean;
        imageTypeLimit?: number;
        enableImageTypes?: ImageType[];
        enableUserData?: boolean;
        limit?: number;
        groupItems?: boolean;
    }

    Type Declaration

    • OptionaluserId?: string

      User id.

    • 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.

    • OptionalincludeItemTypes?: BaseItemKind[]

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

    • OptionalisPlayed?: boolean

      Filter by items that are played, or not.

    • OptionalenableImages?: boolean

      Optional. include image information in output.

    • OptionalimageTypeLimit?: number

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

    • OptionalenableImageTypes?: ImageType[]

      Optional. The image types to include in the output.

    • OptionalenableUserData?: boolean

      Optional. include user data.

    • Optionallimit?: number

      Return item limit.

    • OptionalgroupItems?: boolean

      Whether or not to group items into a parent container.

    url: "/Items/Latest"

    Settings
    Member Visibility

    On This Page
    Properties