Foxit PDF SDK
fsdk.PayLoadData Class Reference

Public Member Functions

def GetCrypto_filter ()
 Get the name of the cryptographic filter used to encrypt the encrypted payload document. More...
 
def GetDescription ()
 Get description for payload file to show applications or confront users prompt information. More...
 
def GetFile_name ()
 Get the payload file name. More...
 
def GetFile_size ()
 Get the payload file size. More...
 
def GetVersion ()
 Get the version number of the cryptographic filter used to encrypt the encrypted payload referenced by this dictionary. More...
 
def Set (version, crypto_filter, file_name, file_size, description)
 Set value. More...
 
def SetCrypto_filter (value)
 Set the name of the cryptographic filter used to encrypt the encrypted payload document. More...
 
def SetDescription (value)
 Set description for payload file to show applications or confront users prompt information. More...
 
def SetFile_name (value)
 Set the payload file name. More...
 
def SetFile_size (value)
 Set the payload file size. More...
 
def SetVersion (value)
 Set the version number of the cryptographic filter used to encrypt the encrypted payload referenced by this dictionary. More...
 

Detailed Description

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

Member Function Documentation

◆ GetCrypto_filter()

fsdk.PayLoadData.GetCrypto_filter ( )

Get the name of the cryptographic filter used to encrypt the encrypted payload document.

Returns
The name of the cryptographic filter used to encrypt the encrypted payload document.

◆ GetDescription()

fsdk.PayLoadData.GetDescription ( )

Get description for payload file to show applications or confront users prompt information.

Returns
Description for payload file to show applications or confront users prompt information.

◆ GetFile_name()

fsdk.PayLoadData.GetFile_name ( )

Get the payload file name.

Returns
The payload file name.

◆ GetFile_size()

fsdk.PayLoadData.GetFile_size ( )

Get the payload file size.

Returns
The payload file size.

◆ GetVersion()

fsdk.PayLoadData.GetVersion ( )

Get the version number of the cryptographic filter used to encrypt the encrypted payload referenced by this dictionary.

Returns
The version number of the cryptographic filter used to encrypt the encrypted payload referenced by this dictionary.

◆ Set()

def fsdk.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.

◆ SetCrypto_filter()

fsdk.PayLoadData.SetCrypto_filter (   value)

Set the name of the cryptographic filter used to encrypt the encrypted payload document.

Parameters
[in]valueThe name of the cryptographic filter used to encrypt the encrypted payload document.
Returns
None.

◆ SetDescription()

fsdk.PayLoadData.SetDescription (   value)

Set description for payload file to show applications or confront users prompt information.

Parameters
[in]valueDescription for payload file to show applications or confront users prompt information.
Returns
None.

◆ SetFile_name()

fsdk.PayLoadData.SetFile_name (   value)

Set the payload file name.

Parameters
[in]valueThe payload file name.
Returns
None.

◆ SetFile_size()

fsdk.PayLoadData.SetFile_size (   value)

Set the payload file size.

Parameters
[in]valueThe payload file size.
Returns
None.

◆ SetVersion()

fsdk.PayLoadData.SetVersion (   value)

Set the version number of the cryptographic filter used to encrypt the encrypted payload referenced by this dictionary.

Parameters
[in]valueThe version number of the cryptographic filter used to encrypt the encrypted payload referenced by this dictionary.
Returns
None.