<a id=“SuperOffice_WebApi_Agents_NavigatorAgent”></a> Class NavigatorAgent
Namespace: SuperOffice.WebApi.AgentsAssembly: SuperOffice.WebApi.dll Navigator stuff.
Inheritance
object ← AgentBase ← NavigatorAgentImplements
INavigatorAgent, IAgentBase, IDisposableInherited Members
AgentBase._json, AgentBase._binary, AgentBase._config, AgentBase._client, AgentBase._disposeClient, AgentBase.Merge(RequestOptions), AgentBase.BuildRequestFromObject(HttpMethod, string, object, WebApiOptions, string), AgentBase.BuildRequestFromStream(HttpMethod, string, Stream, WebApiOptions, string), AgentBase.BuildRequestFromObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string), AgentBase.ParseAuthorization(IAuthorization), AgentBase.CancelRequest(), AgentBase.SendRequestObject(HttpMethod, string, object, WebApiOptions, string), AgentBase.SendRequestObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string), AgentBase.SendRequest(HttpRequestMessage, RequestOptions), AgentBase.ThrowOnResponseErrorAsync(HttpRequestMessage, HttpResponseMessage), AgentBase.ParseResponse<T>(HttpResponseMessage), AgentBase.Finally(RequestOptions), AgentBase.Dispose(), AgentBase.Configuration, AgentBase.Client, AgentBase.HasRunningRequest, AgentBase.ClientCancellationTokenSource, AgentBase.ProgressListener, AgentBase.UploadProgressListener, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()Examples
<pre><code class=“lang-csharp”>using SuperOffice.WebApi; using SuperOffice.WebApi.Agents; var mySession = new WebApiOptions(“http://example.com/super/api”); mySession.Authorization = new AuthorizationUsernamePassword(“user”, “pass”); using (NavigatorAgent agent = new NavigatorAgent(mySession)) { // call methods on agent here… }</code></pre>Constructors
<a id=“SuperOffice_WebApi_Agents_NavigatorAgent__ctor_System_Net_Http_HttpClient_”></a> NavigatorAgent(HttpClient)
Constructor: Navigator stuff.Parameters
httpClient HttpClient
Use this HTTP client instead of making own HttpClient instance.
<a id=“SuperOffice_WebApi_Agents_NavigatorAgent__ctor_SuperOffice_WebApi_WebApiOptions_System_Net_Http_HttpClient_”></a> NavigatorAgent(WebApiOptions, HttpClient)
Constructor: Navigator stuff.Parameters
options WebApiOptions
Base URL and authentication values.
httpClient HttpClient
Optional: Use this HTTP client instead of making a new one.
Methods
<a id=“SuperOffice_WebApi_Agents_NavigatorAgent_GetAllNavigatorCompanyAsync_SuperOffice_WebApi_RequestOptions_”></a> GetAllNavigatorCompanyAsync(RequestOptions)
Gets array of all NavigatorCompany objects.Parameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<NavigatorCompany[]> Array of all NavigatorCompany objects<a id=“SuperOffice_WebApi_Agents_NavigatorAgent_GetNavigatorCompaniesAsync_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetNavigatorCompaniesAsync(string, RequestOptions)
Parameters
name string
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<NavigatorCompany[]><a id=“SuperOffice_WebApi_Agents_NavigatorAgent_GetNavigatorCompanyListAsync_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> GetNavigatorCompanyListAsync(int[], RequestOptions)
Gets an array of specific NavigatorCompany objects.Parameters
navigatorCompanyIds int[]
The identifiers of the NavigatorCompany object
requestOptions RequestOptions
Override language/culture codes on this request.