virtru::EncryptFileParams Class Reference

#include <virtru_encrypt_file_params.h>

Inheritance diagram for virtru::EncryptFileParams:

Public Member Functions
	EncryptFileParams (const std::string &inFilePath)
	EncryptFileParams (const std::string &inFilePath, const std::string &outFilePath)
	EncryptFileParams ()=delete
virtual	~EncryptFileParams ()
	EncryptFileParams (const EncryptFileParams &encryptedFileParams)
EncryptFileParams &	operator= (const EncryptFileParams &encryptedFileParams)
	EncryptFileParams (EncryptFileParams &&encryptedFileParams)
EncryptFileParams &	operator= (EncryptFileParams &&encryptedFileParams)
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
std::string	m_inputFilePath
std::string	m_outFilePath

Constructor & Destructor Documentation

virtru::EncryptFileParams::EncryptFileParams

(

const std::string &

inFilePath

)

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::EncryptFileParams::EncryptFileParams	(	const std::string &	inFilePath,
		const std::string &	outFilePath
	)

Constructor

Parameters

inFilePath	- The file on which the encryption is performed
outFilePath	- The file path of the tdf after successful encryption

virtru::EncryptFileParams::EncryptFileParams ( )

delete

Default constructor not supported.

virtual virtru::EncryptFileParams::~EncryptFileParams ( )

virtual

Destructor.

virtru::EncryptFileParams::EncryptFileParams

(

const EncryptFileParams &

encryptedFileParams

)

Copy constructor.

virtru::EncryptFileParams::EncryptFileParams

(

EncryptFileParams &&

encryptedFileParams

)

Move copy constructor.

Member Function Documentation

EncryptFileParams& virtru::EncryptFileParams::operator=

(

const EncryptFileParams &

encryptedFileParams

)

Assignment operator.

EncryptFileParams& virtru::EncryptFileParams::operator=

(

EncryptFileParams &&

encryptedFileParams

)

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

private

std::string virtru::EncryptParams::m_displayMessage

protectedinherited

std::string virtru::EncryptParams::m_displayName

protectedinherited

std::string virtru::EncryptFileParams::m_inputFilePath

private

std::string virtru::EncryptParams::m_mimeType

protectedinherited

std::string virtru::EncryptFileParams::m_outFilePath

private

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:

• virtru_encrypt_file_params.h