Class DiagnosticsApi

DiagnosticsApi - object-oriented interface export DiagnosticsApi

Hierarchy (view full)

Constructors

constructor

Properties

axios basePath configuration

Methods

apiDiagnosticsAccountsTestGet apiDiagnosticsPingGet apiDiagnosticsSignalRExample1Get apiDiagnosticsSignalRExample2Get getCurrentEnvironment parseEnvironment

Constructors

constructor

Properties

Protectedaxios

axios: AxiosInstance = globalAxios

ProtectedbasePath

basePath: string = BASE_PATH

Protectedconfiguration

configuration: undefined | Configuration

Methods

apiDiagnosticsAccountsTestGet

  • apiDiagnosticsAccountsTestGet(options?): Promise<AxiosResponse<ApplicationUser, any>>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<ApplicationUser, any>>

    Throws

    memberof DiagnosticsApi

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

apiDiagnosticsSignalRExample1Get

  • apiDiagnosticsSignalRExample1Get(options?): Promise<AxiosResponse<void, any>>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Throws

    memberof DiagnosticsApi

apiDiagnosticsSignalRExample2Get

  • apiDiagnosticsSignalRExample2Get(options?): Promise<AxiosResponse<void, any>>

  • Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<void, any>>

    Throws

    memberof DiagnosticsApi

getCurrentEnvironment

  • getCurrentEnvironment(options?): Promise<AxiosResponse<AspnetCoreEnvironment, any>>

  • summary Returns the current environment of the API's service host

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<AspnetCoreEnvironment, any>>

    Throws

    memberof DiagnosticsApi

parseEnvironment

  • parseEnvironment(environment, options?): Promise<AxiosResponse<AspnetCoreEnvironment, any>>

  • summary Returns the an AspnetCoreEnvironment Enum based on the environment string provided

    Parameters

    • environment: string

      dev, development, stage, staging, prod, production, sandbox, demo

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<AspnetCoreEnvironment, any>>

    Throws

    memberof DiagnosticsApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods