Foxit PDF SDK
FoxitPDFSDKPython2.PayLoadData Class Reference

Inherits FoxitPDFSDKPython2._object.

Public Member Functions

def PayLoadData ()
 Constructor.

 
def PayLoadData (payload_data)
 Constructor, with another payload data object.
More...
 
def PayLoadData (version, crypto_filter, file_name, file_size, description)
 Constructor, with parameters.
More...
 
def Set (version, crypto_filter, file_name, file_size, description)
 Set value.
More...
 

Static Public Attributes

 crypto_filter = _swig_property(_fsdk.PayLoadData_crypto_filter_get, _fsdk.PayLoadData_crypto_filter_set)
 The name of the cryptographic filter used to encrypt the encrypted payload document.

 
 description = _swig_property(_fsdk.PayLoadData_description_get, _fsdk.PayLoadData_description_set)
 Description for payload file to show applications or confront users prompt information.

 
 file_name = _swig_property(_fsdk.PayLoadData_file_name_get, _fsdk.PayLoadData_file_name_set)
 The payload file name.

 
 file_size = _swig_property(_fsdk.PayLoadData_file_size_get, _fsdk.PayLoadData_file_size_set)
 The payload file size.

 
 version = _swig_property(_fsdk.PayLoadData_version_get, _fsdk.PayLoadData_version_set)
 The version number of the cryptographic filter used to encrypt the encrypted payload referenced by this dictionary.

 

Detailed Description

This class represents payload data, which is used for a PDF 2.0 wrapped PDF document.

Constructor & Destructor Documentation

◆ PayLoadData() [1/2]

def FoxitPDFSDKPython2.PayLoadData.PayLoadData (   version,
  crypto_filter,
  file_name,
  file_size,
  description 
)

Constructor, with parameters.

Parameters
[in]versionThe version number of the cryptographic filter used to encrypt the encrypted payload referenced by this dictionary.
[in]crypto_filterThe name of the cryptographic filter used to encrypt the encrypted payload document.
[in]file_nameThe payload file name.
[in]file_sizeThe payload file size.
[in]descriptionDescription for payload file to show applications or confront users prompt information.

◆ PayLoadData() [2/2]

def FoxitPDFSDKPython2.PayLoadData.PayLoadData (   payload_data)

Constructor, with another payload data object.

Parameters
[in]payload_dataAnother payload data object.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython2.PayLoadData.Set (   version,
  crypto_filter,
  file_name,
  file_size,
  description 
)

Set value.

Parameters
[in]versionThe version number of the cryptographic filter used to encrypt the encrypted payload referenced by this dictionary.
[in]crypto_filterThe name of the cryptographic filter used to encrypt the encrypted payload document.
[in]file_nameThe payload file name.
[in]file_sizeThe payload file size.
[in]descriptionDescription for payload file to show applications or confront users prompt information.