@jellyfin/sdk
    Preparing search index...

    Interface ChannelsApiGetChannelsRequest

    Request parameters for getChannels operation in ChannelsApi.

    interface ChannelsApiGetChannelsRequest {
        isFavorite?: boolean;
        limit?: number;
        startIndex?: number;
        supportsLatestItems?: boolean;
        supportsMediaDeletion?: boolean;
        userId?: string;
    }
    Index

    Properties

    isFavorite? limit? startIndex? supportsLatestItems? supportsMediaDeletion? userId?

    Properties

    isFavorite?: boolean

    Optional. Filter by channels that are favorite.

    limit?: number

    Optional. The maximum number of records to return.

    startIndex?: number

    Optional. The record index to start at. All items with a lower index will be dropped from the results.

    supportsLatestItems?: boolean

    Optional. Filter by channels that support getting latest items.

    supportsMediaDeletion?: boolean

    Optional. Filter by channels that support media deletion.

    userId?: string

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

    Settings

    Member Visibility

    On This Page

    Properties