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.EncryptParams Class Reference
Inheritance diagram for Virtru.SDK.EncryptParams:
Virtru.SDK.EncryptDataParams Virtru.SDK.EncryptFileParams Virtru.SDK.EncryptStreamParams Virtru.SDK.EncryptStringParams

Public Member Functions

void Dispose ()
 
 EncryptParams (EncryptParams encryptedParams)
 
EncryptParams operatorEqual (EncryptParams encryptedParams)
 
void setMimeType (string mimeType)
 
void setPolicy (Policy policy)
 
void setDisplayName (string displayName)
 
void setDisplayMessage (string displayMessage)
 
void shareWithUsers (StringVector users)
 

Protected Member Functions

virtual void Dispose (bool disposing)
 

Protected Attributes

bool swigCMemOwn
 

Package Functions

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

Static Package Functions

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

Private Member Functions

 ~EncryptParams ()
 

Private Attributes

global::System.Runtime.InteropServices.HandleRef swigCPtr
 

Constructor & Destructor Documentation

Virtru.SDK.EncryptParams.EncryptParams ( global::System.IntPtr  cPtr,
bool  cMemoryOwn 
)
inlinepackage
Virtru.SDK.EncryptParams.~EncryptParams ( )
inlineprivate
Virtru.SDK.EncryptParams.EncryptParams ( EncryptParams  encryptedParams)
inline

Copy constructor

Member Function Documentation

void Virtru.SDK.EncryptParams.Dispose ( )
inline
virtual void Virtru.SDK.EncryptParams.Dispose ( bool  disposing)
inlineprotectedvirtual
static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.EncryptParams.getCPtr ( EncryptParams  obj)
inlinestaticpackage
EncryptParams Virtru.SDK.EncryptParams.operatorEqual ( EncryptParams  encryptedParams)
inline

Assignment operator

void Virtru.SDK.EncryptParams.setDisplayMessage ( string  displayMessage)
inline

Set the display message for the tdf, this message shows up on the Virtru dashboard

Parameters
displayMessage- The display message for the tdf
void Virtru.SDK.EncryptParams.setDisplayName ( string  displayName)
inline

Set the display name for the tdf, this name shows up on the Virtru dashboard NOTE: If not set, the basename of inFilePath will be used

Parameters
displayName- The display name for the tdf
void Virtru.SDK.EncryptParams.setMimeType ( string  mimeType)
inline

Set the mime type (format) of the file that will be encrypted NOTE: The default will be 'application/octet-stream' if not specified

Parameters
mimeType- The mime type of the file
void Virtru.SDK.EncryptParams.setPolicy ( Policy  policy)
inline

Set the policy that to be applied to the tdf NOTE: If there is no policy defined for the tdf, default policy settings will be applied

Parameters
policy- The policy object
void Virtru.SDK.EncryptParams.shareWithUsers ( StringVector  users)
inline

Add access to the TDF file/data for the users in the list

Parameters
users- Share the TDF with the users in the vector
static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.EncryptParams.swigRelease ( EncryptParams  obj)
inlinestaticpackage

Member Data Documentation

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

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