Class PayrollHttpClient

Inheritance

object

PayrollHttpClient

Implements

IDisposable

Inherited Members

object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: PayrollEngine.Client

Assembly: PayrollEngine.Client.Core.dll

Syntax

public sealed class PayrollHttpClient : IDisposable

Constructors

PayrollHttpClient(HttpClient, Version)

Declaration

public PayrollHttpClient(HttpClient httpClient, Version version = null)

Parameters

Type	Name	Description
HttpClient	httpClient
Version	version

PayrollHttpClient(HttpClientHandler, PayrollHttpConfiguration, Version)

Declaration

public PayrollHttpClient(HttpClientHandler httpClientHandler, PayrollHttpConfiguration configuration, Version version = null)

Parameters

Type	Name	Description
HttpClientHandler	httpClientHandler
PayrollHttpConfiguration	configuration
Version	version

PayrollHttpClient(HttpClientHandler, string, int, Version)

Declaration

public PayrollHttpClient(HttpClientHandler httpClientHandler, string baseUrl, int port = 0, Version version = null)

Parameters

Type	Name	Description
HttpClientHandler	httpClientHandler
string	baseUrl
int	port
Version	version

PayrollHttpClient(HttpClientHandler, string, TimeSpan, int, Version)

Declaration

public PayrollHttpClient(HttpClientHandler httpClientHandler, string baseUrl, TimeSpan requestTimeout, int port = 0, Version version = null)

Parameters

Type	Name	Description
HttpClientHandler	httpClientHandler
string	baseUrl
TimeSpan	requestTimeout
int	port
Version	version

Properties

Address

Declaration

public string Address { get; }

Property Value

Type	Description
string

Methods

DeleteAsync(string)

Declaration

public Task DeleteAsync(string requestUri)

Parameters

Type	Name	Description
string	requestUri

Returns

Type	Description
Task

DeleteAsync(string, int)

Declaration

public Task DeleteAsync(string requestUri, int id)

Parameters

Type	Name	Description
string	requestUri
int	id

Returns

Type	Description
Task

DeleteAttributeAsync(string)

Declaration

public Task DeleteAttributeAsync(string requestUri)

Parameters

Type	Name	Description
string	requestUri

Returns

Type	Description
Task

Dispose()

Declaration

public void Dispose()

GetAsync(string)

Declaration

public Task<HttpResponseMessage> GetAsync(string requestUri)

Parameters

Type	Name	Description
string	requestUri

Returns

Type	Description
Task<HttpResponseMessage>

GetAsync(string, StringContent)

Declaration

public Task<HttpResponseMessage> GetAsync(string requestUri, StringContent content)

Parameters

Type	Name	Description
string	requestUri
StringContent	content

Returns

Type	Description
Task<HttpResponseMessage>

GetAsync<T>(string)

Declaration

public Task<T> GetAsync<T>(string requestUri)

Parameters

Type	Name	Description
string	requestUri

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

GetAsync<T>(string, object)

Declaration

public Task<T> GetAsync<T>(string requestUri, object content)

Parameters

Type	Name	Description
string	requestUri
object	content

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

GetAttributeAsync(string)

Declaration

public Task<string> GetAttributeAsync(string requestUri)

Parameters

Type	Name	Description
string	requestUri

Returns

Type	Description
Task<string>

GetCollectionAsync<T>(string)

Declaration

public Task<List<T>> GetCollectionAsync<T>(string requestUri) where T : class

Parameters

Type	Name	Description
string	requestUri

Returns

Type	Description
Task<List<T>>

Type Parameters

Name	Description
T

GetCollectionAsync<T>(string, object)

Declaration

public Task<List<T>> GetCollectionAsync<T>(string requestUri, object content) where T : class

Parameters

Type	Name	Description
string	requestUri
object	content

Returns

Type	Description
Task<List<T>>

Type Parameters

Name	Description
T

GetLogName(string, string)

Declaration

public static string GetLogName(string methodName, string requestUri)

Parameters

Type	Name	Description
string	methodName
string	requestUri

Returns

Type	Description
string

GetRecordIdAsync(HttpResponseMessage)

Declaration

public static Task<int> GetRecordIdAsync(HttpResponseMessage response)

Parameters

Type	Name	Description
HttpResponseMessage	response

Returns

Type	Description
Task<int>

GetSingleAsync<T>(string)

Declaration

public Task<T> GetSingleAsync<T>(string requestUri) where T : class

Parameters

Type	Name	Description
string	requestUri

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

GetTenantAuthorization()

Declaration

public string GetTenantAuthorization()

Returns

Type	Description
string

HasApiKey()

Declaration

public bool HasApiKey()

Returns

Type	Description
bool

HasTenantAuthorization()

Declaration

public bool HasTenantAuthorization()

Returns

Type	Description
bool

IsConnectionAvailableAsync(string)

Declaration

public Task<bool> IsConnectionAvailableAsync(string address)

Parameters

Type	Name	Description
string	address

Returns

Type	Description
Task<bool>

PostAsync(string, StringContent)

Declaration

public Task<HttpResponseMessage> PostAsync(string requestUri, StringContent content)

Parameters

Type	Name	Description
string	requestUri
StringContent	content

Returns

Type	Description
Task<HttpResponseMessage>

PostAsync(string, object)

Declaration

public Task PostAsync(string requestUri, object content)

Parameters

Type	Name	Description
string	requestUri
object	content

Returns

Type	Description
Task

PostAsync<T>(string)

Declaration

public Task<T> PostAsync<T>(string requestUri)

Parameters

Type	Name	Description
string	requestUri

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

PostAsync<T>(string, T)

Declaration

public Task<T> PostAsync<T>(string requestUri, T content) where T : class

Parameters

Type	Name	Description
string	requestUri
T	content

Returns

Type	Description
Task<T>

Type Parameters

Name	Description
T

PostAsync<TIn, TOut>(string, TIn)

Declaration

public Task<TOut> PostAsync<TIn, TOut>(string requestUri, TIn content)

Parameters

Type	Name	Description
string	requestUri
TIn	content

Returns

Type	Description
Task<TOut>

Type Parameters

Name	Description
TIn
TOut

PostAttributeAsync(string, string)

Declaration

public Task<string> PostAttributeAsync(string requestUri, string attributeValue)

Parameters

Type	Name	Description
string	requestUri
string	attributeValue

Returns

Type	Description
Task<string>

PutAsync(string, StringContent)

Declaration

public Task PutAsync(string requestUri, StringContent content)

Parameters

Type	Name	Description
string	requestUri
StringContent	content

Returns

Type	Description
Task

PutAsync(string, string)

Declaration

public Task PutAsync(string requestUri, string content = null)

Parameters

Type	Name	Description
string	requestUri
string	content

Returns

Type	Description
Task

PutAsync<T>(string, T)

Declaration

public Task PutAsync<T>(string requestUri, T content) where T : IModel

Parameters

Type	Name	Description
string	requestUri
T	content

Returns

Type	Description
Task

Type Parameters

Name	Description
T

RemoveApiKey()

Declaration

public void RemoveApiKey()

RemoveTenantAuthorization()

Declaration

public void RemoveTenantAuthorization()

SetApiKey(string)

Declaration

public void SetApiKey(string apiKey)

Parameters

Type	Name	Description
string	apiKey

SetTenantAuthorization(string)

Declaration

public void SetTenantAuthorization(string tenantIdentifier)

Parameters

Type	Name	Description
string	tenantIdentifier

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

UpsertObjectAsync<T>(string, T, T, DateTime?)

Declaration

public Task UpsertObjectAsync<T>(string requestUri, T newObject, T existingObject, DateTime? createdDate = null) where T : IModel

Parameters

Type	Name	Description
string	requestUri
T	newObject
T	existingObject
DateTime?	createdDate

Returns

Type	Description
Task

Type Parameters

Name	Description
T

Implements

IDisposable

Extension Methods

ConsoleExtensions.WriteProperties(object, bool)

ValueTypeExtensions.GetValueType(object)

ObjectInfo.GetPropertyValue(object, string)

ObjectInfo.GetPropertyValue<T>(object, string, T)

ObjectInfo.ResolvePropertyValue(object, string)

ObjectInfo.SetPropertyValue(object, string, object)