Class ApiClientBase

Namespace

Shift.Common

Assembly

Shift.Common.dll

public abstract class ApiClientBase

Inheritance

object

ApiClientBase

Derived

ApiClient

ApiClientSynchronous

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ExceptionExtensions.FromHierarchy<TSource>(TSource, Func<TSource, TSource>)

ExceptionExtensions.FromHierarchy<TSource>(TSource, Func<TSource, TSource>, Func<TSource, bool>)

ObjectCopier.CloneJson<T>(T)

ObjectCopier.ShallowCopyTo<TSource, TDestination>(TSource, TDestination, BindingFlags)

Constructors

ApiClientBase(IHttpClientFactory, IJsonSerializerBase)

public ApiClientBase(IHttpClientFactory httpClientFactory, IJsonSerializerBase serializer)

Parameters

httpClientFactory IHttpClientFactory

serializer IJsonSerializerBase

Fields

HttpRequestFailure

protected string HttpRequestFailure

Field Value

string

JsonDeserializationError

protected string JsonDeserializationError

Field Value

string

_httpClientFactory

protected readonly IHttpClientFactory _httpClientFactory

Field Value

IHttpClientFactory

_serializer

protected readonly IJsonSerializerBase _serializer

Field Value

IJsonSerializerBase

Methods

CreateHttpClient()

protected HttpClient CreateHttpClient()

Returns

HttpClient

CreateProblem(HttpStatusCode, string, string)

protected Problem CreateProblem(HttpStatusCode statusCode, string endpoint, string responseContent)

Parameters

statusCode HttpStatusCode

endpoint string

responseContent string

Returns

Problem

CreateProblem(string, Exception, string, string)

protected Problem CreateProblem(string summary, Exception ex, string endpoint, string responseContent)

Parameters

summary string

ex Exception

endpoint string

responseContent string

Returns

Problem

CreateUrl(string, string[], Dictionary<string, string>)

protected string CreateUrl(string endpoint, string[] segments = null, Dictionary<string, string> parameters = null)

Parameters

endpoint string

segments string[]

parameters Dictionary<string, string>

Returns

string

SetPagination(ApiResult)

protected void SetPagination(ApiResult status)

Parameters

status ApiResult

ToDictionary(object)

public Dictionary<string, string> ToDictionary(object criteria)

Parameters

criteria object

Returns

Dictionary<string, string>