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

Instance Methods

(void) - dealloc
 
(void *) - getCptr
 
(id) - init
 Constructor.
More...
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithIs_encrypt_metadata:filter:sub_filter:
 
(id) - initWithOther:
 Constructor, with another custom encrypt data object.
More...
 
(void) - set:filter:sub_filter:
 Set value.
More...
 

Protected Attributes

BOOL swigCMemOwn
 
void * swigCPtr
 

Properties

NSString * filter
 The filter name of a custom security callback object. It should not be an empty string.
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 * sub_filter
 The sub filter name that specifies the syntax of the encryption dictionary contents. It should not be an empty string.
More...
 

Detailed Description

This class represents some data used for class FSCustomSecurityHandler .

Method Documentation

◆ dealloc

- (void) dealloc

◆ getCptr

- (void*) getCptr

◆ init

- (id) init

Constructor.

◆ initWithCptr:swigOwnCObject:

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

◆ initWithIs_encrypt_metadata:filter:sub_filter:

- (id) initWithIs_encrypt_metadata: (BOOL)  is_encrypt_metadata
filter: (NSString *)  filter
sub_filter: (NSString *)  sub_filter 

◆ initWithOther:

- (id) initWithOther: (FSCustomEncryptData*)  other

Constructor, with another custom encrypt data object.

Parameters
[in]otherAnother custom encrypt data object.

◆ set:filter:sub_filter:

- (void) set: (BOOL)  is_encrypt_metadata
filter: (NSString *)  filter
sub_filter: (NSString *)  sub_filter 

Set value.

Parameters
[in]is_encrypt_metadataYES means to encrypt metadata, and NO means not to encrypt metadata.
[in]filterThe filter name of a custom security callback object. It should not be an empty string.
[in]sub_filterThe sub filter name that specifies the syntax of the encryption dictionary contents. It should not be an empty string.
Returns
None.

Member Data Documentation

◆ swigCMemOwn

- (BOOL) swigCMemOwn
protected

◆ swigCPtr

- (void*) swigCPtr
protected

Property Documentation

◆ filter

- (NSString *) filter
readwritenonatomiccopy

The filter name of a custom security callback object. It should not be an empty string.

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

◆ sub_filter

- (NSString *) sub_filter
readwritenonatomiccopy

The sub filter name that specifies the syntax of the encryption dictionary contents. It should not be an empty string.