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

Instance Methods

(void) - dealloc
 
(void *) - getCptr
 
(id) - init
 Constructor.
More...
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithIs_encrypt_metadata:sub_filter:cipher:key_length:is_owner:user_permissions:
 
(id) - initWithOther:
 Constructor, with another DRM encrypt data object.
More...
 
(void) - set:sub_filter:cipher:key_length:is_owner:user_permissions:
 Set value.
More...
 

Protected Attributes

BOOL swigCMemOwn
 
void * swigCPtr
 

Properties

FSSecurityHandlerCipherType cipher
 Cipher type. Please refer to values starting from FSSecurityHandlerCipherRC4 and this should be one of these values except FSSecurityHandlerCipherNone.
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...
 
BOOL is_owner
 A boolean value to decide whether current user is owner or not. YES means current user is owner, and NO means current user is not owner.
More...
 
int key_length
 The key length, in bytes.
For FSSecurityHandlerCipherRC4 cipher, this value should be between 5 and 16.
For FSSecurityHandlerCipherAES cipher, this value should be 16 or 32.
More...
 
NSString * sub_filter
 The sub filter name that specifies the syntax of the encryption dictionary contents.
More...
 
unsigned int user_permissions
 The user permissions. Please refer to values starting from FSPDFDocPermPrint and this can be one or combination of these values.
More...
 

Detailed Description

This class represents some data used for class FSDRMSecurityHandler .

Method Documentation

◆ dealloc

- (void) dealloc

◆ getCptr

- (void*) getCptr

◆ init

- (id) init

Constructor.

◆ initWithCptr:swigOwnCObject:

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

◆ initWithIs_encrypt_metadata:sub_filter:cipher:key_length:is_owner:user_permissions:

- (id) initWithIs_encrypt_metadata: (BOOL)  is_encrypt_metadata
sub_filter: (NSString *)  sub_filter
cipher: (FSSecurityHandlerCipherType cipher
key_length: (int)  key_length
is_owner: (BOOL)  is_owner
user_permissions: (unsigned int)  user_permissions 

◆ initWithOther:

- (id) initWithOther: (FSDRMEncryptData*)  other

Constructor, with another DRM encrypt data object.

Parameters
[in]otherAnother DRM encrypt data object.

◆ set:sub_filter:cipher:key_length:is_owner:user_permissions:

- (void) set: (BOOL)  is_encrypt_metadata
sub_filter: (NSString *)  sub_filter
cipher: (FSSecurityHandlerCipherType cipher
key_length: (int)  key_length
is_owner: (BOOL)  is_owner
user_permissions: (unsigned int)  user_permissions 

Set value.

Parameters
[in]is_encrypt_metadataYES means to encrypt metadata, and NO means not to encrypt metadata
[in]sub_filterThe sub filter name that specifies the syntax of the encryption dictionary contents.
[in]cipherCipher type. Please refer to values starting from FSSecurityHandlerCipherRC4 and this should be one of these values except FSSecurityHandlerCipherNone.
[in]key_lengthThe key length, in bytes.
For FSSecurityHandlerCipherRC4 cipher, this value should be between 5 and 16.
For FSSecurityHandlerCipherAES cipher, this value should be 16 or 32.
[in]is_ownerYES means current user is owner, and NO means current user is not owner.
[in]user_permissionsThe user permissions. Please refer to values starting from FSPDFDocPermPrint and this can be one or combination of these values.
Returns
None.

Member Data Documentation

◆ swigCMemOwn

- (BOOL) swigCMemOwn
protected

◆ swigCPtr

- (void*) swigCPtr
protected

Property Documentation

◆ cipher

- (FSSecurityHandlerCipherType) cipher
readwritenonatomicassign

Cipher type. Please refer to values starting from FSSecurityHandlerCipherRC4 and this should be one of these values except FSSecurityHandlerCipherNone.

◆ 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.

◆ is_owner

- (BOOL) is_owner
readwritenonatomicassign

A boolean value to decide whether current user is owner or not. YES means current user is owner, and NO means current user is not owner.

◆ key_length

- (int) key_length
readwritenonatomicassign

The key length, in bytes.
For FSSecurityHandlerCipherRC4 cipher, this value should be between 5 and 16.
For FSSecurityHandlerCipherAES cipher, this value should be 16 or 32.

◆ sub_filter

- (NSString *) sub_filter
readwritenonatomiccopy

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

◆ user_permissions

- (unsigned int) user_permissions
readwritenonatomicassign

The user permissions. Please refer to values starting from FSPDFDocPermPrint and this can be one or combination of these values.