@jellyfin/sdk

    Interface ChannelsApiGetChannelItemsRequest

    Request parameters for getChannelItems operation in ChannelsApi.

    ChannelsApiGetChannelItemsRequest

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

    Properties

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

    Properties

    channelId: string

    Channel Id.

    ChannelsApiGetChannelItems

    fields?: ItemFields[]

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

    ChannelsApiGetChannelItems

    filters?: ItemFilter[]

    Optional. Specify additional filters to apply.

    ChannelsApiGetChannelItems

    folderId?: string

    Optional. Folder Id.

    ChannelsApiGetChannelItems

    limit?: number

    Optional. The maximum number of records to return.

    ChannelsApiGetChannelItems

    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.

    ChannelsApiGetChannelItems

    sortOrder?: SortOrder[]

    Optional. Sort Order - Ascending,Descending.

    ChannelsApiGetChannelItems

    startIndex?: number

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

    ChannelsApiGetChannelItems

    userId?: string

    Optional. User Id.

    ChannelsApiGetChannelItems

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR