virtru::EncryptParams Class Reference

#include <virtru_encrypt_params.h>

Inheritance diagram for virtru::EncryptParams:

Public Member Functions
	~EncryptParams ()
	EncryptParams (const EncryptParams &encryptedParams)
EncryptParams &	operator= (const EncryptParams &encryptedParams)
	EncryptParams (EncryptParams &&encryptedParams) noexcept
EncryptParams &	operator= (EncryptParams &&encryptedParams)
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 Member Functions
	EncryptParams ()

Protected Attributes
friend	Client
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

Constructor & Destructor Documentation

virtru::EncryptParams::~EncryptParams

(

)

Destructor.

virtru::EncryptParams::EncryptParams

(

const EncryptParams &

encryptedParams

)

Copy constructor.

virtru::EncryptParams::EncryptParams ( EncryptParams &&  encryptedParams )

noexcept

Move copy constructor.

virtru::EncryptParams::EncryptParams ( )

protected

Constructor.

Member Function Documentation

EncryptParams& virtru::EncryptParams::operator=

(

const EncryptParams &

encryptedParams

)

Assignment operator.

EncryptParams& virtru::EncryptParams::operator=

(

EncryptParams &&

encryptedParams

)

Move assignment operator.

void virtru::EncryptParams::setDisplayMessage

(

const std::string &

displayMessage

)

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

)

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

)

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

)

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

)

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::EncryptParams::Client

protected

std::string virtru::EncryptParams::m_displayMessage

protected

std::string virtru::EncryptParams::m_displayName

protected

std::string virtru::EncryptParams::m_mimeType

protected

Policy virtru::EncryptParams::m_policy

protected

std::vector<std::string> virtru::EncryptParams::m_sharedUsers

protected

std::string virtru::EncryptParams::m_tdfOwner

protected

---

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

• virtru_encrypt_params.h