Child pages
  • mobile
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Unknown macro: {div}

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'

Unknown macro: {div}


Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Return Types

Unknown macro: {tr}
Unknown macro: {td}


Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}
Unknown macro: {th}

Property Summary


Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Summary

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

call(telNumber)
Initiate a phone call

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

email(emailAddress)
Initiate an email sending

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

getMarkupId(element)
Retrieves markup id of an element

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Boolean

Unknown macro: {td}

isOnline()
Returns whether mobile device is online.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

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

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

syncData()
Synchronises data between Mobile Client and Servoy Application Server (asynchronously).

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

syncData(successCallback, errorHandler)
Synchronises data between Mobile Client and Servoy Application Server (asynchronously), calling
"successCallback" on successful synchronisation, with first argument the size of the received data in bytes,
or "errorHandler" if an error occurs during synchronisation, with first argument the HTTP status code for the request or -1 if unknown, and the second argument
the error message.


Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}
Unknown macro: {th}

Property Details


Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
call
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

call

Unknown macro: {span}

(telNumber)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Initiate a phone call

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} telNumber – telephone number to call

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
plugins.mobile.call("+490111111")
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
clearLocalData
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

clearLocalData

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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/reloadDataFromServer 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!

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
email
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

email

Unknown macro: {span}

(emailAddress)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Initiate an email sending

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} emailAddress – destination email address

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
plugins.mobile.email("[email protected]")
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getCurrentPosition
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

getCurrentPosition

Unknown macro: {span}

(successCallback, errorHandler, options)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{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).

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
plugins.mobile.getCurrentPosition(forms.myform.showLocation,scopes.globals.errorHandler,{timeout:5000});
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getMarkupId
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

getMarkupId

Unknown macro: {span}

(element)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Retrieves markup id of an element

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{RuntimeComponent} element – to retrive markup id for

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – the element's markup id

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var id = plugins.mobile.getMarkupId(elements.myButton)
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getUsedStorageSpace
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

getUsedStorageSpace

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var usedSpace = plugins.mobile.getUsedStorageSpace()
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
isOnline
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Boolean

Unknown macro: {span}

isOnline

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
plugins.mobile.isOnline()
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
loadData
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

loadData

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

(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.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// reload data from server and discard local changes
plugins.mobile.loadData();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
loadData
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

loadData

Unknown macro: {span}

(successCallback, errorHandler)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

(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.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{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.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
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.");
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
syncData
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

syncData

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Synchronises data between Mobile Client and Servoy Application Server (asynchronously).

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.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
plugins.mobile.syncData()
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
syncData
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

syncData

Unknown macro: {span}

(successCallback, errorHandler)

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {div}

Synchronises data between Mobile Client and Servoy Application Server (asynchronously), calling
"successCallback" on successful synchronisation, with first argument the size of the received data in bytes,
or "errorHandler" if an error occurs during synchronisation, 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.

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{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 synchronisation. Can be null.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
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);
}
Unknown macro: {tr}
Unknown macro: {td}
  • No labels