Function ChannelsApiAxiosParamCreator

ChannelsApi - axios parameter creator

Export

  • ChannelsApiAxiosParamCreator(
        configuration?: Configuration,
    ): {
        getAllChannelFeatures: (
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getChannelFeatures: (
            channelId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getChannelItems: (
            channelId: string,
            folderId?: string,
            userId?: string,
            startIndex?: number,
            limit?: number,
            sortOrder?: SortOrder[],
            filters?: ItemFilter[],
            sortBy?: ItemSortBy[],
            fields?: ItemFields[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getChannels: (
            userId?: string,
            startIndex?: number,
            limit?: number,
            supportsLatestItems?: boolean,
            supportsMediaDeletion?: boolean,
            isFavorite?: boolean,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getLatestChannelItems: (
            userId?: string,
            startIndex?: number,
            limit?: number,
            filters?: ItemFilter[],
            fields?: ItemFields[],
            channelIds?: string[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

  • Parameters

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

    • getAllChannelFeatures: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Throws

    • getChannelFeatures: (channelId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>

      Throws

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

      Throws

    • getChannels: (
          userId?: string,
          startIndex?: number,
          limit?: number,
          supportsLatestItems?: boolean,
          supportsMediaDeletion?: boolean,
          isFavorite?: boolean,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Throws

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

      Throws

Settings

Member Visibility