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
Public Member Functions | Protected Member Functions | Protected Attributes | Package Functions | Static Package Functions | Private Attributes | List of all members
Virtru.SDK.EncryptFileParams Class Reference
Inheritance diagram for Virtru.SDK.EncryptFileParams:
Virtru.SDK.EncryptParams

Public Member Functions

 EncryptFileParams (string inFilePath)
 
 EncryptFileParams (string inFilePath, string outFilePath)
 
 EncryptFileParams (EncryptFileParams encryptedFileParams)
 
EncryptFileParams operatorEqual (EncryptFileParams encryptedFileParams)
 
void Dispose ()
 
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

override void Dispose (bool disposing)
 

Protected Attributes

bool swigCMemOwn
 

Package Functions

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

Static Package Functions

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

Private Attributes

global::System.Runtime.InteropServices.HandleRef swigCPtr
 

Constructor & Destructor Documentation

Virtru.SDK.EncryptFileParams.EncryptFileParams ( global::System.IntPtr  cPtr,
bool  cMemoryOwn 
)
inlinepackage
Virtru.SDK.EncryptFileParams.EncryptFileParams ( string  inFilePath)
inline

Constructor NOTE: The out file path will have .html/.tdf extension appended to inFilePath based on protocol.

Parameters
inFilePath- The file on which the encryption is performed
Virtru.SDK.EncryptFileParams.EncryptFileParams ( string  inFilePath,
string  outFilePath 
)
inline

Constructor

Parameters
inFilePath- The file on which the encryption is performed
outFilePath- The file path of the tdf after successful encryption
Virtru.SDK.EncryptFileParams.EncryptFileParams ( EncryptFileParams  encryptedFileParams)
inline

Copy constructor

Member Function Documentation

override void Virtru.SDK.EncryptFileParams.Dispose ( bool  disposing)
inlineprotectedvirtual

Reimplemented from Virtru.SDK.EncryptParams.

void Virtru.SDK.EncryptParams.Dispose ( )
inlineinherited
static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.EncryptFileParams.getCPtr ( EncryptFileParams  obj)
inlinestaticpackage
static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.EncryptParams.getCPtr ( EncryptParams  obj)
inlinestaticpackageinherited
EncryptParams Virtru.SDK.EncryptParams.operatorEqual ( EncryptParams  encryptedParams)
inlineinherited

Assignment operator

EncryptFileParams Virtru.SDK.EncryptFileParams.operatorEqual ( EncryptFileParams  encryptedFileParams)
inline

Assignment operator

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

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)
inlineinherited

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)
inlineinherited

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)
inlineinherited

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)
inlineinherited

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.EncryptFileParams.swigRelease ( EncryptFileParams  obj)
inlinestaticpackage
static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.EncryptParams.swigRelease ( EncryptParams  obj)
inlinestaticpackageinherited

Member Data Documentation

bool Virtru.SDK.EncryptParams.swigCMemOwn
protectedinherited
global.System.Runtime.InteropServices.HandleRef Virtru.SDK.EncryptFileParams.swigCPtr
private
The documentation for this class was generated from the following file: