Function ChannelsApiFp

Returns {
    getAllChannelFeatures(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ChannelFeatures[]>,
    >;
    getChannelFeatures(
        channelId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ChannelFeatures>,
    >;
    getChannelItems(
        channelId: string,
        folderId?: string,
        userId?: string,
        startIndex?: number,
        limit?: number,
        sortOrder?: SortOrder[],
        filters?: ItemFilter[],
        sortBy?: ItemSortBy[],
        fields?: ItemFields[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDtoQueryResult>,
    >;
    getChannels(
        userId?: string,
        startIndex?: number,
        limit?: number,
        supportsLatestItems?: boolean,
        supportsMediaDeletion?: boolean,
        isFavorite?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDtoQueryResult>,
    >;
    getLatestChannelItems(
        userId?: string,
        startIndex?: number,
        limit?: number,
        filters?: ItemFilter[],
        fields?: ItemFields[],
        channelIds?: string[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDtoQueryResult>,
    >;
}

• getAllChannelFeatures: function

  • getAllChannelFeatures(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ChannelFeatures[]>,
    >

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ChannelFeatures[]>,
    >

    Throws

• getChannelFeatures: function

  • getChannelFeatures(
        channelId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ChannelFeatures>,
    >

    Parameters

    • channelId: string

      Channel id.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ChannelFeatures>,
    >

    Throws

• getChannelItems: function

  • getChannelItems(
        channelId: string,
        folderId?: string,
        userId?: string,
        startIndex?: number,
        limit?: number,
        sortOrder?: SortOrder[],
        filters?: ItemFilter[],
        sortBy?: ItemSortBy[],
        fields?: ItemFields[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDtoQueryResult>,
    >

    Parameters

    • channelId: string

      Channel Id.

    • OptionalfolderId: string

      Optional. Folder Id.

    • OptionaluserId: string

      Optional. User Id.

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

    • OptionalsortOrder: SortOrder[]

      Optional. Sort Order - Ascending,Descending.

    • Optionalfilters: ItemFilter[]

      Optional. Specify additional filters to apply.

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

    • Optionalfields: ItemFields[]

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

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDtoQueryResult>,
    >

    Throws

• getChannels: function

  • getChannels(
        userId?: string,
        startIndex?: number,
        limit?: number,
        supportsLatestItems?: boolean,
        supportsMediaDeletion?: boolean,
        isFavorite?: boolean,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDtoQueryResult>,
    >

    Parameters

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

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDtoQueryResult>,
    >

    Throws

• getLatestChannelItems: function

  • getLatestChannelItems(
        userId?: string,
        startIndex?: number,
        limit?: number,
        filters?: ItemFilter[],
        fields?: ItemFields[],
        channelIds?: string[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDtoQueryResult>,
    >

    Parameters

    • OptionaluserId: string

      Optional. User Id.

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

    • Optionalfilters: ItemFilter[]

      Optional. Specify additional filters to apply.

    • Optionalfields: ItemFields[]

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

    • OptionalchannelIds: string[]

      Optional. Specify one or more channel id&#39;s, comma delimited.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<BaseItemDtoQueryResult>,
    >

    Throws