Foxit PDF SDK
FoxitPDFSDKPython3.DRMEncryptData Class Reference

Inherits FoxitPDFSDKPython3._object.

Public Member Functions

def DRMEncryptData (is_encrypt_metadata, sub_filter, cipher, key_length, is_owner, user_permissions)
 Constructor, with parameters. More...
 
def Set (is_encrypt_metadata, sub_filter, cipher, key_length, is_owner, user_permissions)
 Set value. More...
 

Static Public Attributes

 cipher = _swig_property(_fsdk.DRMEncryptData_cipher_get, _fsdk.DRMEncryptData_cipher_set)
 Cipher type. Please refer to values starting from FoxitPDFSDKPython3.SecurityHandler.e_CipherRC4 and this should be one of these values except FoxitPDFSDKPython3.SecurityHandler.e_CipherNone .
 
 is_encrypt_metadata = _swig_property(_fsdk.DRMEncryptData_is_encrypt_metadata_get, _fsdk.DRMEncryptData_is_encrypt_metadata_set)
 A boolean value to decide whether to encrypt metadata or not. true means to encrypt metadata, and false means not to encrypt metadata.
 
 is_owner = _swig_property(_fsdk.DRMEncryptData_is_owner_get, _fsdk.DRMEncryptData_is_owner_set)
 A boolean value to decide whether current user is owner or not. true means current user is owner, and false means current user is not owner.
 
 key_length = _swig_property(_fsdk.DRMEncryptData_key_length_get, _fsdk.DRMEncryptData_key_length_set)
 The key length, in bytes.
For FoxitPDFSDKPython3.SecurityHandler.e_CipherRC4 cipher, this value should be between 5 and 16.
For FoxitPDFSDKPython3.SecurityHandler.e_CipherAES cipher, this value should be 16 or 32.
 
 sub_filter = _swig_property(_fsdk.DRMEncryptData_sub_filter_get, _fsdk.DRMEncryptData_sub_filter_set)
 The sub filter name that specifies the syntax of the encryption dictionary contents.
 

Detailed Description

This class represents some data used for class DRMSecurityHandler .

Constructor & Destructor Documentation

◆ DRMEncryptData()

def FoxitPDFSDKPython3.DRMEncryptData.DRMEncryptData (   is_encrypt_metadata,
  sub_filter,
  cipher,
  key_length,
  is_owner,
  user_permissions 
)

Constructor, with parameters.

Constructor, with another DRM encrypt data object.

Constructor.

Parameters
[in]is_encrypt_metadatatrue means to encrypt metadata, and false means not to encrypt metadata
[in]sub_filterThe sub filter name that specifies the syntax of the encryption dictionary contents.
[in]cipherCipher type. Please refer to values starting from FoxitPDFSDKPython3.SecurityHandler.e_CipherRC4 and this should be one of these values except FoxitPDFSDKPython3.SecurityHandler.e_CipherNone .
[in]key_lengthThe key length, in bytes.
For FoxitPDFSDKPython3.SecurityHandler.e_CipherRC4 cipher, this value should be between 5 and 16.
For FoxitPDFSDKPython3.SecurityHandler.e_CipherAES cipher, this value should be 16 or 32.
[in]is_ownertrue means current user is owner, and false means current user is not owner.
[in]user_permissionsThe user permissions. Please refer to values starting from FoxitPDFSDKPython3.PDFDoc.e_PermPrint and this can be one or combination of these values.
[in]otherAnother DRM encrypt data object.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython3.DRMEncryptData.Set (   is_encrypt_metadata,
  sub_filter,
  cipher,
  key_length,
  is_owner,
  user_permissions 
)

Set value.

Parameters
[in]is_encrypt_metadatatrue means to encrypt metadata, and false means not to encrypt metadata
[in]sub_filterThe sub filter name that specifies the syntax of the encryption dictionary contents.
[in]cipherCipher type. Please refer to values starting from FoxitPDFSDKPython3.SecurityHandler.e_CipherRC4 and this should be one of these values except FoxitPDFSDKPython3.SecurityHandler.e_CipherNone .
[in]key_lengthThe key length, in bytes.
For FoxitPDFSDKPython3.SecurityHandler.e_CipherRC4 cipher, this value should be between 5 and 16.
For FoxitPDFSDKPython3.SecurityHandler.e_CipherAES cipher, this value should be 16 or 32.
[in]is_ownertrue means current user is owner, and false means current user is not owner.
[in]user_permissionsThe user permissions. Please refer to values starting from FoxitPDFSDKPython3.PDFDoc.e_PermPrint and this can be one or combination of these values.
Returns
None.