Foxit PDF SDK  9.1
FSRMSEncryptData Class Reference
Inheritance diagram for FSRMSEncryptData:

Instance Methods

(void) - dealloc
 
(void *) - getCptr
 
(id) - init
 Constructor.
More...
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithIs_encrypt_metadata:publish_license:server_eul_list:
 Constructor, with parameters.
More...
 
(id) - initWithIs_encrypt_metadata:publish_license:server_eul_list:irm_version:
 
(id) - initWithOther:
 Constructor, with another RMS encrypt data object.
More...
 
(void) - set:publish_license:server_eul_list:
 Set value.
More...
 
(void) - set:publish_license:server_eul_list:irm_version:
 Set value.
More...
 

Protected Attributes

BOOL swigCMemOwn
 
void * swigCPtr
 

Properties

float irm_version
 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.
More...
 
BOOL is_encrypt_metadata
 A boolean value to decide whether to encrypt metadata or not. YES means to encrypt metadata, and NO means not to encrypt metadata.
More...
 
NSString * publish_license
 The Encoded Publishing License issued from server to the Content publisher, in ASCII encoding. This should not be an empty string.
More...
 
NSArray< NSData * > * server_eul_list
 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 FSRMSSecurityHandler .

Method Documentation

◆ dealloc

- (void) dealloc

◆ getCptr

- (void*) getCptr

◆ init

- (id) init

Constructor.

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

◆ initWithIs_encrypt_metadata:publish_license:server_eul_list:

- (id) initWithIs_encrypt_metadata: (BOOL)  is_encrypt_metadata
publish_license: (NSString *)  publish_license
server_eul_list: (NSArray<NSData *> *)  server_eul_list 

Constructor, with parameters.

Parameters
[in]is_encrypt_metadataYES means to encrypt metadata, and NO 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 FSCodec for Flate compression algorithm and Base-64 Encryption algorithm. Please refer to class FSCodec 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 FSCodec for Flate compression algorithm and Base-64 Encryption algorithm. Please refer to class FSCodec if necessary.
An empty array means not use such information.

◆ initWithIs_encrypt_metadata:publish_license:server_eul_list:irm_version:

- (id) initWithIs_encrypt_metadata: (BOOL)  is_encrypt_metadata
publish_license: (NSData *)  publish_license
server_eul_list: (NSArray< NSData * > *)  server_eul_list
irm_version: (float)  irm_version 

◆ initWithOther:

- (id) initWithOther: (FSRMSEncryptData*)  other

Constructor, with another RMS encrypt data object.

Parameters
[in]otherAnother RMS encrypt data object.

◆ set:publish_license:server_eul_list:

- (void) set: (BOOL)  is_encrypt_metadata
publish_license: (NSString *)  publish_license
server_eul_list: (NSArray<NSData *> *)  server_eul_list 

Set value.

Parameters
[in]is_encrypt_metadataYES means to encrypt metadata, and NO 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 FSCodec for Flate compression algorithm and Base-64 Encryption algorithm. Please refer to class FSCodec 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 FSCodec for Flate compression algorithm and Base-64 Encryption algorithm. Please refer to class FSCodec if necessary.
An empty array means not use such information.
Returns
None.

◆ set:publish_license:server_eul_list:irm_version:

- (void) set: (BOOL)  is_encrypt_metadata
publish_license: (NSString *)  publish_license
server_eul_list: (NSArray<NSData *> *)  server_eul_list
irm_version: (float)  irm_version 

Set value.

Parameters
[in]is_encrypt_metadataYES means to encrypt metadata, and NO 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 FSCodec for Flate compression algorithm and Base-64 Encryption algorithm. Please refer to class FSCodec 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 FSCodec for Flate compression algorithm and Base-64 Encryption algorithm. Please refer to class FSCodec 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.

Member Data Documentation

◆ swigCMemOwn

- (BOOL) swigCMemOwn
protected

◆ swigCPtr

- (void*) swigCPtr
protected

Property Documentation

◆ irm_version

- (float) irm_version
readwritenonatomicassign

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.

◆ is_encrypt_metadata

- (BOOL) is_encrypt_metadata
readwritenonatomicassign

A boolean value to decide whether to encrypt metadata or not. YES means to encrypt metadata, and NO means not to encrypt metadata.

◆ publish_license

- (NSString *) publish_license
readwritenonatomiccopy

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

◆ server_eul_list

- (NSArray< NSData * > *) server_eul_list
readwritenonatomiccopy

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