def virtru_tdf3_python.EncryptFileParams.__init__ |
( |
|
inFilePath | ) |
|
Create an instance of EncryptFileParams.
Args:
inFilepath(string): The file on which the encryption is performed
NOTE:
The out file path will have .html/.tdf extension appended to
inFilePath based on protocol.
def virtru_tdf3_python.EncryptFileParams.__init__ |
( |
|
inFilePath, |
|
|
|
outFilePath |
|
) |
| |
Create an instance of EncryptFileParams.
Args:
in_file_path(string): The file on which the encryption is performed
out_file_path(string): The file path of the TDF after successful encryption
def virtru_tdf3_python.EncryptFileParams.set_display_message |
( |
| ) |
|
Set the display message for the TDF, this message shows up on the Virtru dashboard
Args:
display_message(string): The display message for the TDF
def virtru_tdf3_python.EncryptFileParams.set_display_name |
( |
|
display_name | ) |
|
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
Args:
display_name(string): The display name for the TDF
def virtru_tdf3_python.EncryptFileParams.set_mime_type |
( |
|
mime_type | ) |
|
Set the mime type (format) of the file that will be encrypted
NOTE: The default will be 'application/octet-stream' if not specified
Args:
mime_type(string): The mime type of the file
def virtru_tdf3_python.EncryptFileParams.set_policy |
( |
|
policy | ) |
|
Set the policy to be applied to the TDF
NOTE: If there is no policy defined for the TDF, default policy settings
will be applied
Args:
policy(Policy): The policy object
def virtru_tdf3_python.EncryptFileParams.share_with_users |
( |
|
users_list | ) |
|
Add access to the TDF file/data for the users in the list
Args:
users_list(list): Share the TDF with the users in the list
The documentation for this class was generated from the following file: