Foxit PDF SDK
<FSAppProviderCallback>协议 参考

继承自 <NSObject> .

构造函数

(void) - beep:
 用于为指定的提示音类型播放提示音的回调函数。 更多...
 
(id< FSFileReaderCallback >) - downLoadUrl:
 用于从指定 URL 下载的回调函数。 更多...
 
(NSString *) - getAppInfo:
 用于获取指定信息类型的应用程序信息的回调函数。 更多...
 
(NSString *) - loadString:
 用于为指定情况加载本地语言字符串的回调函数。 更多...
 
(FSAppProviderCallbackMsgBoxButtonID) - msgBox:title:icon_type:button_type:
 用于设置消息框的回调函数。 更多...
 
(NSString *) - postRequestURL:data:content_type:encode:header:
 用于将数据 POST 到给定 URL 的回调函数。 更多...
 
(BOOL) - putRequestURL:data:encode:
 用于将数据 PUT 到给定 URL 的回调函数。 更多...
 
(NSString *) - response:title:default_answer:is_mask:
 用于响应的回调函数。 更多...
 
(NSArray< NSString * > *) - showFileDialog:string_filter:is_openfile_dialog:
 用于显示文件对话框的回调函数。 更多...
 

详细描述

此类表示作为 XFA 应用程序提供者的回调对象。 此类中的所有函数都用作回调函数。纯虚函数应由用户实现。

函数文档

◆ beep:()

- (void) beep: (FSAppProviderCallbackBeepType)  type
required

用于为指定的提示音类型播放提示音的回调函数。

参数
[in]type提示音类型。请参考从 FSAppProviderCallbackBeepTypeError 开始的值, 这将是其中之一。
返回
无。

◆ downLoadUrl:()

- (id<FSFileReaderCallback>) downLoadUrl: (NSString *)  url
required

用于从指定 URL 下载的回调函数。

参数
[in]url要下载的 URL。
返回
指向 ReaderCallback 对象的指针,可用于读取下载结果。

◆ getAppInfo:()

- (NSString*) getAppInfo: (FSActionCallbackAppInfoType)  app_info
required

用于获取指定信息类型的应用程序信息的回调函数。

参数
[in]app_info要检索其信息的应用程序信息类型。请参考从 FSAppProviderCallbackAppInfoType 开始的值,这将是其中之一。
返回
应用程序信息的字符串。

◆ loadString:()

- (NSString*) loadString: (FSAppProviderCallbackStringID)  string_id
required

用于为指定情况加载本地语言字符串的回调函数。

此函数对于用户在指定情况下使用本地语言消息非常有用。 用户可以重写或翻译示例消息(在 FSAppProviderCallbackStringIDValidateFailed 开始的值的注释中定义) 为指定情况的本地语言,并将结果字符串返回给 Foxit PDF SDK。 特别地,Foxit PDF SDK 将在示例消息的格式部分添加一些必要的信息/数据, 以使消息更有用。建议用户在重写或翻译的结果字符串中保留这些格式部分; 否则,这些信息/数据将不会丢失,也不会添加到用户提供的消息中。

参数
[in]string_id用于指定情况的字符串 ID。请参考从 FSAppProviderCallbackStringIDValidateFailed 开始的值,这将是其中之一。
返回
用于指定情况的字符串。

◆ msgBox:title:icon_type:button_type:()

- (FSAppProviderCallbackMsgBoxButtonID) msgBox: (NSString *)  message
title: (NSString *)  title
icon_type: (FSAppProviderCallbackMsgBoxIconType)  icon_type
button_type: (FSAppProviderCallbackMsgBoxButtonType)  button_type 
required

用于设置消息框的回调函数。

参数
[in]message消息字符串。
[in]title消息框的标题。
[in]icon_type消息框的图标类型。请参考从 FSAppProviderCallbackMsgBoxIconError 开始的值,这将是其中之一。
[in]button_type消息框的按钮类型。请参考从 FSAppProviderCallbackMsgBtnTypeOK 开始的值,这将是其中之一。
返回
消息框的按钮ID。请参考从 FSAppProviderCallbackMsgBtnIDOK 开始的值, 应该是其中之一。

◆ postRequestURL:data:content_type:encode:header:()

- (NSString*) postRequestURL: (NSString *)  url
data: (NSString *)  data
content_type: (NSString *)  content_type
encode: (NSString *)  encode
header: (NSString *)  header 
required

用于将数据 POST 到给定 URL 的回调函数。

参数
[in]url数据将被 POST 到的 URL。
[in]data要 POST 的数据。
[in]content_type表示数据内容类型的字符串。此字符串可以是 "text/html"、 "text/xml"、"text/plain"、"multipart/form-data"、"application/x-www-form-urlencoded"、 "application/octet-stream" 或任何有效的 MIME 类型。
[in]encode表示数据编码的字符串。此字符串可以是 "UTF-8"、"UTF-16"、 "ISO8859-1" 或任何被认可的 [IANA] 字符编码。
[in]header表示 POST 中要包含的任何额外 HTTP 头的字符串。
返回
响应字符串。

◆ putRequestURL:data:encode:()

- (BOOL) putRequestURL: (NSString *)  url
data: (NSString *)  data
encode: (NSString *)  encode 
required

用于将数据 PUT 到给定 URL 的回调函数。

参数
[in]url数据将被 PUT 到的 URL。
[in]data要 PUT 的数据。
[in]encode表示数据编码的字符串。此字符串可以是 "UTF-8"、"UTF-16"、 "ISO8859-1" 或任何被认可的 [IANA] 字符编码。
返回
YES 表示成功,而 NO 表示失败。

◆ response:title:default_answer:is_mask:()

- (NSString*) response: (NSString *)  question
title: (NSString *)  title
default_answer: (NSString *)  default_answer
is_mask: (BOOL)  is_mask 
required

用于响应的回调函数。

参数
[in]question表示问题的字符串。
[in]title表示标题的字符串。
[in]default_answer表示默认答案的字符串。它可以是空字符串, 表示没有默认答案。
[in]is_maskYES 表示答案应该用 '*' 遮罩, 而 NO 表示答案不需要用 '*' 遮罩。
返回
表示响应答案的字符串。

◆ showFileDialog:string_filter:is_openfile_dialog:()

- (NSArray<NSString*>*) showFileDialog: (NSString *)  string_title
string_filter: (NSString *)  string_filter
is_openfile_dialog: (BOOL)  is_openfile_dialog 
required

用于显示文件对话框的回调函数。

参数
[in]string_title表示对话框标题的字符串。
[in]string_filter表示对话框文件过滤器的字符串。
[in]is_openfile_dialogYES 表示对话框是打开文件对话框, 而 NO 表示对话框是另存为对话框。
返回
文件路径的数组。