FSPreflight类 参考

类 FSPreflight 继承关系图:

构造函数
(FSResultInformation *)	- analyze:progress_callback:
	分析PDF文件。 更多...
(FSResultInformation *)	- analyzeAndFixup:progress_callback:
	分析并修复PDF文件。 更多...
(BOOL)	- canFixup:
	检查项目密钥是否可以修复。 更多...
(BOOL)	- generateReport:progress_callback:
	在分析或修复后生成报告。 更多...
(BOOL)	- generateXMLReport:progress_callback:
	在分析或修复后生成XML报告。 更多...
(NSString *)	- getGroupItemComment:
	通过密钥获取组项的注释。 更多...
(NSString *)	- getGroupItemName:
	通过密钥获取组项的名称。 更多...
(NSArray< NSData * > *)	- getGroupNamesArray:operate_type:
	获取与库类型和操作类型对应的所有组名数组。 更多...
(NSArray< NSData * > *)	- getItemKeysArray:
	使用特定组名获取项目密钥数组。 更多...
(id)	- init
	构造函数。
(id)	- initWithOther:
	带另一个预检对象的构造函数。 更多...
(BOOL)	- isEmpty
	检查当前对象是否为空。 更多...
(void)	- setPreflightGroupLocalCallback:
	为预检组项设置本地化名称和注释回调。 更多...

详细描述

此类表示与指定行业配置文件匹配的分析和修复功能，并执行检查或修复。

函数文档

analyze:progress_callback:()

- (FSResultInformation *) analyze:		(FSPreflightSettingData*)	preflight_setting_data
progress_callback:		(id<FSComplianceProgressCallback>)	progress_callback

分析PDF文件。

参数

[in]	preflight_setting_data	预检设置数据。
[in]	progress_callback	由用户实现的 FSComplianceProgressCallback 对象，可用于获取进度数据。

返回

一个 FSResultInformation 对象。

analyzeAndFixup:progress_callback:()

- (FSResultInformation *) analyzeAndFixup:		(FSPreflightSettingData*)	preflight_setting_data
progress_callback:		(id<FSComplianceProgressCallback>)	progress_callback

分析并修复PDF文件。

参数

[in]	preflight_setting_data	预检设置数据。
[in]	progress_callback	由用户实现的 FSComplianceProgressCallback 对象，可用于获取进度数据。

返回

一个 FSResultInformation 对象。

canFixup:()

- (BOOL) canFixup:

(NSString *)

item_key

检查项目密钥是否可以修复。

参数

[in]

item_key

项目密钥。可以通过 FSPreflight::getItemKeysArray: 检索。

返回

YES表示可以修复，NO表示不能修复。

generateReport:progress_callback:()

- (BOOL) generateReport:		(FSPreflightReportSettingData*)	preflight_report_setting_data
progress_callback:		(id<FSComplianceProgressCallback>)	progress_callback

在分析或修复后生成报告。

此方法应在 FSPreflight::analyze:progress_callback: 或 FSPreflight::analyzeAndFixup:progress_callback: 之后调用。

参数

[in]	preflight_report_setting_data	预检报告设置数据。
[in]	progress_callback	由用户实现的 FSComplianceProgressCallback 对象，可用于获取进度数据。

返回

YES表示成功，NO表示失败。

generateXMLReport:progress_callback:()

- (BOOL) generateXMLReport:		(NSString *)	xml_report_file_path
progress_callback:		(id<FSComplianceProgressCallback>)	progress_callback

在分析或修复后生成XML报告。

此方法应在 FSPreflight::analyze:progress_callback: 或 FSPreflight::analyzeAndFixup:progress_callback: 之后调用。

参数

[in]	xml_report_file_path	用于保存XML报告文件的完整路径。这不应该是空字符串。
[in]	progress_callback	由用户实现的 FSComplianceProgressCallback 对象，可用于获取进度数据。 可以为nil。默认值：nil。

返回

YES表示成功，NO表示失败。

getGroupItemComment:()

- (NSString *) getGroupItemComment:

(NSString *)

key

通过密钥获取组项的注释。

仅提供英文，其他语言需要参考翻译的XML自行获取。

参数

[in]

key

组项的密钥。

返回

通过 FSPreflight::getGroupNamesArray:operate_type: 和 FSPreflight::getItemKeysArray: 接口获取的组项的注释。

getGroupItemName:()

- (NSString *) getGroupItemName:

(NSString *)

key

通过密钥获取组项的名称。

仅提供英文，其他语言需要参考翻译的XML自行获取。

参数

[in]

key

组项的密钥。

返回

通过 FSPreflight::getGroupNamesArray:operate_type: 和 FSPreflight::getItemKeysArray: 接口获取的组项的名称。

getGroupNamesArray:operate_type:()

- (NSArray< NSData * > *) getGroupNamesArray:		(FSPreflightSettingDataLibraryType)	library_type
operate_type:		(FSPreflightSettingDataOperateType)	operate_type

获取与库类型和操作类型对应的所有组名数组。

参数

[in]	library_type	库类型。请参考从 FSPreflightSettingDataLibraryTypeFoxit 开始的值， 这应该是这些值之一。
[in]	operate_type	操作类型。请参考从 FSPreflightSettingDataOperateTypeProfiles 开始的值， 这应该是这些值之一。

返回

组名数组。

getItemKeysArray:()

- (NSArray< NSData * > *) getItemKeysArray:

(NSString *)

group_name

使用特定组名获取项目密钥数组。

参数

[in]

group_name

可以从函数 FSPreflight::getGroupNamesArray:operate_type: 获取的组名。

返回

项目密钥数组。

initWithOther:()

- (id) initWithOther:

(FSPreflight*)

other

带另一个预检对象的构造函数。

参数

[in]

other

另一个预检对象。

isEmpty()

- (BOOL) isEmpty

检查当前对象是否为空。

当前对象为空时，意味着当前对象无用。

返回

YES表示当前对象为空，NO表示不为空。

setPreflightGroupLocalCallback:()

- (void) setPreflightGroupLocalCallback:

(id<FSPreflightGroupLocalCallback>)

callback

为预检组项设置本地化名称和注释回调。

此回调由 FSPreflight::getGroupItemName: 和 FSPreflight::getGroupItemComment: 使用，以提供组项的本地化名称和注释。当回调中有给定密钥的本地化字符串时， 将使用它；否则将使用默认的库字符串。

参数

[in]

callback

提供 本地化名称和注释的回调对象。

返回

无。