Class ChannelsApi

ChannelsApi - object-oriented interface

Export

ChannelsApi

Hierarchy

BaseAPI
- ChannelsApi

Index

Constructors

constructor

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

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
Memberof
ChannelsApi
- Defined in generated-client/api/channels-api.ts:664

getChannelFeatures

getChannelFeatures(
requestParameters: ChannelsApiGetChannelFeaturesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ChannelFeatures, any, {}>>
Parameters
- requestParameters: ChannelsApiGetChannelFeaturesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ChannelFeatures, any, {}>>
Throws
Memberof
ChannelsApi
- Defined in generated-client/api/channels-api.ts:676

getChannelItems

getChannelItems(
requestParameters: ChannelsApiGetChannelItemsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: ChannelsApiGetChannelItemsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Throws
Memberof
ChannelsApi
- Defined in generated-client/api/channels-api.ts:688

getChannels

getChannels(
requestParameters?: ChannelsApiGetChannelsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: ChannelsApiGetChannelsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Throws
Memberof
ChannelsApi
- Defined in generated-client/api/channels-api.ts:700

getLatestChannelItems

getLatestChannelItems(
requestParameters?: ChannelsApiGetLatestChannelItemsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: ChannelsApiGetLatestChannelItemsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Throws
Memberof
ChannelsApi
- Defined in generated-client/api/channels-api.ts:712

Class ChannelsApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ChannelsApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getAllChannelFeatures

Parameters

Returns Promise<AxiosResponse<ChannelFeatures[], any, {}>>

Throws

Memberof

getChannelFeatures

Parameters

Returns Promise<AxiosResponse<ChannelFeatures, any, {}>>

Throws

Memberof

getChannelItems

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws

Memberof

getChannels

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws

Memberof

getLatestChannelItems

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration