Foxit PDF SDK
<FSAppProviderCallback> Protocol Reference

Inherits <NSObject>.

Instance Methods

(void) - beep:
 A callback function used to beep for specified beep type. More...
 
(id< FSFileReaderCallback >) - downLoadUrl:
 A callback function used to download from specified URL. More...
 
(NSString *) - getAppInfo:
 A callback function used to get application information for a specified information type. More...
 
(NSString *) - loadString:
 A callback function used to load a string in local language for a specified case. More...
 
(FSAppProviderCallbackMsgBoxButtonID- msgBox:title:icon_type:button_type:
 A callback function used to set message box. More...
 
(NSString *) - postRequestURL:data:content_type:encode:header:
 A callback function used to post data to the given url. More...
 
(BOOL) - putRequestURL:data:encode:
 A callback function used to put data to the given url. More...
 
(NSString *) - response:title:default_answer:is_mask:
 A callback function used to response. More...
 
(NSArray< NSString * > *) - showFileDialog:string_filter:is_openfile_dialog:
 A callback function used to show file dialog. More...
 

Detailed Description

This class represents a callback object as an XFA application provider. All the functions in this class are used as callback functions. Pure virtual functions should be implemented by user.

Method Documentation

◆ beep:()

- (void) beep: (FSAppProviderCallbackBeepType type
required

A callback function used to beep for specified beep type.

Parameters
[in]typeThe beep type. Please refer to values starting from FSAppProviderCallbackBeepTypeError and this would be one of these values.
Returns
None.

◆ downLoadUrl:()

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

A callback function used to download from specified URL.

Parameters
[in]urlA URL to be downloaded.
Returns
Pointer to a ReaderCallback object which can be used to read the downloading result.

◆ getAppInfo:()

- (NSString*) getAppInfo: (FSActionCallbackAppInfoType app_info
required

A callback function used to get application information for a specified information type.

Parameters
[in]app_infoThe type of application information, whose information is to retrieved. Please refer to values starting from FSAppProviderCallbackAppInfoType and this would be one of these values.
Returns
A string of application information.

◆ loadString:()

- (NSString*) loadString: (FSAppProviderCallbackStringID string_id
required

A callback function used to load a string in local language for a specified case.

This function is very useful for user to use local language for message of specified cases. User can re-write or translate the sample message (which is defined in the comment of values starting from FSAppProviderCallbackStringIDValidateFailed) into local language for the specified case, and return the result string to Foxit PDF SDK. Specially, Foxit PDF SDK will add some necessary information/data to the format part in the sample message, in order to make the message more useful. User is recommended to keep these format part in the re-written or translated result string; otherwise, these information/data will not be lost and will not be added to the message offered by user.

Parameters
[in]string_idA string ID to specify a case. Please refer to values starting from FSAppProviderCallbackStringIDValidateFailed and this would be one of these values.
Returns
A string used for the specified case.

◆ msgBox:title:icon_type:button_type:()

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

A callback function used to set message box.

Parameters
[in]messageA message string.
[in]titleThe title of message box.
[in]icon_typeThe icon type for message box. Please refer to values starting from FSAppProviderCallbackMsgBoxIconError and this would be one of these values.
[in]button_typeThe button type for message box. Please refer to values starting from FSAppProviderCallbackMsgBtnTypeOK and this would be one of these values.
Returns
The button ID for message box. Please refer to values starting from FSAppProviderCallbackMsgBtnIDOK and this should be one of these values.

◆ 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

A callback function used to post data to the given url.

Parameters
[in]urlA URL, to which the data will be posted.
[in]dataThe data to be posted.
[in]content_typeA string that represents the content type of data. This string could be "text/html", "text/xml", "text/plain", "multipart/form-data", "application/x-www-form-urlencoded", "application/octet-stream", or any valid MIME type.
[in]encodeA string that represents the encoding of data. This string could be "UTF-8", "UTF-16", "ISO8859-1", or any recognized [IANA]character encoding.
[in]headerA string that represents any additional HTTP headers to be included in the post.
Returns
The response string.

◆ putRequestURL:data:encode:()

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

A callback function used to put data to the given url.

Parameters
[in]urlA URL, to which the data will be put.
[in]dataThe data to be put.
[in]encodeA string that represents the encoding of data. This string could be "UTF-8", "UTF-16", ISO8859-1", or any recognized [IANA]character encoding.
Returns
YES means success, while NO means failure.

◆ response:title:default_answer:is_mask:()

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

A callback function used to response.

Parameters
[in]questionA string that represents the question.
[in]titleA string that represents the title.
[in]default_answerA string that represents the default answer. It could be an empty string which means no default answer.
[in]is_maskYES means the answer should be masked by '*', while NO means the answer does not need to be masked by '*'.
Returns
A string that represents the response answer.

◆ 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

A callback function used to show file dialog.

Parameters
[in]string_titleA string that represents the dialog title.
[in]string_filterA string that represents the dialog file filter.
[in]is_openfile_dialogYES means the dialog is an open-file-dialog, while NO means the dialog is a save-as-dialog.
Returns
An array of file paths.