Foxit PDF SDK
fsdk.CustomEncryptData Class Reference

Public Member Functions

def GetFilter ()
 Get the filter name of a custom security callback object. More...
 
def GetIs_encrypt_metadata ()
 Get a boolean value to decide whether to encrypt metadata or not. More...
 
def GetSub_filter ()
 Get the sub filter name that specifies the syntax of the encryption dictionary contents. More...
 
def Set (is_encrypt_metadata, filter, sub_filter)
 Set value.
More...
 
def SetFilter (value)
 Set the filter name of a custom security callback object. More...
 
def SetIs_encrypt_metadata (value)
 Set a boolean value to decide whether to encrypt metadata or not. More...
 
def SetSub_filter (value)
 Set the sub filter name that specifies the syntax of the encryption dictionary contents. More...
 

Detailed Description

This class represents some data used for class CustomSecurityHandler .

Member Function Documentation

◆ GetFilter()

fsdk.CustomEncryptData.GetFilter ( )

Get the filter name of a custom security callback object.

Returns
The filter name of a custom security callback object. It should not be an empty string.

◆ GetIs_encrypt_metadata()

fsdk.CustomEncryptData.GetIs_encrypt_metadata ( )

Get a boolean value to decide whether to encrypt metadata or not.

Returns
A boolean value to decide whether to encrypt metadata or not. true means to encrypt metadata, and false means not to encrypt metadata.

◆ GetSub_filter()

fsdk.CustomEncryptData.GetSub_filter ( )

Get the sub filter name that specifies the syntax of the encryption dictionary contents.

Returns
The sub filter name that specifies the syntax of the encryption dictionary contents. It should not be an empty string.

◆ Set()

def fsdk.CustomEncryptData.Set (   is_encrypt_metadata,
  filter,
  sub_filter 
)

Set value.

Parameters
[in]is_encrypt_metadatatrue means to encrypt metadata, and false means not to encrypt metadata.
[in]filterThe filter name of a custom security callback object. It should not be an empty string.
[in]sub_filterThe sub filter name that specifies the syntax of the encryption dictionary contents. It should not be an empty string.
Returns
None.

◆ SetFilter()

fsdk.CustomEncryptData.SetFilter (   value)

Set the filter name of a custom security callback object.

Parameters
[in]valueThe filter name of a custom security callback object. It should not be an empty string.
Returns
None.

◆ SetIs_encrypt_metadata()

fsdk.CustomEncryptData.SetIs_encrypt_metadata (   value)

Set a boolean value to decide whether to encrypt metadata or not.

Parameters
[in]valueA boolean value to decide whether to encrypt metadata or not. true means to encrypt metadata, and false means not to encrypt metadata.
Returns
None.

◆ SetSub_filter()

fsdk.CustomEncryptData.SetSub_filter (   value)

Set the sub filter name that specifies the syntax of the encryption dictionary contents.

Parameters
[in]valueThe sub filter name that specifies the syntax of the encryption dictionary contents. It should not be an empty string.
Returns
None.