 | Rest |
Represents a simple rest client
Inheritance HierarchyNamespace: SanteDB.Core.Http
Assembly: SanteDB.Core.Api (in SanteDB.Core.Api.dll) Version: 3.0.2081-alpha+b4ae72647f2cc271f89142f76fff26ad69e00f5a
SyntaxThe RestClientBase type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RestClientBase | Initializes a new instance of the IRestClient class. |
| RestClientBase(IRestClientDescription) | Initializes a new instance of the IRestClient class. |
Properties| Name | Description | |
|---|---|---|
 | Accept | Gets or sets the format to accept data in |
| Credentials | Gets or sets the credentials to be used for this client |
| Description | Get the description (configuration) of this service |
Methods| Name | Description | |
|---|---|---|
 | CreateCorrectRequestUri | Create a uri for a request when the request uri is not valid. |
| CreateHttpRequest | Create the HTTP request |
 | CreateQueryString | Create the query string from a list of query parameters |
| DeleteTResult | Executes an HTTP delete operation on the server |
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| FireProgressChanged | Fire that progress has changed |
| FireResponding | Fire responding event |
| Get(String) | Perform a raw get |
| Get(String, NameValueCollection) | Perform a raw get |
| GetTResult(String) | Gets the specified item |
| GetTResult(String, KeyValuePairString, String) | Fetches the specified result from the server |
| GetTResult(String, NameValueCollection) | Get the specified TResult |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetRequestCredentials | Tries to retrieve the credentials that should be used for a HttpWebRequest request. Override this method to provide credentials to requests. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Head(String) | Executes a HEAD operation against the URL |
| Head(String, NameValueCollection) | Executes a HEAD operation against the URL |
| InvokeTBody, TResult(String, String, TBody) | Invokes the specified method against the URL provided |
| InvokeTBody, TResult(String, String, String, TBody) | Invokes the specified method against the URL provided |
| InvokeTBody, TResult(String, String, String, TBody, NameValueCollection) | Invoke the specified method against the server |
| InvokeTBody, TResult(String, String, String, TBody, NameValueCollection, WebHeaderCollection) | Invoke the specified method against the server |
| InvokeInternalTBody, TResult | Invokes the request. Implementations of RestClientBase must provide the implementation of InvokeInternalTBody, TResult(String, String, String, WebHeaderCollection, WebHeaderCollection, TBody, NameValueCollection). |
| LockTResult | Perform a lock on the specified resource |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OptionsTResult | Executes an HTTP options against the server |
| PatchTPatch(String, String, TPatch) | Patches the specified resource at url with patch when ifMatch is true |
| PatchTPatch(String, String, String, TPatch) | Patches the specified resource at url with patch when ifMatch is true |
| PostTBody, TResult(String, TBody) | Execute a post against the url |
| PostTBody, TResult(String, String, TBody) | Execute a post against the url |
| PutTBody, TResult(String, TBody) | Executes an HTTP PUT against the server |
| PutTBody, TResult(String, String, TBody) | Executes an HTTP PUT against the server |
| SetRequestAcceptEncoding | Sets the request Accept-Encoding header based on the Description for the client. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| UnlockTResult | Perform an unlock |
Events| Name | Description | |
|---|---|---|
 | ProgressChanged | Progress has changed |
| Requesting | Fired on request |
| Responded | Fired on response |
| Responding | Fired on response |
Extension Methods| Name | Description | |
|---|---|---|
 | ConvertTReturn |
The purpose of this method is to convert object me to TReturn. Why?
Because if you have an instance of Act that actually needs to be a SubstanceAdministration we can't just cast
so we have to copy.
(Defined by ExtensionMethods) |
| SetTimeout |
Set timeout on me to millisecondTimeout (Defined by ExtensionMethods) |
| TryPing |
Attempts to send an HTTP PING to the rest client service. If successful, the reported time drift and latency are returned.
(Defined by RestClientExtensions) |
| WithControl |
With control parameter is used as a wrapper for _ parameters
(Defined by QueryFilterExtensions) |
RemarksThis class represets a base class from which specific implementations of a REST client can be implemented
See Also