<a id=“SuperOffice_WebApi_Agents_AgentBase”></a> Class AgentBase

Namespace: SuperOffice.WebApi.Agents
Assembly: SuperOffice.WebApi.dll Base class for client Agents. Uses a <xref href=“System.Net.Http.HttpClient” data-throw-if-not-resolved=“false”></xref> to call the SuperOffice REST API. Will use a default implementation with gzip and progress callbacks if nothing is specified.

public class AgentBase : IAgentBase, IDisposable

Remarks

Disposes of the client when the agent is disposed, if no client provided to ctor.

Constructors

<a id=“SuperOffice_WebApi_Agents_AgentBase__ctor_System_String_System_Net_Http_HttpClient_”></a> AgentBase(string, HttpClient)

Agent base class.

protected AgentBase(string baseUrl, HttpClient httpClient = null)

Parameters

baseUrl string URL to web API endpoint httpClient HttpClient client to use to communicate with endpoint. Will make a default http client if nothing is provided.

<a id=“SuperOffice_WebApi_Agents_AgentBase__ctor_SuperOffice_WebApi_WebApiOptions_System_Net_Http_HttpClient_”></a> AgentBase(WebApiOptions, HttpClient)

Agent base class.

protected AgentBase(WebApiOptions configuration, HttpClient httpClient = null)

Parameters

configuration WebApiOptions Settings and URL to web API endpoint httpClient HttpClient client to use to communicate with endpoint. Will make a default http client if nothing is provided.

Fields

<a id=“SuperOffice_WebApi_Agents_AgentBase__binary”></a> _binary

protected const string _binary = "application/octet-stream"

Field Value

string

<a id=“SuperOffice_WebApi_Agents_AgentBase__client”></a> _client

protected HttpClient _client

Field Value

HttpClient

<a id=“SuperOffice_WebApi_Agents_AgentBase__config”></a> _config

protected WebApiOptions _config

Field Value

WebApiOptions

<a id=“SuperOffice_WebApi_Agents_AgentBase__disposeClient”></a> _disposeClient

protected bool _disposeClient

Field Value

bool

<a id=“SuperOffice_WebApi_Agents_AgentBase__json”></a> _json

protected const string _json = "application/json"

Field Value

string

Properties

<a id=“SuperOffice_WebApi_Agents_AgentBase_Client”></a> Client

The HTTP Client we are using. Create a default SO HttpClient if not specified in constructor.

protected HttpClient Client { get; }

Property Value

HttpClient

<a id=“SuperOffice_WebApi_Agents_AgentBase_ClientCancellationTokenSource”></a> ClientCancellationTokenSource

Used in SendRequest to allow clients to cancel requests.

protected CancellationTokenSource ClientCancellationTokenSource { get; set; }

Property Value

CancellationTokenSource

<a id=“SuperOffice_WebApi_Agents_AgentBase_Configuration”></a> Configuration

Configuration this agent was initalized with.

public WebApiOptions Configuration { get; }

Property Value

WebApiOptions

<a id=“SuperOffice_WebApi_Agents_AgentBase_HasRunningRequest”></a> HasRunningRequest

Is an HTTP request in flight?

public bool HasRunningRequest { get; }

Property Value

bool

<a id=“SuperOffice_WebApi_Agents_AgentBase_ProgressListener”></a> ProgressListener

Progress callback receiver for downloads

public IProgressListener ProgressListener { get; set; }

Property Value

IProgressListener

<a id=“SuperOffice_WebApi_Agents_AgentBase_UploadProgressListener”></a> UploadProgressListener

Progress callback receiver for uploads

public IProgressListener UploadProgressListener { get; set; }

Property Value

IProgressListener

Methods

<a id=“SuperOffice_WebApi_Agents_AgentBase_BuildRequestFromObject_System_Net_Http_HttpMethod_System_String_System_Object_SuperOffice_WebApi_WebApiOptions_System_String_”></a> BuildRequestFromObject(HttpMethod, string, object, WebApiOptions, string)

protected HttpRequestMessage BuildRequestFromObject(HttpMethod method, string url, object body, WebApiOptions config, string contentType)

Parameters

method HttpMethod url string body object config WebApiOptions contentType string

Returns

HttpRequestMessage

<a id=“SuperOffice_WebApi_Agents_AgentBase_BuildRequestFromObjectWithStream_System_Net_Http_HttpMethod_System_String_System_Object_System_IO_Stream_SuperOffice_WebApi_WebApiOptions_System_String_”></a> BuildRequestFromObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string)

protected HttpRequestMessage BuildRequestFromObjectWithStream(HttpMethod method, string url, object body, Stream stream, WebApiOptions config, string contentType)

Parameters

method HttpMethod url string body object stream Stream config WebApiOptions contentType string

Returns

HttpRequestMessage

<a id=“SuperOffice_WebApi_Agents_AgentBase_BuildRequestFromStream_System_Net_Http_HttpMethod_System_String_System_IO_Stream_SuperOffice_WebApi_WebApiOptions_System_String_”></a> BuildRequestFromStream(HttpMethod, string, Stream, WebApiOptions, string)

protected HttpRequestMessage BuildRequestFromStream(HttpMethod method, string url, Stream body, WebApiOptions config, string contentType)

Parameters

method HttpMethod url string body Stream config WebApiOptions contentType string

Returns

HttpRequestMessage

<a id=“SuperOffice_WebApi_Agents_AgentBase_CancelRequest”></a> CancelRequest()

Used by the client to terminate the current method call.

public void CancelRequest()

<a id=“SuperOffice_WebApi_Agents_AgentBase_Dispose”></a> Dispose()

Disposes of the HTTP Client if we own it.

public void Dispose()

<a id=“SuperOffice_WebApi_Agents_AgentBase_Finally_SuperOffice_WebApi_RequestOptions_”></a> Finally(RequestOptions)

protected void Finally(RequestOptions options)

Parameters

options RequestOptions

<a id=“SuperOffice_WebApi_Agents_AgentBase_Merge_SuperOffice_WebApi_RequestOptions_”></a> Merge(RequestOptions)

protected WebApiOptions Merge(RequestOptions options)

Parameters

options RequestOptions

Returns

WebApiOptions

<a id=“SuperOffice_WebApi_Agents_AgentBase_ParseAuthorization_SuperOffice_WebApi_Authorization_IAuthorization_”></a> ParseAuthorization(IAuthorization)

Creates authentication headers based on <xref href=“SuperOffice.WebApi.Authorization.IAuthorization” data-throw-if-not-resolved=“false”></xref> scheme and parameter.

protected AuthenticationHeaderValue ParseAuthorization(IAuthorization authorization)

Parameters

authorization IAuthorization Contains authorization scheme and parameter values.

Returns

AuthenticationHeaderValue Authorization header.

<a id=“SuperOffice_WebApi_Agents_AgentBase_ParseResponse__1_System_Net_Http_HttpResponseMessage_”></a> ParseResponse<T>(HttpResponseMessage)

protected Task<T> ParseResponse<T>(HttpResponseMessage response)

Parameters

response HttpResponseMessage

Returns

Task<T>

Type Parameters

T

<a id=“SuperOffice_WebApi_Agents_AgentBase_SendRequest_System_Net_Http_HttpRequestMessage_SuperOffice_WebApi_RequestOptions_”></a> SendRequest(HttpRequestMessage, RequestOptions)

protected Task<HttpResponseMessage> SendRequest(HttpRequestMessage request, RequestOptions config)

Parameters

request HttpRequestMessage config RequestOptions

Returns

Task<HttpResponseMessage>

<a id=“SuperOffice_WebApi_Agents_AgentBase_SendRequestObject_System_Net_Http_HttpMethod_System_String_System_Object_SuperOffice_WebApi_WebApiOptions_System_String_”></a> SendRequestObject(HttpMethod, string, object, WebApiOptions, string)

protected Task<HttpResponseMessage> SendRequestObject(HttpMethod method, string url, object args, WebApiOptions config, string contentType)

Parameters

method HttpMethod url string args object config WebApiOptions contentType string

Returns

Task<HttpResponseMessage>

<a id=“SuperOffice_WebApi_Agents_AgentBase_SendRequestObjectWithStream_System_Net_Http_HttpMethod_System_String_System_Object_System_IO_Stream_SuperOffice_WebApi_WebApiOptions_System_String_”></a> SendRequestObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string)

protected Task<HttpResponseMessage> SendRequestObjectWithStream(HttpMethod method, string url, object args, Stream stream, WebApiOptions config, string contentType)

Parameters

method HttpMethod url string args object stream Stream config WebApiOptions contentType string

Returns

Task<HttpResponseMessage>

<a id=“SuperOffice_WebApi_Agents_AgentBase_ThrowOnResponseErrorAsync_System_Net_Http_HttpRequestMessage_System_Net_Http_HttpResponseMessage_”></a> ThrowOnResponseErrorAsync(HttpRequestMessage, HttpResponseMessage)

Return NULL on NOT-FOUND errors

protected Task ThrowOnResponseErrorAsync(HttpRequestMessage request, HttpResponseMessage response)

Parameters

request HttpRequestMessage response HttpResponseMessage

Returns

Task

​<a id=“SuperOffice_WebApi_Agents_AgentBase”></a> Class AgentBase

​Inheritance

​Derived

​Implements

​Inherited Members

​Remarks

​Constructors

​<a id=“SuperOffice_WebApi_Agents_AgentBase__ctor_System_String_System_Net_Http_HttpClient_”></a> AgentBase(string, HttpClient)

​Parameters

​<a id=“SuperOffice_WebApi_Agents_AgentBase__ctor_SuperOffice_WebApi_WebApiOptions_System_Net_Http_HttpClient_”></a> AgentBase(WebApiOptions, HttpClient)

​Parameters

​Fields

​<a id=“SuperOffice_WebApi_Agents_AgentBase__binary”></a> _binary

​Field Value

​<a id=“SuperOffice_WebApi_Agents_AgentBase__client”></a> _client

​Field Value

​<a id=“SuperOffice_WebApi_Agents_AgentBase__config”></a> _config

​Field Value

​<a id=“SuperOffice_WebApi_Agents_AgentBase__disposeClient”></a> _disposeClient

​Field Value

​<a id=“SuperOffice_WebApi_Agents_AgentBase__json”></a> _json

​Field Value

​Properties

​<a id=“SuperOffice_WebApi_Agents_AgentBase_Client”></a> Client

​Property Value

​<a id=“SuperOffice_WebApi_Agents_AgentBase_ClientCancellationTokenSource”></a> ClientCancellationTokenSource

​Property Value

​<a id=“SuperOffice_WebApi_Agents_AgentBase_Configuration”></a> Configuration

​Property Value

​<a id=“SuperOffice_WebApi_Agents_AgentBase_HasRunningRequest”></a> HasRunningRequest

​Property Value

​<a id=“SuperOffice_WebApi_Agents_AgentBase_ProgressListener”></a> ProgressListener

​Property Value

​<a id=“SuperOffice_WebApi_Agents_AgentBase_UploadProgressListener”></a> UploadProgressListener

​Property Value

​Methods

​<a id=“SuperOffice_WebApi_Agents_AgentBase_BuildRequestFromObject_System_Net_Http_HttpMethod_System_String_System_Object_SuperOffice_WebApi_WebApiOptions_System_String_”></a> BuildRequestFromObject(HttpMethod, string, object, WebApiOptions, string)

​Parameters

​Returns

​Parameters

​Returns

​<a id=“SuperOffice_WebApi_Agents_AgentBase_BuildRequestFromStream_System_Net_Http_HttpMethod_System_String_System_IO_Stream_SuperOffice_WebApi_WebApiOptions_System_String_”></a> BuildRequestFromStream(HttpMethod, string, Stream, WebApiOptions, string)

​Parameters

​Returns

​<a id=“SuperOffice_WebApi_Agents_AgentBase_CancelRequest”></a> CancelRequest()

​<a id=“SuperOffice_WebApi_Agents_AgentBase_Dispose”></a> Dispose()

​<a id=“SuperOffice_WebApi_Agents_AgentBase_Finally_SuperOffice_WebApi_RequestOptions_”></a> Finally(RequestOptions)

​Parameters

​<a id=“SuperOffice_WebApi_Agents_AgentBase_Merge_SuperOffice_WebApi_RequestOptions_”></a> Merge(RequestOptions)

​Parameters

​Returns

​<a id=“SuperOffice_WebApi_Agents_AgentBase_ParseAuthorization_SuperOffice_WebApi_Authorization_IAuthorization_”></a> ParseAuthorization(IAuthorization)

​Parameters

​Returns

​<a id=“SuperOffice_WebApi_Agents_AgentBase_ParseResponse__1_System_Net_Http_HttpResponseMessage_”></a> ParseResponse<T&gt;(HttpResponseMessage)

​Parameters

​Returns

​Type Parameters

​<a id=“SuperOffice_WebApi_Agents_AgentBase_SendRequest_System_Net_Http_HttpRequestMessage_SuperOffice_WebApi_RequestOptions_”></a> SendRequest(HttpRequestMessage, RequestOptions)

​Parameters

​Returns

​<a id=“SuperOffice_WebApi_Agents_AgentBase_SendRequestObject_System_Net_Http_HttpMethod_System_String_System_Object_SuperOffice_WebApi_WebApiOptions_System_String_”></a> SendRequestObject(HttpMethod, string, object, WebApiOptions, string)

​Parameters

​Returns

​<a id=“SuperOffice_WebApi_Agents_AgentBase_SendRequestObjectWithStream_System_Net_Http_HttpMethod_System_String_System_Object_System_IO_Stream_SuperOffice_WebApi_WebApiOptions_System_String_”></a> SendRequestObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string)

​Parameters

​Returns

​<a id=“SuperOffice_WebApi_Agents_AgentBase_ThrowOnResponseErrorAsync_System_Net_Http_HttpRequestMessage_System_Net_Http_HttpResponseMessage_”></a> ThrowOnResponseErrorAsync(HttpRequestMessage, HttpResponseMessage)

​Parameters

​Returns

<a id=“SuperOffice_WebApi_Agents_AgentBase”></a> Class AgentBase

Inheritance

Derived

Implements

Inherited Members

Remarks

Constructors

<a id=“SuperOffice_WebApi_Agents_AgentBase__ctor_System_String_System_Net_Http_HttpClient_”></a> AgentBase(string, HttpClient)

Parameters

<a id=“SuperOffice_WebApi_Agents_AgentBase__ctor_SuperOffice_WebApi_WebApiOptions_System_Net_Http_HttpClient_”></a> AgentBase(WebApiOptions, HttpClient)

Parameters

Fields

<a id=“SuperOffice_WebApi_Agents_AgentBase__binary”></a> _binary

Field Value

<a id=“SuperOffice_WebApi_Agents_AgentBase__client”></a> _client

Field Value

<a id=“SuperOffice_WebApi_Agents_AgentBase__config”></a> _config

Field Value

<a id=“SuperOffice_WebApi_Agents_AgentBase__disposeClient”></a> _disposeClient

Field Value

<a id=“SuperOffice_WebApi_Agents_AgentBase__json”></a> _json

Field Value

Properties

<a id=“SuperOffice_WebApi_Agents_AgentBase_Client”></a> Client

Property Value

<a id=“SuperOffice_WebApi_Agents_AgentBase_ClientCancellationTokenSource”></a> ClientCancellationTokenSource

Property Value

<a id=“SuperOffice_WebApi_Agents_AgentBase_Configuration”></a> Configuration

Property Value

<a id=“SuperOffice_WebApi_Agents_AgentBase_HasRunningRequest”></a> HasRunningRequest

Property Value

<a id=“SuperOffice_WebApi_Agents_AgentBase_ProgressListener”></a> ProgressListener

Property Value

<a id=“SuperOffice_WebApi_Agents_AgentBase_UploadProgressListener”></a> UploadProgressListener

Property Value

Methods

<a id=“SuperOffice_WebApi_Agents_AgentBase_BuildRequestFromObject_System_Net_Http_HttpMethod_System_String_System_Object_SuperOffice_WebApi_WebApiOptions_System_String_”></a> BuildRequestFromObject(HttpMethod, string, object, WebApiOptions, string)

Parameters

Returns

Parameters

Returns

<a id=“SuperOffice_WebApi_Agents_AgentBase_BuildRequestFromStream_System_Net_Http_HttpMethod_System_String_System_IO_Stream_SuperOffice_WebApi_WebApiOptions_System_String_”></a> BuildRequestFromStream(HttpMethod, string, Stream, WebApiOptions, string)

Parameters

Returns

<a id=“SuperOffice_WebApi_Agents_AgentBase_CancelRequest”></a> CancelRequest()

<a id=“SuperOffice_WebApi_Agents_AgentBase_Dispose”></a> Dispose()

<a id=“SuperOffice_WebApi_Agents_AgentBase_Finally_SuperOffice_WebApi_RequestOptions_”></a> Finally(RequestOptions)

Parameters

<a id=“SuperOffice_WebApi_Agents_AgentBase_Merge_SuperOffice_WebApi_RequestOptions_”></a> Merge(RequestOptions)

Parameters

Returns

<a id=“SuperOffice_WebApi_Agents_AgentBase_ParseAuthorization_SuperOffice_WebApi_Authorization_IAuthorization_”></a> ParseAuthorization(IAuthorization)

Parameters

Returns

<a id=“SuperOffice_WebApi_Agents_AgentBase_ParseResponse__1_System_Net_Http_HttpResponseMessage_”></a> ParseResponse<T>(HttpResponseMessage)

Parameters

Returns

Type Parameters

<a id=“SuperOffice_WebApi_Agents_AgentBase_SendRequest_System_Net_Http_HttpRequestMessage_SuperOffice_WebApi_RequestOptions_”></a> SendRequest(HttpRequestMessage, RequestOptions)

Parameters

Returns

<a id=“SuperOffice_WebApi_Agents_AgentBase_SendRequestObject_System_Net_Http_HttpMethod_System_String_System_Object_SuperOffice_WebApi_WebApiOptions_System_String_”></a> SendRequestObject(HttpMethod, string, object, WebApiOptions, string)

Parameters

Returns

<a id=“SuperOffice_WebApi_Agents_AgentBase_SendRequestObjectWithStream_System_Net_Http_HttpMethod_System_String_System_Object_System_IO_Stream_SuperOffice_WebApi_WebApiOptions_System_String_”></a> SendRequestObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string)

Parameters

Returns

<a id=“SuperOffice_WebApi_Agents_AgentBase_ThrowOnResponseErrorAsync_System_Net_Http_HttpRequestMessage_System_Net_Http_HttpResponseMessage_”></a> ThrowOnResponseErrorAsync(HttpRequestMessage, HttpResponseMessage)

Parameters

Returns