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

    Type Alias GetThemeVideosData

    type GetThemeVideosData = {
        body?: never;
        path: { itemId: string };
        query?: {
            userId?: string;
            inheritFromParent?: boolean;
            sortBy?: ItemSortBy[];
            sortOrder?: SortOrder[];
        };
        url: "/Items/{itemId}/ThemeVideos";
    }
    Index
    body? path query? url

    Optionalbody

    body?: never
    path: { itemId: string }

    Type Declaration

    • itemId: string

      The item id.

    query?: {
        userId?: string;
        inheritFromParent?: boolean;
        sortBy?: ItemSortBy[];
        sortOrder?: SortOrder[];
    }

    Type Declaration

    • OptionaluserId?: string

      Optional. Filter by user id, and attach user data.

    • OptionalinheritFromParent?: boolean

      Optional. Determines whether or not parent items should be searched for theme media.

    • OptionalsortBy?: ItemSortBy[]

      Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

    • OptionalsortOrder?: SortOrder[]

      Optional. Sort Order - Ascending, Descending.

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

    Settings
    Member Visibility

    On This Page
    Properties