Virtru SDK for C++  2.8.0
Virtru C++ SDK library - Create, Read, and Manage TDF3 Files
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
virtru::EncryptDataParams Class Reference

#include <virtru_encrypt_data_params.h>

Inheritance diagram for virtru::EncryptDataParams:
virtru::EncryptParams

Public Member Functions

 EncryptDataParams (TDFDataSourceCb &&dataSourceCb, TDFDataSinkCb &&dataSinkCb)
 
 ~EncryptDataParams ()
 
 EncryptDataParams ()=delete
 
 EncryptDataParams (const EncryptDataParams &encryptDataParams)=delete
 
EncryptDataParamsoperator= (const EncryptDataParams &encryptDataParams)=delete
 
 EncryptDataParams (EncryptDataParams &&encryptDataParams)=delete
 
EncryptDataParamsoperator= (EncryptDataParams &&encryptDataParams)=delete
 
void setMimeType (const std::string &mimeType)
 
void setPolicy (const Policy &policy)
 
void setDisplayName (const std::string &displayName)
 
void setDisplayMessage (const std::string &displayMessage)
 
void shareWithUsers (const std::vector< std::string > &users)
 

Protected Attributes

std::string m_tdfOwner
 
std::string m_mimeType
 
std::string m_displayName
 
std::string m_displayMessage
 
std::vector< std::string > m_sharedUsers
 
Policy m_policy
 

Private Attributes

friend Client
 
TDFDataSourceCb m_dataSourceCb
 
TDFDataSinkCb m_dataSinkCb
 

Constructor & Destructor Documentation

virtru::EncryptDataParams::EncryptDataParams ( TDFDataSourceCb &&  dataSourceCb,
TDFDataSinkCb &&  dataSinkCb 
)

Constructor

Parameters
dataSourceCb- The callback producing the data to be encrypted.
dataSinkCb- The callback consuming the encrypted data after successful encryption
virtru::EncryptDataParams::~EncryptDataParams ( )

Destructor.

virtru::EncryptDataParams::EncryptDataParams ( )
delete

Default constructor not supported.

virtru::EncryptDataParams::EncryptDataParams ( const EncryptDataParams encryptDataParams)
delete

Copy constructor.

virtru::EncryptDataParams::EncryptDataParams ( EncryptDataParams &&  encryptDataParams)
delete

Move copy constructor.

Member Function Documentation

EncryptDataParams& virtru::EncryptDataParams::operator= ( const EncryptDataParams encryptDataParams)
delete

Assignment operator.

EncryptDataParams& virtru::EncryptDataParams::operator= ( EncryptDataParams &&  encryptDataParams)
delete

Move assignment operator.

void virtru::EncryptParams::setDisplayMessage ( const std::string &  displayMessage)
inherited

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::EncryptParams::setDisplayName ( const std::string &  displayName)
inherited

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::EncryptParams::setMimeType ( const std::string &  mimeType)
inherited

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::EncryptParams::setPolicy ( const Policy policy)
inherited

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::EncryptParams::shareWithUsers ( const std::vector< std::string > &  users)
inherited

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

Parameters
users- Share the TDF with the users in the vector

Member Data Documentation

friend virtru::EncryptDataParams::Client
private
TDFDataSinkCb virtru::EncryptDataParams::m_dataSinkCb
private
TDFDataSourceCb virtru::EncryptDataParams::m_dataSourceCb
private
std::string virtru::EncryptParams::m_displayMessage
protectedinherited
std::string virtru::EncryptParams::m_displayName
protectedinherited
std::string virtru::EncryptParams::m_mimeType
protectedinherited
Policy virtru::EncryptParams::m_policy
protectedinherited
std::vector<std::string> virtru::EncryptParams::m_sharedUsers
protectedinherited
std::string virtru::EncryptParams::m_tdfOwner
protectedinherited

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