Foxit PDF SDK
FoxitPDFSDKPython3.StdEncryptData Class Reference

Inherits FoxitPDFSDKPython3._object.

Public Member Functions

def StdEncryptData ()
 Constructor.

 
def StdEncryptData (other)
 Constructor, with another standard encrypt data object.
More...
 
def Set (is_encrypt_metadata, user_permissions, cipher, key_length)
 Set value.
More...
 

Static Public Attributes

 cipher = _swig_property(_fsdk.StdEncryptData_cipher_get, _fsdk.StdEncryptData_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.StdEncryptData_is_encrypt_metadata_get, _fsdk.StdEncryptData_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.

 
 key_length = _swig_property(_fsdk.StdEncryptData_key_length_get, _fsdk.StdEncryptData_key_length_set)
 The key length, in bytes.
More...
 
 user_permissions = _swig_property(_fsdk.StdEncryptData_user_permissions_get, _fsdk.StdEncryptData_user_permissions_set)
 The user permissions. Please refer to values starting from FoxitPDFSDKPython3.PDFDoc.e_PermPrint and this should be one or combination of these values.

 

Detailed Description

This class represents some data used for class StdSecurityHandler .

Constructor & Destructor Documentation

◆ StdEncryptData()

def FoxitPDFSDKPython3.StdEncryptData.StdEncryptData (   other)

Constructor, with another standard encrypt data object.

Parameters
[in]otherAnother standard encrypt data object.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython3.StdEncryptData.Set (   is_encrypt_metadata,
  user_permissions,
  cipher,
  key_length 
)

Set value.

Parameters
[in]is_encrypt_metadatatrue means to encrypt metadata, and false means not to encrypt metadata.
[in]user_permissionsThe user permissions. Please refer to values starting from FoxitPDFSDKPython3.PDFDoc.e_PermPrint and this should be one or combination of these values.
[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.
Returns
None.

Member Data Documentation

◆ key_length

FoxitPDFSDKPython3.StdEncryptData.key_length = _swig_property(_fsdk.StdEncryptData_key_length_get, _fsdk.StdEncryptData_key_length_set)
static

The key length, in bytes.