Click or drag to resize

RestClientBase Class

Represents a simple rest client
Inheritance Hierarchy

Namespace:  SanteDB.Core.Http
Assembly:  SanteDB.Core.Api (in SanteDB.Core.Api.dll) Version: 2.2.1
Syntax
public abstract class RestClientBase : IRestClient, 
	IDisposable, IReportProgressChanged

The RestClientBase type exposes the following members.

Constructors
  NameDescription
Public methodRestClientBase
Initializes a new instance of the IRestClient class.
Public methodRestClientBase(IRestClientDescription)
Initializes a new instance of the IRestClient class.
Top
Properties
  NameDescription
Public propertyCredentials
Gets or sets the credentials to be used for this client
Public propertyDescription
Get the description (configuration) of this service
Top
Methods
  NameDescription
Protected methodCreateHttpRequest
Create the HTTP request
Public methodStatic memberCreateQueryString
Create the query string from a list of query parameters
Public methodDeleteTResult
Executes an HTTP delete operation on the server
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodFireProgressChanged
Fire that progress has changed
Protected methodFireResponding
Fire responding event
Public methodGet(String, KeyValuePairString, Object)
Retrieves a raw byte array of data from the specified location
Public methodGetTResult(String)
Gets the specified item
Public methodGetTResult(String, KeyValuePairString, Object)
Fetches the specified result from the server
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHead
Perform a head operation against the specified 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, KeyValuePairString, Object)
Invoke the specified method against the server
Protected methodInvokeInternalTBody, TResult
Implementation specific implementatoin of invoke
Public methodLockTResult
Perform a lock on the specified resource
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOptionsTResult
Executes an HTTP options against the server
Public methodPatchTPatch(String, String, TPatch)
Patches the specified resource at url with patch when ifMatch is true
Public methodPatchTPatch(String, String, String, TPatch)
Patches the specified resource at url with patch when ifMatch is true
Public methodPostTBody, TResult(String, TBody)
Execute a post against the url
Public methodPostTBody, TResult(String, String, TBody)
Execute a post against the url
Public methodPutTBody, TResult(String, TBody)
Executes an HTTP PUT against the server
Public methodPutTBody, TResult(String, String, TBody)
Executes an HTTP PUT against the server
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnlockTResult
Perform an unlock
Top
Events
  NameDescription
Public eventProgressChanged
Progress has changed
Public eventRequesting
Fired on request
Public eventResponded
Fired on response
Public eventResponding
Fired on response
Top
Extension Methods
  NameDescription
Public Extension MethodConvertTReturn
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.)
Public Extension MethodGetInstanceOfTDomain
Gets an instance of TDomain from me
(Defined by ModelExtensions.)
Top
Remarks
This class represets a base class from which specific implementations of a REST client can be implemented
See Also