IAppProviderCallback Class Reference

Public Member Functions
	Beep (type)
	A callback function used to beep for specified beep type. More...
	DownLoadUrl (url)
	A callback function used to download from specified URL. More...
	GetAppInfo (app_info)
	A callback function used to get application information for a specified information type. More...
	LoadString (string_id)
	A callback function used to load a string in local language for a specified case. More...
	MsgBox (message, title, icon_type, button_type)
	A callback function used to set message box. More...
	PostRequestURL (url, data, content_type, encode, header)
	A callback function used to post data to the given URL. More...
	PutRequestURL (url, data, encode,)
	A callback function used to put data to the given URL. More...
	Release ()
	A callback function used to release current callback object itself. More...
	Response (question, title, default_answer, is_mask)
	A callback function used to response. More...
	ShowFileDialog (string_title, 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.

Examples

/Users/ec2-user/gitlab-runner/builds/E-xKdhDoq/0/foxit/sdk/mobile/gsdk-doc-auto-build/harmony_nodejs/input/Index.js.

Member Function Documentation

Beep()

IAppProviderCallback.Beep

(

type

)

A callback function used to beep for specified beep type.

Parameters

[in]

type

The beep type. Please refer to values starting from AppProviderCallback.e_BeepTypeError and this would be one of these values.

Returns

None.

DownLoadUrl()

IAppProviderCallback.DownLoadUrl

(

url

)

A callback function used to download from specified URL.

Parameters

[in]

url

A URL to be downloaded.

Returns

A FileReaderCallback object which can be used to read the downloading result.

GetAppInfo()

IAppProviderCallback.GetAppInfo

(

app_info

)

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

Parameters

[in]

app_info

The type of application information, whose information is to retrieved. Please refer to values starting from AppProviderCallback.e_AppInfoType and this would be one of these values.

Returns

A string of application information.

LoadString()

IAppProviderCallback.LoadString

(

string_id

)

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 AppProviderCallback.e_StringIDValidateFailed) 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_id

A string ID to specify a case. Please refer to values starting from AppProviderCallback.e_StringIDValidateFailed and this would be one of these values.

Returns

A string used for the specified case.

MsgBox()

IAppProviderCallback.MsgBox	(	message	,
		title	,
		icon_type	,
		button_type
	)

A callback function used to set message box.

Parameters

[in]	message	A message string.
[in]	title	The title of message box.
[in]	icon_type	The icon type for message box. Please refer to values starting from AppProviderCallback.e_MsgBoxIconError and this would be one of these values.
[in]	button_type	The button type for message box. Please refer to values starting from AppProviderCallback.e_MsgBtnTypeOK and this would be one of these values.

Returns

The button ID for message box. Please refer to values starting from AppProviderCallback.e_MsgBtnIDOK and this should be one of these values.

PostRequestURL()

IAppProviderCallback.PostRequestURL	(	url	,
		data	,
		content_type	,
		encode	,
		header
	)

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

Parameters

[in]	url	A URL, to which the data will be posted.
[in]	data	The data to be posted.
[in]	content_type	A 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]	encode	A string that represents the encoding of data. This string could be "UTF-8", "UTF-16", "ISO8859-1", or any recognized [IANA]character encoding.
[in]	header	A string that represents any additional HTTP headers to be included in the post.

Returns

The response string.

PutRequestURL()

IAppProviderCallback.PutRequestURL	(	url	,
		data	,
		encode
	)

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

Parameters

[in]	url	A URL, to which the data will be put.
[in]	data	The data to be put.
[in]	encode	A string that represents the encoding of data. This string could be "UTF-8", "UTF-16", ISO8859-1", or any recognized [IANA]character encoding.

Returns

true means success, while false means failure.

Release()

IAppProviderCallback.Release

(

)

A callback function used to release current callback object itself.

Returns

None.

Response()

IAppProviderCallback.Response	(	question	,
		title	,
		default_answer	,
		is_mask
	)

A callback function used to response.

Parameters

[in]	question	A string that represents the question.
[in]	title	A string that represents the title.
[in]	default_answer	A string that represents the default answer. It could be an empty string which means no default answer.
[in]	is_mask	true means the answer should be masked by '*', while false means the answer does not need to be masked by '*'.

Returns

A string that represents the response answer.

ShowFileDialog()

IAppProviderCallback.ShowFileDialog	(	string_title	,
		string_filter	,
		is_openfile_dialog
	)

A callback function used to show file dialog.

Parameters

[in]	string_title	A string that represents the dialog title.
[in]	string_filter	A string that represents the dialog file filter.
[in]	is_openfile_dialog	true means the dialog is an open-file-dialog, while false means the dialog is a save-as-dialog.

Returns

An array of file paths.