Interface ChannelsApiGetChannelItemsRequest

Request parameters for getChannelItems operation in ChannelsApi.

Export

ChannelsApiGetChannelItemsRequest

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

Properties

channelId fields? filters? folderId? limit? sortBy? sortOrder? startIndex? userId?

Properties

ReadonlychannelId

channelId: string

Channel Id.

Memberof

ChannelsApiGetChannelItems

Optional Readonlyfields

fields?: ItemFields[]

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

Memberof

ChannelsApiGetChannelItems

Optional Readonlyfilters

filters?: ItemFilter[]

Optional. Specify additional filters to apply.

Memberof

ChannelsApiGetChannelItems

Optional ReadonlyfolderId

folderId?: string

Optional. Folder Id.

Memberof

ChannelsApiGetChannelItems

Optional Readonlylimit

limit?: number

Optional. The maximum number of records to return.

Memberof

ChannelsApiGetChannelItems

Optional ReadonlysortBy

sortBy?: 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.

Memberof

ChannelsApiGetChannelItems

Optional ReadonlysortOrder

sortOrder?: SortOrder[]

Optional. Sort Order - Ascending,Descending.

Memberof

ChannelsApiGetChannelItems

Optional ReadonlystartIndex

startIndex?: number

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

Memberof

ChannelsApiGetChannelItems

Optional ReadonlyuserId

userId?: string

Optional. User Id.

Memberof

ChannelsApiGetChannelItems

Settings

Member Visibility

On This Page

Properties