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

    Type Alias GetChannelItemsData

    type GetChannelItemsData = {
        body?: never;
        path: { channelId: string };
        query?: {
            folderId?: string;
            userId?: string;
            startIndex?: number;
            limit?: number;
            sortOrder?: SortOrder[];
            filters?: ItemFilter[];
            sortBy?: ItemSortBy[];
            fields?: ItemFields[];
        };
        url: "/Channels/{channelId}/Items";
    }
    Index
    body? path query? url

    Optionalbody

    body?: never
    path: { channelId: string }

    Type Declaration

    • channelId: string

      Channel Id.

    query?: {
        folderId?: string;
        userId?: string;
        startIndex?: number;
        limit?: number;
        sortOrder?: SortOrder[];
        filters?: ItemFilter[];
        sortBy?: ItemSortBy[];
        fields?: ItemFields[];
    }

    Type Declaration

    • OptionalfolderId?: string

      Optional. Folder Id.

    • OptionaluserId?: string

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

    • OptionalsortOrder?: SortOrder[]

      Optional. Sort Order - Ascending,Descending.

    • Optionalfilters?: ItemFilter[]

      Optional. Specify additional filters to apply.

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

    • Optionalfields?: ItemFields[]

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

    url: "/Channels/{channelId}/Items"

    Settings
    Member Visibility

    On This Page
    Properties