Class DiagnosticsApi

DiagnosticsApi - object-oriented interface export DiagnosticsApi

Hierarchy (view full)

BaseAPI
- DiagnosticsApi

Index

Constructors

Properties

axios basePath configuration

Methods

apiDiagnosticsPingGet apiDiagnosticsSignalRExample1Get apiDiagnosticsSignalRExample2Get

Constructors

constructor

new DiagnosticsApi(configuration?, basePath?, axios?): DiagnosticsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns DiagnosticsApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

apiDiagnosticsPingGet

apiDiagnosticsPingGet(options?): Promise<AxiosResponse<void, any>>
The API ping is the simplest way to test availbility and authentcation of the Mozaic API summary Simple ping test call
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof DiagnosticsApi
- Defined in src/api/api.ts:16089

apiDiagnosticsSignalRExample1Get

apiDiagnosticsSignalRExample1Get(options?): Promise<AxiosResponse<void, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof DiagnosticsApi
- Defined in src/api/api.ts:16099

apiDiagnosticsSignalRExample2Get

apiDiagnosticsSignalRExample2Get(options?): Promise<AxiosResponse<void, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof DiagnosticsApi
- Defined in src/api/api.ts:16109