Page History

Div

style	display:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Div

id	description

HTML Table

id
class	servoy sReturnTypes

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Return Types

Table Row (tr)

Table Cell (td)

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
call(telNumber) Initiate a phone call

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
clearLocalData() Clears local data - that is stored in browser local storage.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
email(emailAddress) Initiate an email sending

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
getCurrentPosition(successCallback, errorHandler, options) Wrapper function around HTML5 getCurrentPosition.

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getMarkupId(element) Retrieves markup id of an form element

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
getUUIDPKValueAsString(record) UUID pk's are mapped internally to integer to optimize space usage.

Table Row (tr)

Table Cell (td)
Number

Table Cell (td)
getUsedStorageSpace() Retrieves amount of used bytes from browser local storage.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
isOnline() Returns whether mobile device is online.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
loadData() (Re)Loads fresh data from the server, discarding the current local changes (asynchronously).

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
loadData(successCallback, errorHandler) (Re)Loads fresh data from the server, discarding the current local changes (asynchronously).

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
remoteSearch(foundset, successCallback, errorHandler) Performs a remote search for the given foundset, that foundset must be in findmode, else an exception will be thrown.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
syncData() Synchronizes data between Mobile Client and Servoy Application Server (asynchronously).

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
syncData(successCallback, errorHandler) Synchronizes data between Mobile Client and Servoy Application Server (asynchronously).

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

id	call-String

Table Row (tr)

id	name

Table Cell (td)
call

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

call

Span
(telNumber)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Initiate a phone call

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} telNumber - telephone number to call

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.mobile.call("+490111111")

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	clearLocalData

Table Row (tr)

id	name

Table Cell (td)
clearLocalData

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

clearLocalData

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Clears local data - that is stored in browser local storage.
After calling this method there will be no data in the mobile client until a syncData/loadData operation completes successfully.

Note: It is the caller's responsibility to show a form that doesn't need data or call a sync afterwards. (table structure data is cleared as well)
Use this with care!

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// if we want do clear local copy of the data because the user did something really bad with local data
plugins.mobile.clearLocalData();
plugins.mobile.syncData();

// maybe we are done with a task and we don't want to use persistent space on the device
plugins.mobile.clearLocalData();
forms.noDataInitialForm.showWithMessage("Local data discarded."); // a form that displays the message and shows itself on this call; it also allows doing a sync later for example

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	email-String

Table Row (tr)

id	name

Table Cell (td)
email

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

email

Span
(emailAddress)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Initiate an email sending

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} emailAddress - destination email address

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.mobile.email("[email protected]")

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getCurrentPosition-Function_Function_Object

Table Row (tr)

id	name

Table Cell (td)
getCurrentPosition

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

getCurrentPosition

Span
(successCallback, errorHandler, options)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Wrapper function around HTML5 getCurrentPosition. Method will call successCallback method with a Position object argument if GPS position was retrieved. Otherwise will call errorHandler with an error argument. This method has dummy implementation in developer.
NOTE: For options you can specify (a) Accuracy of the returned location information (b) Timeout for retrieving the location information and (c) Use of cached location information

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} successCallback - Method to be called if the coordinates are retrieved.
{Function} errorHandler - Method to be called if an error occurs while retrieving GPS coordinates. Can be null.
{Object} options - JSON string with different options that are supported by HTML5 function (accuracy, timeout, caching).

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.mobile.getCurrentPosition(forms.myform.showLocation,scopes.globals.errorHandler,{timeout:5000});

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getMarkupId-RuntimeComponent

Table Row (tr)

id	name

Table Cell (td)
getMarkupId

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getMarkupId

Span
(element)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Retrieves markup id of an form element

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{RuntimeComponent} element - to retrive markup id for

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - the element's markup id

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var id = plugins.mobile.getMarkupId(elements.myButton)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getUUIDPKValueAsString-JSRecord

Table Row (tr)

id	name

Table Cell (td)
getUUIDPKValueAsString

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getUUIDPKValueAsString

Span
(record)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

UUID pk's are mapped internally to integer to optimize space usage.
This function gets the real UUID pk value of the record value of pk.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSRecord} record - the record to get the uuid from

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var uuid = plugins.mobile.getUUIDPKValueAsString(record)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getUsedStorageSpace

Table Row (tr)

id	name

Table Cell (td)
getUsedStorageSpace

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getUsedStorageSpace

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Retrieves amount of used bytes from browser local storage.
The storage amount depends on used browser, but, from specification, the browser should allow at least 5MB of local storage.

Note: Some browsers take two bytes per character!

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var usedSpace = plugins.mobile.getUsedStorageSpace()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	isOnline

Table Row (tr)

id	name

Table Cell (td)
isOnline

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

isOnline

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns whether mobile device is online. Returns true in developer implementation.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.mobile.isOnline()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	loadData

Table Row (tr)

id	name

Table Cell (td)
loadData

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

loadData

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

(Re)Loads fresh data from the server, discarding the current local changes (asynchronously).
It is equivalent to the "load" part of a sync operation; it doesn't send local changes to the server and discards local changes when it receives new data from the server.

When done, this call might (and most of the time does) need to move to first form, as the (new) local data might be completely different - invalidating the current form/history.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// reload data from server and discard local changes
plugins.mobile.loadData();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	loadData-Function_Function

Table Row (tr)

id	name

Table Cell (td)
loadData

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

loadData

Span
(successCallback, errorHandler)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

(Re)Loads fresh data from the server, discarding the current local changes (asynchronously).
It is equivalent to the "load" part of a sync operation; it doesn't send local changes to the server and discards local changes when it receives new data from the server.

When done, this call might (and most of the time does) need to move to first form, as the (new) local data might be completely different - invalidating the current form/history.
As callback methods are set, the call back methods will be responsible for doing this themselves - for example using and controller.show() of the first form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} successCallback - Method to be called if the load was successful. Can be null.
First argument of the success callback is the size of received data in bytes.
{Function} errorHandler - Method to be called if an error occurs during load. Can be null.
First argument is the HTTP status code for the request or -1 if unknown.
Second argument is the error message.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

function reloadAndDiscardData(event)
{
	plugins.mobile.loadData(onLoadSuccess, onLoadError);
}

function onLoadSuccess(dataBytes)
{
	if (dataBytes > 0) forms.contacts.showContacts(accountmanager_to_companies.companies_to_contacts);
	else forms.noData.showWithMessage("Server has no data to send.");
}

function onLoadError(http_status_code, error_message)
{
	plugins.dialogs.showWarningDialog("Warning", 'Reload of data failed with http status code: ' + http_status_code + ', and error message: ' + error_message);
	forms.firstForm.showWithMessage("Data reload failed. Please press 'Synchronise' to try again.");
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	remoteSearch-JSFoundSet_Function_Function

Table Row (tr)

id	name

Table Cell (td)
remoteSearch

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

remoteSearch

Span
(foundset, successCallback, errorHandler)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Performs a remote search for the given foundset, that foundset must be in findmode, else an exception will be thrown.
This will make a call to the server that maps on the offline_data forms ws_create method. With the method param called "search".
In that method make a call to plugins.mobileservice.createRemoteSearchFoundSet(data) with the data that is given as the first argument.
This will make a foundset that is in find mode, where you can perform the seach on and return that through an OfflineDataDescription (like a sync)

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{JSFoundSet} foundset
{Function} successCallback
{Function} errorHandler

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

if (foundset.find())
{
    foundset.anumbervalue = ">10";
    plugins.mobile.remoteSearch(foundset,successCallback,errorCallback);
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	syncData

Table Row (tr)

id	name

Table Cell (td)
syncData

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

syncData

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Synchronizes data between Mobile Client and Servoy Application Server (asynchronously).
A synchronize will send all local changes to the server, clear the local storage and ask for all the data from the server.

When done, this call might (and most of the time does) need to move to first form, as the (new) local data might be completely different - invalidating the current form/history.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

plugins.mobile.syncData()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	syncData-Function_Function

Table Row (tr)

id	name

Table Cell (td)
syncData

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

syncData

Span
(successCallback, errorHandler)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Synchronizes data between Mobile Client and Servoy Application Server (asynchronously).
A synchronize will send all local changes to the server, clear the local storage and ask for all the data from the server.
It will be calling "successCallback" on successful synchronization, with first argument the size of the received data in bytes,
or "errorHandler" if an error occurs during synchronization, with first argument the HTTP status code for the request or -1 if unknown, and the second argument
the error message.

When done, this call might (and most of the time does) need to move to first form, as the (new) local data might be completely different - invalidating the current form/history.
As callback methods are set, the call back methods will be responsible for doing this themselves - for example using controller.show() of the first form.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{Function} successCallback - Method to be called if the sync was successful. Can be null.
{Function} errorHandler - Method to be called if an error occurs during synchronization. Can be null.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

function onSyncAction(event)
{
	plugins.mobile.syncData(onSyncSuccess, onSyncError);
}

function onSyncSuccess(dataBytes)
{
	if (dataBytes > 0) forms.contacts.showContacts(accountmanager_to_companies.companies_to_contacts);
}

function onSyncError(http_status_code, error_message)
{
	plugins.dialogs.showWarningDialog("Warning", 'Sync failed with http status code: ' + http_status_code + ', and error message: ' + error_message);
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 11

New Version Current

Key

call

clearLocalData

email

getCurrentPosition

getMarkupId

getUUIDPKValueAsString

getUsedStorageSpace

isOnline

loadData

loadData

remoteSearch

syncData

syncData