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.Policy Class Reference
Inheritance diagram for Virtru.SDK.Policy:

Public Member Functions

void Dispose ()
 
 Policy ()
 
 Policy (Policy policy)
 
Policy operatorEqual (Policy policy)
 
void setOwner (string owner)
 
string getOwner ()
 
void shareWithUsers (StringVector users)
 
void removeUsers (StringVector users)
 
StringVector getSharedUsers ()
 
void enableReshare ()
 
void disableReshare ()
 
bool isReshareEnabled ()
 
void enableWatermarking ()
 
void disableWatermarking ()
 
bool isWatermarkingEnabled ()
 
void enablePrint ()
 
void disablePrint ()
 
bool isPrintEnabled ()
 
void enableCopy ()
 
void disableCopy ()
 
bool isCopyEnabled ()
 
void enablePersistentProtection ()
 
void disablePersistentProtection ()
 
bool isPersistentProtectionEnabled ()
 
void enablePreventDownload ()
 
void disablePreventDownload ()
 
bool isPreventDownloadEnabled ()
 
void expireInMins (uint mins)
 
void expireInDays (uint days)
 
void addExpiration (string expirationDate)
 
void removeExpiration ()
 
string getExpiration ()
 
string toString ()
 

Protected Member Functions

virtual void Dispose (bool disposing)
 

Protected Attributes

bool swigCMemOwn
 

Package Functions

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

Static Package Functions

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

Private Member Functions

 ~Policy ()
 

Private Attributes

global::System.Runtime.InteropServices.HandleRef swigCPtr
 

Constructor & Destructor Documentation

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

Constructor

Virtru.SDK.Policy.Policy ( Policy  policy)
inline

Copy constructor

Member Function Documentation

void Virtru.SDK.Policy.addExpiration ( string  expirationDate)
inline

Access to the TDF data will be revoked for all users at the specified date. The owner will retain access after the expiration time is reached. The expiration date is specified in ISO-8601 format, and can include a time component. Ex: 2019-05-24T16:12:41Z

Parameters
expirationDate- Expiration date when the TDF will expire
void Virtru.SDK.Policy.disableCopy ( )
inline

Turns off copy policy control flag

void Virtru.SDK.Policy.disablePersistentProtection ( )
inline

Turns off persistent protection policy control flag

void Virtru.SDK.Policy.disablePreventDownload ( )
inline

Turns off prevent download policy control flag

void Virtru.SDK.Policy.disablePrint ( )
inline

Turns off print policy control flag

void Virtru.SDK.Policy.disableReshare ( )
inline

Turns off reshare policy control flag

void Virtru.SDK.Policy.disableWatermarking ( )
inline

Turns off watermarking policy control flag

void Virtru.SDK.Policy.Dispose ( )
inline
virtual void Virtru.SDK.Policy.Dispose ( bool  disposing)
inlineprotectedvirtual
void Virtru.SDK.Policy.enableCopy ( )
inline

Turns on copy policy control flag

void Virtru.SDK.Policy.enablePersistentProtection ( )
inline

Turns on persistent protection policy control flag

void Virtru.SDK.Policy.enablePreventDownload ( )
inline

Turns on prevent download policy control flag

void Virtru.SDK.Policy.enablePrint ( )
inline

Turns on print policy control flag

void Virtru.SDK.Policy.enableReshare ( )
inline

Turns on reshare policy control flag

void Virtru.SDK.Policy.enableWatermarking ( )
inline

Turns on watermarking policy control flag

void Virtru.SDK.Policy.expireInDays ( uint  days)
inline

Set the expiration in days

Access to the TDF data will be revoked for all users in the number of days specified, starting from the time this call is made. The owner will retain access after the expiration time is reached.

Parameters
days- days until expiration
void Virtru.SDK.Policy.expireInMins ( uint  mins)
inline

Set the expiration in minutes

Access to the TDF data will be revoked for all users in the number of minutes specified, starting from the time this call is made. The owner will retain access after the expiration time is reached.

Parameters
mins- minutes until expiration
static global.System.Runtime.InteropServices.HandleRef Virtru.SDK.Policy.getCPtr ( Policy  obj)
inlinestaticpackage
string Virtru.SDK.Policy.getExpiration ( )
inline

Return the expiration time(in ISO-8601 format) of the TDF.

Returns
string - The expiration time(in ISO-8601 format) of the TDF. NOTE: If the expiration is not set, an empty string is return.

string Virtru.SDK.Policy.getOwner ( )
inline

Return the owner of the TDF.

Returns
owner - The owner's email address. NOTE: If the owner is not set, an empty string is return.

StringVector Virtru.SDK.Policy.getSharedUsers ( )
inline

Return all the user who have access to the TDF.

Returns
users - All the user who have access to the TDF.

bool Virtru.SDK.Policy.isCopyEnabled ( )
inline

Return the status of 'Copy' control flag.

Returns
bool - True, if 'Copy' control flag is set.

bool Virtru.SDK.Policy.isPersistentProtectionEnabled ( )
inline

Return the status of 'PersistenProtection' control flag.

Returns
bool - True, if 'PersistentProtection' control flag is set.

bool Virtru.SDK.Policy.isPreventDownloadEnabled ( )
inline

Return the status of 'PreventDownload' control flag.

Returns
bool - True, if 'PreventDownload' control flag is set.

bool Virtru.SDK.Policy.isPrintEnabled ( )
inline

Return the status of 'Print' control flag.

Returns
bool - True, if 'Print' control flag is set.

bool Virtru.SDK.Policy.isReshareEnabled ( )
inline

Return the status of 'Reshare' control flag.

Returns
bool - True, if 'Reshare' control flag is set.

bool Virtru.SDK.Policy.isWatermarkingEnabled ( )
inline

Return the status of 'Watermarking' control flag.

Returns
bool - True, if 'Watermarking' control flag is set.

Policy Virtru.SDK.Policy.operatorEqual ( Policy  policy)
inline

Assignment operator

void Virtru.SDK.Policy.removeExpiration ( )
inline

Remove the expiration

void Virtru.SDK.Policy.removeUsers ( StringVector  users)
inline

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

Parameters
users- Remove access to the TDF file/data for the users in the vector
void Virtru.SDK.Policy.setOwner ( string  owner)
inline

Set the owner of the TDF

Parameters
owner- The owner's email address NOTE: By default, the owner is the address that was used when the client instance was created. This method will change the owner to the specified email address for the instance.
void Virtru.SDK.Policy.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.Policy.swigRelease ( Policy  obj)
inlinestaticpackage
string Virtru.SDK.Policy.toString ( )
inline

Return the description of all the policy controls of the instance.

Returns
- A formated string of all the policy controls of the instance.

Member Data Documentation

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

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