Virtru SDK for Python  2.8.0
Virtru Python SDK module - Create, Read, and Manage TDF3 Files
 All Classes Namespaces Files Functions Pages
virtru_tdf3_python.Policy Class Reference

Public Member Functions

def __init__
 
def set_owner
 
def get_owner
 
def enable_persistent_protection
 
def disable_persistent_protection
 
def is_persistent_protection_enabled
 
def enable_prevent_download
 
def disable_prevent_download
 
def is_prevent_download_enabled
 
def enable_print
 
def disable_print
 
def is_print_enabled
 
def enable_copy
 
def disable_copy
 
def is_copy_enabled
 
def enable_reshare
 
def disable_reshare
 
def is_reshare_enabled
 
def enable_watermarking
 
def disable_watermarking
 
def is_watermarking_enabled
 
def expire_in_mins
 
def expire_in_days
 
def add_expiration
 
def remove_expiration
 
def get_expiration
 
def share_with_users
 
def remove_users
 
def get_shared_users
 
def __repr__
 

Constructor & Destructor Documentation

def virtru_tdf3_python.Policy.__init__ ( )
          The Virtru policy object provides all the controls that can be applied to a TDF

Member Function Documentation

def virtru_tdf3_python.Policy.__repr__ ( )
 
def virtru_tdf3_python.Policy.add_expiration (   time_stamp)
           Add an expiration date (in ISO-8601 format) - Ex: 2019-05-24T16:12:41Z

          Args:
             time_stamp(string): Expiration date when the TDF will expire
def virtru_tdf3_python.Policy.disable_copy ( )
           Turns off copy policy control flag
def virtru_tdf3_python.Policy.disable_persistent_protection ( )
           Turns off persistent-protection policy control flag
def virtru_tdf3_python.Policy.disable_prevent_download ( )
           Turns off prevent-download policy control flag
def virtru_tdf3_python.Policy.disable_print ( )
           Turns off print policy control flag
def virtru_tdf3_python.Policy.disable_reshare ( )
           Turns off reshare policy control flag
def virtru_tdf3_python.Policy.disable_watermarking ( )
           Turns off watermarking policy control flag
def virtru_tdf3_python.Policy.enable_copy ( )
           Turns on copy policy control flag
def virtru_tdf3_python.Policy.enable_persistent_protection ( )
           Turns on persistent-protection policy control flag
def virtru_tdf3_python.Policy.enable_prevent_download ( )
           Turns on prevent-download policy control flag
def virtru_tdf3_python.Policy.enable_print ( )
           Turns on print policy control flag
def virtru_tdf3_python.Policy.enable_reshare ( )
           Turns on reshare policy control flag
def virtru_tdf3_python.Policy.enable_watermarking ( )
           Turns on watermarking policy control flag
def virtru_tdf3_python.Policy.expire_in_days (   days)
           Set the expiration in days

          Args:
             days(unsigned): Expiration time in days when the TDF will expire
def virtru_tdf3_python.Policy.expire_in_mins (   mins)
           Set the expiration in minutes

          Args:
             mins(unsigned): Expiration time in minutes when the TDF will expire
def virtru_tdf3_python.Policy.get_expiration ( )
           Return the expiration time(in ISO-8601 format) of the TDF

           NOTE:  If the expiration is not set, an empty string is return
def virtru_tdf3_python.Policy.get_owner ( )
           Return the owner of the TDF

           NOTE:  If the owner is not set, an empty string is return.
def virtru_tdf3_python.Policy.get_shared_users ( )
           Return all the user who have access to the TDF
def virtru_tdf3_python.Policy.is_copy_enabled ( )
           Return the status of 'Copy' control flag
def virtru_tdf3_python.Policy.is_persistent_protection_enabled ( )
           Return the status of 'PersistentProtection' control flag
def virtru_tdf3_python.Policy.is_prevent_download_enabled ( )
           Return the status of 'PreventDownload' control flag
def virtru_tdf3_python.Policy.is_print_enabled ( )
           Return the status of 'Print' control flag.
def virtru_tdf3_python.Policy.is_reshare_enabled ( )
           Return the status of 'Reshare' control flag
def virtru_tdf3_python.Policy.is_watermarking_enabled ( )
           Return the status of 'Watermarking' control flag
def virtru_tdf3_python.Policy.remove_expiration ( )
           Remove the expiration
def virtru_tdf3_python.Policy.remove_users (   users_list)
           Remove access for the TDF file/data with the users in the list

          Args:
             users_list(list): Remove access to the TDF file/data for the users in the list
def virtru_tdf3_python.Policy.set_owner (   owner)
          Set the owner of the tdf.

          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.

          Args:
             owner(string): The owner email address.
def virtru_tdf3_python.Policy.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: