Class CommonApi
Inheritance
object
    CommonApi
  Implements
Inherited Members
      object.Equals(object)
    
    
      object.Equals(object, object)
    
    
      object.GetHashCode()
    
    
      object.GetType()
    
    
      object.MemberwiseClone()
    
    
      object.ReferenceEquals(object, object)
    
    
      object.ToString()
    
  Namespace: Algorand.Indexer
Assembly: Algorand.dll
Syntax
public class CommonApi : ICommonApi
  Constructors
| Improve this Doc View SourceCommonApi(HttpClient)
Declaration
public CommonApi(HttpClient httpClient)
  Parameters
| Type | Name | Description | 
|---|---|---|
| System.Net.Http.HttpClient | httpClient | 
Properties
| Improve this Doc View SourceJsonSerializerSettings
Declaration
protected JsonSerializerSettings JsonSerializerSettings { get; }
  Property Value
| Type | Description | 
|---|---|
| Newtonsoft.Json.JsonSerializerSettings | 
ReadResponseAsString
Declaration
public bool ReadResponseAsString { get; set; }
  Property Value
| Type | Description | 
|---|---|
| bool | 
Methods
| Improve this Doc View SourcemakeHealthCheckAsync()
Returns 200 if healthy.
Declaration
public Task<HealthCheck> makeHealthCheckAsync()
  Returns
| Type | Description | 
|---|---|
| System.Threading.Tasks.Task<TResult><HealthCheck> | 
Exceptions
| Type | Condition | 
|---|---|
| ApiException | A server side error occurred.  | 
      
makeHealthCheckAsync(CancellationToken)
Declaration
public Task<HealthCheck> makeHealthCheckAsync(CancellationToken cancellationToken)
  Parameters
| Type | Name | Description | 
|---|---|---|
| System.Threading.CancellationToken | cancellationToken | 
Returns
| Type | Description | 
|---|---|
| System.Threading.Tasks.Task<TResult><HealthCheck> | 
ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<string, IEnumerable<string>>, CancellationToken)
Declaration
protected virtual Task<CommonApi.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)
  Parameters
| Type | Name | Description | 
|---|---|---|
| System.Net.Http.HttpResponseMessage | response | |
| System.Collections.Generic.IReadOnlyDictionary<TKey, TValue><string, System.Collections.Generic.IEnumerable<T><string>> | headers | |
| System.Threading.CancellationToken | cancellationToken | 
Returns
| Type | Description | 
|---|---|
| System.Threading.Tasks.Task<TResult><CommonApi.ObjectResponseResult<T>> | 
Type Parameters
| Name | Description | 
|---|---|
| T |