<a id=“SuperOffice_WebApi_Agents_DatabaseAgent”></a> Class DatabaseAgent
Namespace: SuperOffice.WebApi.AgentsAssembly: SuperOffice.WebApi.dll Database schema queries and changes
Inheritance
object ← AgentBase ← DatabaseAgentImplements
IDatabaseAgent, 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 (DatabaseAgent agent = new DatabaseAgent(mySession)) { // call methods on agent here… }</code></pre>Constructors
<a id=“SuperOffice_WebApi_Agents_DatabaseAgent__ctor_System_Net_Http_HttpClient_”></a> DatabaseAgent(HttpClient)
Constructor: Database schema queries and changesParameters
httpClient HttpClient
Use this HTTP client instead of making own HttpClient instance.
<a id=“SuperOffice_WebApi_Agents_DatabaseAgent__ctor_SuperOffice_WebApi_WebApiOptions_System_Net_Http_HttpClient_”></a> DatabaseAgent(WebApiOptions, HttpClient)
Constructor: Database schema queries and changesParameters
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_DatabaseAgent_GetStepsFromNetServerCodeAsync_SuperOffice_WebApi_RequestOptions_”></a> GetStepsFromNetServerCodeAsync(RequestOptions)
Get information about the dictionary steps that NetServer was generated forParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DictionaryStepInformation[]> Array of dictionary steps used when NetServer was generated, listing only the highest number for each step<a id=“SuperOffice_WebApi_Agents_DatabaseAgent_GetStepsInDatabaseAsync_SuperOffice_WebApi_RequestOptions_”></a> GetStepsInDatabaseAsync(RequestOptions)
Get information about the dictionary steps that are in the currently-loggedon databaseParameters
requestOptions RequestOptions
Override language/culture codes on this request.