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

    Type Alias GetChannelsData

    type GetChannelsData = {
        body?: never;
        path?: never;
        query?: {
            userId?: string;
            startIndex?: number;
            limit?: number;
            supportsLatestItems?: boolean;
            supportsMediaDeletion?: boolean;
            isFavorite?: boolean;
        };
        url: "/Channels";
    }
    Index
    body? path? query? url

    Optionalbody

    body?: never
    path?: never
    query?: {
        userId?: string;
        startIndex?: number;
        limit?: number;
        supportsLatestItems?: boolean;
        supportsMediaDeletion?: boolean;
        isFavorite?: boolean;
    }

    Type Declaration

    • OptionaluserId?: string

      User Id to filter by. Use System.Guid.Empty to not filter by user.

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

    • OptionalsupportsLatestItems?: boolean

      Optional. Filter by channels that support getting latest items.

    • OptionalsupportsMediaDeletion?: boolean

      Optional. Filter by channels that support media deletion.

    • OptionalisFavorite?: boolean

      Optional. Filter by channels that are favorite.

    url: "/Channels"

    Settings
    Member Visibility

    On This Page
    Properties