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

Instance Methods

(void) - dealloc
 
(void *) - getCptr
 
(id) - init
 Constructor.
More...
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithPayload_data:
 Constructor, with another payload data object.
More...
 
(id) - initWithVersion:crypto_filter:file_name:file_size:description:
 
(void) - set:crypto_filter:file_name:file_size:description:
 Set value.
More...
 

Protected Attributes

BOOL swigCMemOwn
 
void * swigCPtr
 

Properties

NSString * crypto_filter
 The name of the cryptographic filter used to encrypt the encrypted payload document.
More...
 
NSString * description
 Description for payload file to show applications or confront users prompt information.
More...
 
NSString * file_name
 The payload file name.
More...
 
long long file_size
 The payload file size.
More...
 
float version
 The version number of the cryptographic filter used to encrypt the encrypted payload referenced by this dictionary.
More...
 

Detailed Description

This class represents payload data, which is used for a PDF 2.0 wrapped PDF document.

Method Documentation

◆ dealloc

- (void) dealloc

◆ getCptr

- (void*) getCptr

◆ init

- (id) init

Constructor.

◆ initWithCptr:swigOwnCObject:

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

◆ initWithPayload_data:

- (id) initWithPayload_data: (FSPayLoadData*)  payload_data

Constructor, with another payload data object.

Parameters
[in]payload_dataAnother payload data object.

◆ initWithVersion:crypto_filter:file_name:file_size:description:

- (id) initWithVersion: (float)  version
crypto_filter: (NSString *)  crypto_filter
file_name: (NSString *)  file_name
file_size: (long long)  file_size
description: (NSString *)  description 

◆ set:crypto_filter:file_name:file_size:description:

- (void) set: (float)  version
crypto_filter: (NSString *)  crypto_filter
file_name: (NSString *)  file_name
file_size: (long long)  file_size
description: (NSString *)  description 

Set value.

Parameters
[in]versionThe version number of the cryptographic filter used to encrypt the encrypted payload referenced by this dictionary.
[in]crypto_filterThe name of the cryptographic filter used to encrypt the encrypted payload document.
[in]file_nameThe payload file name.
[in]file_sizeThe payload file size.
[in]descriptionDescription for payload file to show applications or confront users prompt information.

Member Data Documentation

◆ swigCMemOwn

- (BOOL) swigCMemOwn
protected

◆ swigCPtr

- (void*) swigCPtr
protected

Property Documentation

◆ crypto_filter

- (NSString *) crypto_filter
readwritenonatomiccopy

The name of the cryptographic filter used to encrypt the encrypted payload document.

◆ description

- (NSString *) description
readwritenonatomiccopy

Description for payload file to show applications or confront users prompt information.

◆ file_name

- (NSString *) file_name
readwritenonatomiccopy

The payload file name.

◆ file_size

- (long long) file_size
readwritenonatomicassign

The payload file size.

◆ version

- (float) version
readwritenonatomicassign

The version number of the cryptographic filter used to encrypt the encrypted payload referenced by this dictionary.