Click or drag to resize

IRestClient Interface

Represents a RESTFul client which encapsulates some of the functions of the request

Namespace: SanteDB.Core.Http
Assembly: SanteDB.Core.Api (in SanteDB.Core.Api.dll) Version: 3.0.2081-alpha+b4ae72647f2cc271f89142f76fff26ad69e00f5a
Syntax
public interface IRestClient : IDisposable, 
	IReportProgressChanged

The IRestClient type exposes the following members.

Properties
 NameDescription
Public propertyAccept Gets or sets the format to accept data in
Public propertyCredentials Gets or sets the credentials to be used for this client
Public propertyDescription Gets the service client description
Top
Methods
 NameDescription
Public methodDeleteTResult Deletes the specified object
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable)
Public methodGet(String) Perform a raw get
Public methodGet(String, NameValueCollection) Perform a raw get
Public methodGetTResult(String) Gets the specified item
Public methodGetTResult(String, NameValueCollection) Get the specified TResult using query
Public methodHead(String) Executes a HEAD operation against the URL
Public methodHead(String, NameValueCollection) Executes a HEAD operation against the URL
Public methodInvokeTBody, TResult(String, String, TBody) Invokes the specified method against the URL provided
Public methodInvokeTBody, TResult(String, String, String, TBody) Invokes the specified method against the URL provided
Public methodInvokeTBody, TResult(String, String, String, TBody, NameValueCollection) Invokes the specified method against the url provided
Public methodLockTResult Lock the specified resource
Public methodOptionsTResult Executes an Options against the URL
Public methodPatchTPatch(String, String, TPatch) Instructs the server to perform a PATCH operation
Public methodPatchTPatch(String, String, String, TPatch) Instructs the server to perform a PATCH operation
Public methodPostTBody, TResult(String, TBody) Executes a post against the url
Public methodPostTBody, TResult(String, String, TBody) Executes a post against the url
Public methodPutTBody, TResult(String, TBody) Executes a PUT (update) for the specified object
Public methodPutTBody, TResult(String, String, TBody) Executes a PUT (update) for the specified object
Public methodUnlockTResult Unlock the specified resource
Top
Events
 NameDescription
Public eventProgressChanged Fired when the progress of this instance has changed
(Inherited from IReportProgressChanged)
Public eventRequesting Fired prior to rest client invoking a method
Public eventResponded Fired after the request has been finished
Public eventResponding Fired when the response is initiated
Top
Extension Methods
 NameDescription
Public Extension MethodSetTimeout Set timeout on me to millisecondTimeout
(Defined by ExtensionMethods)
Public Extension MethodTryPing Attempts to send an HTTP PING to the rest client service. If successful, the reported time drift and latency are returned.
(Defined by RestClientExtensions)
Top
See Also