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: 2.2.1

Syntax

public interface IRestClient : IDisposable, 
	IReportProgressChanged

Public Interface IRestClient
	Inherits IDisposable, IReportProgressChanged

public interface class IRestClient : IDisposable, 
	IReportProgressChanged

type IRestClient =  
    interface
        interface IDisposable
        interface IReportProgressChanged
    end

The IRestClient type exposes the following members.

Properties

	Name	Description
	Credentials	Gets or sets the credentials to be used for this client
	Description	Gets the service client description

Methods

	Name	Description
	DeleteTResult	Deletes the specified object
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
	Get(String, KeyValuePairString, Object)	Perform a raw get
	GetTResult(String)	Gets the specified item
	GetTResult(String, KeyValuePairString, Object)	Gets a inumerable result set of type T
	Head	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, KeyValuePairString, Object)	Invokes the specified method against the url provided
	LockTResult	Lock the specified resource
	OptionsTResult	Executes an Options against the URL
	PatchTPatch(String, String, TPatch)	Instructs the server to perform a PATCH operation
	PatchTPatch(String, String, String, TPatch)	Instructs the server to perform a PATCH operation
	PostTBody, TResult(String, TBody)	Executes a post against the url
	PostTBody, TResult(String, String, TBody)	Executes a post against the url
	PutTBody, TResult(String, TBody)	Executes a PUT (update) for the specified object
	PutTBody, TResult(String, String, TBody)	Executes a PUT (update) for the specified object
	UnlockTResult	Unlock the specified resource

Events

	Name	Description
	ProgressChanged	Fired when the progress of this instance has changed (Inherited from IReportProgressChanged.)
	Requesting	Fired prior to rest client invoking a method
	Responded	Fired after the request has been finished
	Responding	Fired when the response is initiated