Class ChannelApi

ChannelApi - object-oriented interface

Hierarchy

BaseAPI
- ChannelApi

Index

Constructors

Properties

axios basePath configuration

Methods

getAllChannelFeatures getChannelFeatures getChannelItems getChannels getLatestChannelItems

Constructors

constructor

new ChannelApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): ChannelApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ChannelApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:38

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

getAllChannelFeatures

getAllChannelFeatures(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ChannelFeatures[], any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ChannelFeatures[], any, {}>>

Throws
- Defined in generated-client/api/channel-api.ts:605

getChannelFeatures

getChannelFeatures(
requestParameters: ChannelApiGetChannelFeaturesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ChannelFeatures, any, {}>>
Parameters
- requestParameters: ChannelApiGetChannelFeaturesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ChannelFeatures, any, {}>>

Throws
- Defined in generated-client/api/channel-api.ts:616

getChannelItems

getChannelItems(
requestParameters: ChannelApiGetChannelItemsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: ChannelApiGetChannelItemsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/channel-api.ts:627

getChannels

getChannels(
requestParameters?: ChannelApiGetChannelsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: ChannelApiGetChannelsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/channel-api.ts:638

getLatestChannelItems

getLatestChannelItems(
requestParameters?: ChannelApiGetLatestChannelItemsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: ChannelApiGetLatestChannelItemsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/channel-api.ts:649