Foxit PDF SDK
foxit.pdf.RMSEncryptData Class Reference

Inherits SystemIDisposable.

Public Member Functions

 RMSEncryptData (bool is_encrypt_metadata, string publish_license, StringArray server_eul_list, float irm_version)
 Constructor, with parameters. More...
 
 RMSEncryptData ()
 Constructor.
 
 RMSEncryptData (RMSEncryptData other)
 Constructor, with another RMS encrypt data object. More...
 
void Set (bool is_encrypt_metadata, string publish_license, StringArray server_eul_list, float irm_version)
 Set value. More...
 

Properties

float irm_version [get, set]
 Microsoft IRM version. It should be above 1. If input version is below 1, Foxit PDF SDK will use 1 as version by default.0.
 
bool is_encrypt_metadata [get, set]
 A boolean value to decide whether to encrypt metadata or not. true means to encrypt metadata, and false means not to encrypt metadata.
 
string publish_license [get, set]
 The Encoded Publishing License issued from server to the Content publisher, in ASCII encoding. This should not be an empty string. More...
 
StringArrayserver_eul_list [get, 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 .

Constructor & Destructor Documentation

◆ RMSEncryptData() [1/2]

foxit.pdf.RMSEncryptData.RMSEncryptData ( bool  is_encrypt_metadata,
string  publish_license,
StringArray  server_eul_list,
float  irm_version 
)
inline

Constructor, with parameters.

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 foxit.common.Codec for Flate compression algorithm and Base-64 Encryption algorithm. Please refer to class foxit.common.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 foxit.common.Codec for Flate compression algorithm and Base-64 Encryption algorithm. Please refer to class foxit.common.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.0.

◆ RMSEncryptData() [2/2]

foxit.pdf.RMSEncryptData.RMSEncryptData ( RMSEncryptData  other)
inline

Constructor, with another RMS encrypt data object.

Parameters
[in]otherAnother RMS encrypt data object.

Member Function Documentation

◆ Set()

void foxit.pdf.RMSEncryptData.Set ( bool  is_encrypt_metadata,
string  publish_license,
StringArray  server_eul_list,
float  irm_version 
)
inline

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 foxit.common.Codec for Flate compression algorithm and Base-64 Encryption algorithm. Please refer to class foxit.common.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 foxit.common.Codec for Flate compression algorithm and Base-64 Encryption algorithm. Please refer to class foxit.common.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.0.
Returns
None.

Property Documentation

◆ publish_license

string foxit.pdf.RMSEncryptData.publish_license
getset

The 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 foxit.common.Codec for Flate compression algorithm and Base-64 Encryption algorithm. Please refer to class foxit.common.Codec if necessary.

◆ server_eul_list

StringArray foxit.pdf.RMSEncryptData.server_eul_list
getset

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 foxit.common.Codec for Flate compression algorithm and Base-64 Encryption algorithm.Please refer to class foxit.common.Codec if necessary.
An empty array means not use such information.