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

    Type Alias GetPlaylistItemsData

    type GetPlaylistItemsData = {
        body?: never;
        path: { playlistId: string };
        query?: {
            userId?: string;
            startIndex?: number;
            limit?: number;
            fields?: ItemFields[];
            enableImages?: boolean;
            enableUserData?: boolean;
            imageTypeLimit?: number;
            enableImageTypes?: ImageType[];
        };
        url: "/Playlists/{playlistId}/Items";
    }
    Index
    body? path query? url

    Optionalbody

    body?: never
    path: { playlistId: string }

    Type Declaration

    • playlistId: string

      The playlist id.

    query?: {
        userId?: string;
        startIndex?: number;
        limit?: number;
        fields?: ItemFields[];
        enableImages?: boolean;
        enableUserData?: boolean;
        imageTypeLimit?: number;
        enableImageTypes?: ImageType[];
    }

    Type Declaration

    • OptionaluserId?: string

      User id.

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

    • Optionalfields?: ItemFields[]

      Optional. Specify additional fields of information to return in the output.

    • OptionalenableImages?: boolean

      Optional. Include image information in output.

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

    url: "/Playlists/{playlistId}/Items"

    Settings
    Member Visibility

    On This Page
    Properties