Function DiagnosticsApiFp

DiagnosticsApi - functional programming interface export

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

  • Parameters

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

    • apiDiagnosticsAccountsTestGet:function
      • apiDiagnosticsAccountsTestGet(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationUser>)>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApplicationUser>)>

        Throws

    • apiDiagnosticsPingGet:function
      • apiDiagnosticsPingGet(options?): Promise<((axios?: AxiosInstance, basePath?: string) => 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 Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Throws

    • apiDiagnosticsSignalRExample1Get:function
      • apiDiagnosticsSignalRExample1Get(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Throws

    • apiDiagnosticsSignalRExample2Get:function
      • apiDiagnosticsSignalRExample2Get(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Throws

    • getCurrentEnvironment:function
      • getCurrentEnvironment(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AspnetCoreEnvironment>)>

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

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AspnetCoreEnvironment>)>

        Throws

    • parseEnvironment:function
      • parseEnvironment(environment, options?): Promise<((axios?: AxiosInstance, basePath?: string) => 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 Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<AspnetCoreEnvironment>)>

        Throws

Settings

Member Visibility