Virtru SDK for C#  2.8.0
Virtru C# SDK module - Create, Read, and Manage TDF3 Files
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Virtru.SDK.Credentials Class Reference
Inheritance diagram for Virtru.SDK.Credentials:
Virtru.SDK.CredentialsAppId Virtru.SDK.CredentialsHmac Virtru.SDK.CredentialsOidc

Public Member Functions

void Dispose ()
 
 Credentials (CredentialsType type)
 
 Credentials ()
 
CredentialsType getType ()
 
string getTypeStr ()
 
virtual string str ()
 
virtual StringStringMap generateAuthHeaders (string url, string method, string body, StringStringMap headers, string date)
 
virtual string getUserId ()
 

Protected Member Functions

virtual void Dispose (bool disposing)
 

Protected Attributes

bool swigCMemOwn
 

Package Functions

 Credentials (global::System.IntPtr cPtr, bool cMemoryOwn)
 

Static Package Functions

static
global::System.Runtime.InteropServices.HandleRef 
getCPtr (Credentials obj)
 
static
global::System.Runtime.InteropServices.HandleRef 
swigRelease (Credentials obj)
 

Private Member Functions

 ~Credentials ()
 

Private Attributes

global::System.Runtime.InteropServices.HandleRef swigCPtr
 

Constructor & Destructor Documentation

Virtru.SDK.Credentials.Credentials ( global::System.IntPtr  cPtr,
bool  cMemoryOwn 
)
inlinepackage
Virtru.SDK.Credentials.~Credentials ( )
inlineprivate
Virtru.SDK.Credentials.Credentials ( CredentialsType  type)
inline

Constructor

Parameters
type- The type of this credentials object, as specified by a CredentialsType enum value
Virtru.SDK.Credentials.Credentials ( )
inline

Constructor

Member Function Documentation

void Virtru.SDK.Credentials.Dispose ( )
inline
virtual void Virtru.SDK.Credentials.Dispose ( bool  disposing)
inlineprotectedvirtual
virtual StringStringMap Virtru.SDK.Credentials.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 in Virtru.SDK.CredentialsOidc, Virtru.SDK.CredentialsHmac, and Virtru.SDK.CredentialsAppId.

static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.Credentials.getCPtr ( Credentials  obj)
inlinestaticpackage
CredentialsType Virtru.SDK.Credentials.getType ( )
inline

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 ( )
inline

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

Returns
- The type of this credentials instance as a string

virtual string Virtru.SDK.Credentials.getUserId ( )
inlinevirtual

Get the userId associated with these credentials

Reimplemented in Virtru.SDK.CredentialsOidc, Virtru.SDK.CredentialsHmac, and Virtru.SDK.CredentialsAppId.

virtual string Virtru.SDK.Credentials.str ( )
inlinevirtual

Get a debug-friendly string describing this credentials object

Returns
- The type of this credentials instance as a string

Reimplemented in Virtru.SDK.CredentialsOidc, Virtru.SDK.CredentialsHmac, and Virtru.SDK.CredentialsAppId.

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

Member Data Documentation

bool Virtru.SDK.Credentials.swigCMemOwn
protected
global.System.Runtime.InteropServices.HandleRef Virtru.SDK.Credentials.swigCPtr
private

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