Foxit PDF SDK
fsdk.CertificateEncryptData Class Reference

Public Member Functions

def GetCipher ()
 Get cipher type. More...
 
def GetEnvelopes ()
 Get a string array which specifies an array of certificate envelopes. More...
 
def GetIs_encrypt_metadata ()
 Get a boolean value to decide whether to encrypt metadata or not. More...
 
def Set (is_encrypt_metadata, cipher, envelopes)
 Set value. More...
 
def SetCipher (value)
 Set cipher type. More...
 
def SetEnvelopes (value)
 Set a string array which specifies an array of certificate envelopes. More...
 
def SetIs_encrypt_metadata (value)
 Set a boolean value to decide whether to encrypt metadata or not. More...
 

Detailed Description

This class represents some data used for class CertificateSecurityHandler .

Member Function Documentation

◆ GetCipher()

fsdk.CertificateEncryptData.GetCipher ( )

Get cipher type.

Returns
Cipher type. Please refer to values starting from fsdk.SecurityHandlerE_CipherRC4 and this should be one of these values except fsdk.SecurityHandlerE_CipherNone .

◆ GetEnvelopes()

fsdk.CertificateEncryptData.GetEnvelopes ( )

Get a string array which specifies an array of certificate envelopes.

Returns
A string array which specifies an array of certificate envelopes. This array should contains one or more envelopes.

◆ GetIs_encrypt_metadata()

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

◆ Set()

def fsdk.CertificateEncryptData.Set (   is_encrypt_metadata,
  cipher,
  envelopes 
)

Set value.

Parameters
[in]is_encrypt_metadatatrue means to encrypt metadata, and false means not to encrypt metadata.
[in]cipherCipher type. Please refer to values starting from fsdk.SecurityHandlerE_CipherRC4 and this should be one of these values except fsdk.SecurityHandlerE_CipherNone .
[in]envelopesA string array which specifies an array of certificate envelopes. This array should contains one or more envelopes.
Returns
None.

◆ SetCipher()

fsdk.CertificateEncryptData.SetCipher (   value)

Set cipher type.

Parameters
[in]valueCipher type. Please refer to values starting from fsdk.SecurityHandlerE_CipherRC4 and this should be one of these values except fsdk.SecurityHandlerE_CipherNone .
Returns
None.

◆ SetEnvelopes()

fsdk.CertificateEncryptData.SetEnvelopes (   value)

Set a string array which specifies an array of certificate envelopes.

Parameters
[in]valueA string array which specifies an array of certificate envelopes. This array should contains one or more envelopes.
Returns
None.

◆ SetIs_encrypt_metadata()

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