Virtru.SDK.CredentialsHmac Class Reference

Inheritance diagram for Virtru.SDK.CredentialsHmac:

Public Member Functions
	CredentialsHmac (string userId, string apiKey, string apiSecret)
override StringStringMap	generateAuthHeaders (string url, string method, string body, StringStringMap headers, string date)
override string	getUserId ()
override string	str ()
void	Dispose ()
CredentialsType	getType ()
string	getTypeStr ()

Protected Member Functions
override void	Dispose (bool disposing)

Protected Attributes
bool	swigCMemOwn

Package Functions
	CredentialsHmac (global::System.IntPtr cPtr, bool cMemoryOwn)

Static Package Functions
static global::System.Runtime.InteropServices.HandleRef	getCPtr (CredentialsHmac obj)
static global::System.Runtime.InteropServices.HandleRef	swigRelease (CredentialsHmac obj)
static global::System.Runtime.InteropServices.HandleRef	getCPtr (Credentials obj)
static global::System.Runtime.InteropServices.HandleRef	swigRelease (Credentials obj)

Private Attributes
global::System.Runtime.InteropServices.HandleRef	swigCPtr

Constructor & Destructor Documentation

Virtru.SDK.CredentialsHmac.CredentialsHmac ( global::System.IntPtr  cPtr, bool  cMemoryOwn  )

inlinepackage

Virtru.SDK.CredentialsHmac.CredentialsHmac ( string  userId, string  apiKey, string  apiSecret  )

inline

Constructor

Parameters

userId	- The userId of the credentials
apiKey	- The apiKey of the credentials
apiSecret	- The API secret of the credentials

Member Function Documentation

override void Virtru.SDK.CredentialsHmac.Dispose ( bool  disposing )

inlineprotectedvirtual

Reimplemented from Virtru.SDK.Credentials.

void Virtru.SDK.Credentials.Dispose ( )

inlineinherited

override StringStringMap Virtru.SDK.CredentialsHmac.generateAuthHeaders ( string  url, string  method, string  body, StringStringMap  headers, string  date  )

inlinevirtual

Create the header key/value pairs that should be added to the request to establish authorization

Parameters

url	- The full url for the request, including protocol prefix and parameter information
method	- The method for the request, such as 'get' or 'post'
body	- The body for the request, can be an empty string if there is no body content
headers	- a set of http header key/value pairs that should be included in calculations
date	- the date string that should be used in calculations Returns - map of key/value http header pairs

Reimplemented from Virtru.SDK.Credentials.

static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.CredentialsHmac.getCPtr ( CredentialsHmac  obj )

inlinestaticpackage

static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.Credentials.getCPtr ( Credentials  obj )

inlinestaticpackageinherited

CredentialsType Virtru.SDK.Credentials.getType ( )

inlineinherited

Get the type of this credentials object, as specified by the CredentialsType enum value

Returns

- The type enum value of this credentials instance

string Virtru.SDK.Credentials.getTypeStr ( )

inlineinherited

Get the type of this credentials object, as a string representation of the CredentialsType

Returns

- The type of this credentials instance as a string

override string Virtru.SDK.CredentialsHmac.getUserId ( )

inlinevirtual

Get the userId associated with these credentials

Reimplemented from Virtru.SDK.Credentials.

override string Virtru.SDK.CredentialsHmac.str ( )

inlinevirtual

Get a debug-friendly string describing this credentials object

Returns

- The type of this credentials instance as a string

Reimplemented from Virtru.SDK.Credentials.

static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.CredentialsHmac.swigRelease ( CredentialsHmac  obj )

inlinestaticpackage

static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.Credentials.swigRelease ( Credentials  obj )

inlinestaticpackageinherited

Member Data Documentation

bool Virtru.SDK.Credentials.swigCMemOwn

protectedinherited

global.System.Runtime.InteropServices.HandleRef Virtru.SDK.CredentialsHmac.swigCPtr

private

---

The documentation for this class was generated from the following file:

• CredentialsHmac.cs