Show / Hide Table of Contents

    Interface ICommonApi

    Represents a collection of functions to interact with the API endpoints

    Inherited Members
    IApiAccessor.Configuration
    IApiAccessor.GetBasePath()
    IApiAccessor.ExceptionFactory
    Namespace: Algorand.V2.Indexer
    Assembly: Algorand.dll
    Syntax
    public interface ICommonApi : IApiAccessor

    Methods

    | Improve this Doc View Source

    MakeHealthCheck()

    Returns 200 if healthy.

    Declaration
    HealthCheck MakeHealthCheck()
    Returns
    Type Description
    HealthCheck

    HealthCheck

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    MakeHealthCheckAsync()

    Returns 200 if healthy.

    Declaration
    Task<HealthCheck> MakeHealthCheckAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<HealthCheck>

    Task of HealthCheck

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    MakeHealthCheckAsyncWithHttpInfo()

    Returns 200 if healthy.

    Declaration
    Task<ApiResponse<HealthCheck>> MakeHealthCheckAsyncWithHttpInfo()
    Returns
    Type Description
    System.Threading.Tasks.Task<ApiResponse<HealthCheck>>

    Task of ApiResponse (HealthCheck)

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    | Improve this Doc View Source

    MakeHealthCheckWithHttpInfo()

    Returns 200 if healthy.

    Declaration
    ApiResponse<HealthCheck> MakeHealthCheckWithHttpInfo()
    Returns
    Type Description
    ApiResponse<HealthCheck>

    ApiResponse of HealthCheck

    Exceptions
    Type Condition
    ApiException

    Thrown when fails to make API call

    • Improve this Doc
    • View Source
    Back to top Generated by DocFX