Function DiagnosticsApiFactory

DiagnosticsApi - factory interface export

  • DiagnosticsApiFactory(configuration?, basePath?, axios?): {
        apiDiagnosticsAccountsTestGet(options?: RawAxiosRequestConfig): AxiosPromise<ApplicationUser>;
        apiDiagnosticsPingGet(options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiDiagnosticsSignalRExample1Get(options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiDiagnosticsSignalRExample2Get(options?: RawAxiosRequestConfig): AxiosPromise<void>;
        getCurrentEnvironment(options?: RawAxiosRequestConfig): AxiosPromise<AspnetCoreEnvironment>;
        parseEnvironment(environment: string, options?: RawAxiosRequestConfig): AxiosPromise<AspnetCoreEnvironment>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        apiDiagnosticsAccountsTestGet(options?: RawAxiosRequestConfig): AxiosPromise<ApplicationUser>;
        apiDiagnosticsPingGet(options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiDiagnosticsSignalRExample1Get(options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiDiagnosticsSignalRExample2Get(options?: RawAxiosRequestConfig): AxiosPromise<void>;
        getCurrentEnvironment(options?: RawAxiosRequestConfig): AxiosPromise<AspnetCoreEnvironment>;
        parseEnvironment(environment: string, options?: RawAxiosRequestConfig): AxiosPromise<AspnetCoreEnvironment>;
    }

    • apiDiagnosticsAccountsTestGet:function
    • apiDiagnosticsPingGet:function
      • apiDiagnosticsPingGet(options?): AxiosPromise<void>

      • 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 AxiosPromise<void>

        Throws

    • apiDiagnosticsSignalRExample1Get:function
      • apiDiagnosticsSignalRExample1Get(options?): AxiosPromise<void>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • apiDiagnosticsSignalRExample2Get:function
      • apiDiagnosticsSignalRExample2Get(options?): AxiosPromise<void>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • getCurrentEnvironment:function
    • parseEnvironment:function
      • parseEnvironment(environment, options?): AxiosPromise<AspnetCoreEnvironment>

      • 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 AxiosPromise<AspnetCoreEnvironment>

        Throws

Settings

Member Visibility