Foxit PDF SDK
fsdk.RMSEncryptData Class Reference

Public Member Functions

def GetIrm_version ()
 Get microsoft IRM version. More...
 
def GetIs_encrypt_metadata ()
 Get a boolean value to decide whether to encrypt metadata or not. More...
 
def GetPublish_license ()
 Get the Encoded Publishing License issued from server to the Content publisher, in ASCII encoding. More...
 
def GetServer_eul_list ()
 Get a string array that contains pairs of strings to represent content of a dictionary object which is encoded Server EUL. More...
 
def Set (is_encrypt_metadata, publish_license, server_eul_list, irm_version)
 Set value.
More...
 
def SetIrm_version (value)
 Set microsoft IRM version. More...
 
def SetIs_encrypt_metadata (value)
 Set a boolean value to decide whether to encrypt metadata or not. More...
 
def SetPublish_license (value)
 Set the Encoded Publishing License issued from server to the Content publisher, in ASCII encoding. More...
 
def SetServer_eul_list (value)
 Set a string array that contains pairs of strings to represent content of a dictionary object which is encoded Server EUL. More...
 

Detailed Description

This class represents some data used for class RMSSecurityHandler .

Member Function Documentation

◆ GetIrm_version()

fsdk.RMSEncryptData.GetIrm_version ( )

Get microsoft IRM version.

Returns
Microsoft IRM version. It should be above 1. If input version is below 1, Foxit PDF SDK will use 1 as version by default. Default value: 1.0.

◆ GetIs_encrypt_metadata()

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

◆ GetPublish_license()

fsdk.RMSEncryptData.GetPublish_license ( )

Get the Encoded Publishing License issued from server to the Content publisher, in ASCII encoding.

This field contains the publishing license from Microsoft IRM services or a comparable IRM service. The original data of Publishing License should be compressed by Flate compression algorithm at first, and then encoded by Base-64 Encryption algorithm. Foxit PDF SDK offers functions in class fsdk.Codec for Flate compression algorithm and Base-64 Encryption algorithm. Please refer to class fsdk.Codec if necessary.

Returns
The Encoded Publishing License issued from server to the Content publisher, in ASCII encoding. This should not be an empty string.

◆ GetServer_eul_list()

fsdk.RMSEncryptData.GetServer_eul_list ( )

Get a string array that contains pairs of strings to represent content of a dictionary object which is encoded Server EUL.

In this string array, the count of strings should be multiply of 2. 2 strings are in a pair, and each pair represents content of a dictionary object which is encoded Server EUL.
For each pair, the first string is ServerID, and the second one is ServerEUL. The original data of Server ID and Server EUL should be compressed by Flate compression algorithm at first, and then encoded by Base-64 Encryption algorithm. Foxit PDF SDK offers functions in class fsdk.Codec for Flate compression algorithm and Base-64 Encryption algorithm.Please refer to class fsdk.Codec if necessary.
An empty array means not use such information.

Returns
A string array that contains pairs of strings to represent content of a dictionary object which is encoded Server EUL.

◆ Set()

def fsdk.RMSEncryptData.Set (   is_encrypt_metadata,
  publish_license,
  server_eul_list,
  irm_version 
)

Set value.

Parameters
[in]is_encrypt_metadatatrue means to encrypt metadata, and false means not to encrypt metadata.
[in]publish_licenseThe Encoded Publishing License issued from server to the Content publisher, in ASCII encoding. This should not be an empty string.
This field contains the publishing license from Microsoft IRM services or a comparable IRM service. The original data of Publishing License should be compressed by Flate compression algorithm at first, and then encoded by Base-64 Encryption algorithm. Foxit PDF SDK offers functions in class fsdk.Codec for Flate compression algorithm and Base-64 Encryption algorithm. Please refer to class fsdk.Codec if necessary.
[in]server_eul_listIn this string array, the count of strings should be multiply of 2. 2 strings are in a pair, and each pair represents content of a dictionary object which is encoded Server EUL.
For each pair, the first string is ServerID, and the second one is ServerEUL. The original data of Server ID and Server EUL should be compressed by Flate compression algorithm at first, and then encoded by Base-64 Encryption algorithm. Foxit PDF SDK offers functions in class fsdk.Codec for Flate compression algorithm and Base-64 Encryption algorithm. Please refer to class fsdk.Codec if necessary.
An empty array means not use such information.
[in]irm_versionMicrosoft IRM version. It should be above 1. If input version is below 1, Foxit PDF SDK will use 1 as version by default. Default value: 1.0.
Returns
None.

◆ SetIrm_version()

fsdk.RMSEncryptData.SetIrm_version (   value)

Set microsoft IRM version.

Parameters
[in]valueMicrosoft IRM version. It should be above 1. If input version is below 1, Foxit PDF SDK will use 1 as version by default. Default value: 1.0.
Returns
None.

◆ SetIs_encrypt_metadata()

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

◆ SetPublish_license()

fsdk.RMSEncryptData.SetPublish_license (   value)

Set the Encoded Publishing License issued from server to the Content publisher, in ASCII encoding.

This field contains the publishing license from Microsoft IRM services or a comparable IRM service. The original data of Publishing License should be compressed by Flate compression algorithm at first, and then encoded by Base-64 Encryption algorithm. Foxit PDF SDK offers functions in class fsdk.Codec for Flate compression algorithm and Base-64 Encryption algorithm. Please refer to class fsdk.Codec if necessary.

Parameters
[in]valueThe Encoded Publishing License issued from server to the Content publisher, in ASCII encoding. This should not be an empty string.
Returns
None.

◆ SetServer_eul_list()

fsdk.RMSEncryptData.SetServer_eul_list (   value)

Set a string array that contains pairs of strings to represent content of a dictionary object which is encoded Server EUL.

In this string array, the count of strings should be multiply of 2. 2 strings are in a pair, and each pair represents content of a dictionary object which is encoded Server EUL.
For each pair, the first string is ServerID, and the second one is ServerEUL. The original data of Server ID and Server EUL should be compressed by Flate compression algorithm at first, and then encoded by Base-64 Encryption algorithm. Foxit PDF SDK offers functions in class fsdk.Codec for Flate compression algorithm and Base-64 Encryption algorithm.Please refer to class fsdk.Codec if necessary.
An empty array means not use such information.

Parameters
[in]valueA string array that contains pairs of strings to represent content of a dictionary object which is encoded Server EUL.
Returns
None.