Interface ChannelsApiGetChannelsRequest

Request parameters for getChannels operation in ChannelsApi.

ChannelsApiGetChannelsRequest

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

Properties

isFavorite?: boolean

Optional. Filter by channels that are favorite.

ChannelsApiGetChannels

limit?: number

Optional. The maximum number of records to return.

ChannelsApiGetChannels

startIndex?: number

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

ChannelsApiGetChannels

supportsLatestItems?: boolean

Optional. Filter by channels that support getting latest items.

ChannelsApiGetChannels

supportsMediaDeletion?: boolean

Optional. Filter by channels that support media deletion.

ChannelsApiGetChannels

userId?: string

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

ChannelsApiGetChannels