Page History

Divcache

Div

id	description

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

Constants Summary

Table Row (tr)

Table Cell (td)
String

Table Cell (td)CALLBACK_EVENT

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

true
refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Constants SummaryConstant that is returned as a JSEvent type when in the callback method when it executed normally. Table Row (tr)

Table Cell (td)
String

Table Cell (td)CALLBACK_EXCEPTION_EVENT

Constant that is returned as a JSEvent type when in the callback method when an exception occurred.

table

idclassservoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead) Table Row (tr)style Table Row (tr)

Table Cell (td)
String

Table Cell (td)getClientID()

servoy sSummary

12%

30%

58%

height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Cell (td)getDataProviderValue(contextName, dataprovider)

3

Methods Summary

Gets the id of the client.

Table Row (tr)

Table Cell (td)
Object

Get a data-provider value.

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)getDataProviderValue(contextName, dataprovider, methodName)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)isValid()

Get a data-provider value.

returns true if this client is still valid/usable.

Table Row (tr)

Table Cell (td)
void

Table Cell (td)queueMethod(contextName, methodName, args, notifyCallBackMethod)
Table Row (tr)

Table Cell (td)
Object

Table Cell (td)setDataProviderValue(contextName, dataprovider, value)

void

Queues a method call on the remote server, without a callback method.

void

Queues a method call on the remote server.

Set a data-provider value.

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)setDataProviderValue(contextName, dataprovider, value, methodName)

Table Row (tr) Table Cell (td)

Set a data-provider value.

Table Cell (td)shutdown()

void

closes the client.

Table Row (tr) Table Cell (td) Table Cell (td)shutdown(force)

void

closes the client.

table

id

constantclass Colgroup Tag Colcolspanservoy sDetail2width100%

Col

Table Head (thead) Table Row (tr)style

height:30px

; Table Head (th)colspan

2

id

Constants Details

Table Body (tbody)id

CALLBACK_EVENT

Table Row (tr)

name

Table Cell (td)id

CALLBACK_EVENT

Table Row (tr)

des

Table Cell (td) Divclassid

sIndent

Constant that is returned as a JSEvent type when in the callback method when it executed normally.

Table Row (tr)td

ret

Returns

div

sIndent

clients

classtd

Supported Clients

sIndent

String Table Row (tr)

id	sam

Table Body (tbody)id

SmartClient,WebClient,NGClient

sam

Sample

Div

class	sIndent

Code Block

language	javascript

if (jsclient && jsclient.isValid())
{
	/*Queue a method where the callback can do something like this
	if (event.getType() == JSClient.CALLBACK_EVENT)
	{
		application.output("callback data, name: " + event.data);
	}
	else if (event.getType() == JSClient.CALLBACK_EXCEPTION_EVENT)
	{
		application.output("exception callback, name: " + event.data);
	}*/
	var x = new Object();
	x.name = 'remote1';
	x.number = 10;
	// this calls a 'remoteMethod' on the server as a global method, because the context (first argument is set to null), you can use a formname to call a form method
	jsclient.queueMethod(null, "remoteMethod", [x], callback);
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

sIdent

javascript

lastDetailRow

CALLBACK_EXCEPTION_EVENT

Table Row (tr)id

name

Table Cell (td)id

CALLBACK_EXCEPTION_EVENT

Table Row (tr)class

des

Table Cell (td) Div

sIndent

Constant that is returned as a JSEvent type when in the callback method when an exception occurred.

tr

idtdretReturnsdivsIndentclientsclassid
Supported Clients
sIndentString Table Row (tr)SmartClient,WebClient,NGClientsam Table Cell (td)
Sample Div
class sIndent
 Code Block
language javascript
if (jsclient && jsclient.isValid())
{
	/*Queue a method where the callback can do something like this
	if (event.getType() == JSClient.CALLBACK_EVENT)
	{
		application.output("callback data, name: " + event.data);
	}
	else if (event.getType() == JSClient.CALLBACK_EXCEPTION_EVENT)
	{
		application.output("exception callback, name: " + event.data);
	}*/
	var x = new Object();
	x.name = 'remote1';
	x.number = 10;
	// this calls a 'remoteMethod' on the server as a global method, because the context (first argument is set to null), you can use a formname to call a form method
	jsclient.queueMethod(null, "remoteMethod", [x], callback);
}
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 HTML Tableid 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 getClientID
 Table Row (tr)
id name
 Table Cell (td)
getClientID
 Table Row (tr)
id sig
 Table Cell (td)
 Span
style margin-right: 5px;
String
 Span
style font-weight: bold;
getClientID
 Span
()
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
Gets the id of the client.
This client id can be used to find the client from the headless client plugin.
Note that this client id is not the same id as the id displayed on the Aplicationb Server admin page.
 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 headlessClient = plugins.headlessclient.createClient("someSolution", "user", "pass", null);
var clientID = headlessClient.getClientID()
....
headlessClient = plugins.headlessclient.getClient(clientID);
if (headlessClient != null && headlessClient.isValid()) {
	 headlessClient.queueMethod(null, "someRemoteMethod", null, callback);
}
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)id getDataProviderValue-String_String
 Table Row (tr)
id name
 Table Cell (td)
getDataProviderValue
 Table Row (tr)
id sig
 Table Cell (td)
 Span
style margin-right: 5px;
Object
 Span
style font-weight: bold;
getDataProviderValue
 Span
(contextName, dataprovider)
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
Get a data-provider value.
 Table Row (tr)id prs
 Table Cell (td)Parameters
 Divclass sIndent
{String} contextName - sIdentjavascriptlastDetailRow
functionservoy sDetail2100%height:30px2Methods DetailsgetClientIDname
getClientID()
dessIndentGets the id of the client.

This client id can be used to find the client from the headless client plugin.
Note that this client id is not the same id as the id displayed on the Aplicationb Server admin page.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowgetDataProviderValuenamegetDataProviderValue(contextName, dataprovider)dessIndentGet a data-provider value.prsParameters
sIndentcontextNameThe context of the given method, null if it is global method or a form name for a form method
{String} dataprovider -  Table Row (tr)idthe data-provider name as seen in Servoyret Table Cell (td)class
Returns DivObject - sIndentid the value for the data-provider.clients Table Row (tr)
Supported Clients
sIndentSmartClient,WebClient,NGClientsam Table Cell (td)
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)id getDataProviderValue-String_String_String
 Table Row (tr)
id name
 Table Cell (td)
getDataProviderValue
 Table Row (tr)id sig
 Table Cell (td) Span
style margin-right: 5px;
Object
 Span
style font-weight: bold;
getDataProviderValue
 SpanSample Div
class sIndent
 Code Block
language javascript
if (jsclient && jsclient.isValid())
{
	// only gets the globals.media when the 'remoteMethod' is currently executing for this client
	var value = jsclient.getDataProviderValue(null, "scopes.globals.number", 'remoteMethod');
	if (value != null)
	{
		application.output("value get from scopes.globals.number :: "+ value);
		scopes.globals.value = value+10;
		var returnValue = jsclient.setDataProviderValue(null, "scopes.globals.number", scopes.globals.value, 'remoteMethod');
		application.output("value set to scopes.globals.number previous value "+ returnValue);
	}
	else
	{
		application.output("value get from scopes.globals.number :: " + null);
	}
}
sIdentjavascriptlastDetailRowgetDataProviderValuenamegetDataProviderValue(contextName, dataprovider, methodName)tridclassdes Table Cell (td) DivsIndentGet a data-provider value.tridprs Table Cell (td)class
Parameters DivsIndent{String} contextName - The context of the given method; null if it is global method or a form name for a form method.
{String} dataprovider - the data-provider name as seen in Servoy.
{String} methodName -  Table Row (tr)idif this is specified, the data-provider's value will only be returned if the specified method is running in this headless client because the currently running client requested it to. Otherwise undefined is returned.tdretclassReturns DivObject - sIndentid the value of the data-provider.clients Table Row (tr)
Supported Clients
sIndentSmartClient,WebClient,NGClientsam Table Cell (td)
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)
id isValid
 Table Row (tr)
id name
 Table Cell (td)
isValid
 Table Row (tr)
id sig
 Table Cell (td)
 Span
style margin-right: 5px;
Boolean
 Span
style font-weight: bold;
isValid
 Span
()
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
returns true if this client is still valid/usable.
 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
if (jsclient && jsclient.isValid())
{
	/*Queue a method where the callback can do something like this
	if (event.getType() == JSClient.CALLBACK_EVENT)
	{
		application.output("callback data, name: " + event.data);
	}
	else if (event.getType() == JSClient.CALLBACK_EXCEPTION_EVENT)
	{
		application.output("exception callback, name: " + event.data);
	}*/
	var x = new Object();
	x.name = 'remote1';
	x.number = 10;
	// this calls a 'remoteMethod' on the server as a global method, because the context (first argument is set to null), you can use a formname to call a form method
	jsclient.queueMethod(null, "remoteMethod", [x], callback);
}
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)id queueMethod-String_String_ObjectArray_Function
 Table Row (tr)
id name
 Table Cell (td)
queueMethod
 Table Row (tr)id sig
 Table Cell (td) Span
style margin-right: 5px;
void
 Span
style font-weight: bold;
queueMethod
 SpanSample Div
class sIndent
 Code Block
language javascript
if (jsclient && jsclient.isValid())
{
	// only gets the globals.media when the 'remoteMethod' is currently executing for this client
	var value = jsclient.getDataProviderValue(null, "scopes.globals.number", 'remoteMethod');
	if (value != null)
	{
		application.output("value get from scopes.globals.number :: "+ value);
		scopes.globals.value = value+10;
		var returnValue = jsclient.setDataProviderValue(null, "scopes.globals.number", scopes.globals.value, 'remoteMethod');
		application.output("value set to scopes.globals.number previous value "+ returnValue);
	}
	else
	{
		application.output("value get from scopes.globals.number :: " + null);
	}
}
idsIdentjavascriptlastDetailRowisValidnameisValid()dessIndentreturns true if this client is still valid/usable.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowqueueMethodnamequeueMethod(contextName, methodName, args)dessIndentQueues a method call on the remote server, without a callback method.
Please note that calling queueMethod without a callback does not return anything: no result of the remote method or no exception if something went wrong.prsParameters
sIndentcontextNameThe context of the given method, null if it is global method or a form name for a form method.methodNameThe method name.argsThe arguments that should be passed to the method.clientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowqueueMethodnamequeueMethod(contextName, methodName, args, notifyCallBackMethod) Table Row (tr) Divclassdes Table Cell (td)sIndentQueues a method call on the remote server. The callback method will be called when the method is executed on the server

and the return value is given as the JSEvent.data object with the JSEvent.getType() value of JSClient.CALLBACK_EVENT.

If an exception is thrown somewhere then the callback method will be called with

the exception as the JSEvent data object with the JSEvent.getType() value of JSClient.CALLBACK_EXCEPTION_EVENT
id
The second argument that is give back is the JSClient instance that did the call. Table Row (tr)tdprsclassParameters DivsIndent{String} contextName - The context of the given method, null if it is global method or a form name for a form method.
{String} methodName - The method name.
{Object[]} args - The arguments that should be passed to the method.
{Function} notifyCallBackMethod -  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 (jsclient && jsclient.isValid())
{
	/*Queue a method where the callback can do something like this
	if (event.getType() == JSClient.CALLBACK_EVENT)
	{
		application.output("callback data, name: " + event.data);
	}
	else if (event.getType() == JSClient.CALLBACK_EXCEPTION_EVENT)
	{
		application.output("exception callback, name: " + event.data);
	}*/
	var x = new Object();
	x.name = 'remote1';
	x.number = 10;
	// this calls a 'remoteMethod' on the server as a global method, because the context (first argument is set to null), you can use a formname to call a form method
	jsclient.queueMethod(null, "remoteMethod", [x], callback);
}
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)id setDataProviderValue-String_String_Object
 Table Row (tr)
id name
 Table Cell (td)
setDataProviderValue
 Table Row (tr)id sig
 Table Cell (td) Span
style margin-right: 5px;
Object
 Span
style font-weight: bold;
setDataProviderValue
 SpanThe callback method that is called when the execution is finished.idclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowsetDataProviderValuenamesetDataProviderValue(contextName, dataprovider, value) Table Row (tr) Divclassdes Table Cell (td)idsIndentSet a data-provider value. Table Row (tr)tdprsParametersdivclasssIndent{String} contextName - The context of the given method, null if it is global method or a form name for a form method.
{String} dataprovider - the data-provider name as seen in Servoy.
{Object} value -  Table Row (tr)idthe value to set.ret
 Table Cell (td)
Returns DivclasssIndentObject -  the old value or null if no change.clients
 Table Row (tr)
id sam
 Table Cell (td)
Sample
 Div
class sIndent
 Code Block
language javascript
if (jsclient && jsclient.isValid())
{
	// only gets the globals.media when the 'remoteMethod' is currently executing for this client
	var value = jsclient.getDataProviderValue(null, "scopes.globals.number", 'remoteMethod');
	if (value != null)
	{
		application.output("value get from scopes.globals.number :: "+ value);
		scopes.globals.value = value+10;
		var returnValue = jsclient.setDataProviderValue(null, "scopes.globals.number", scopes.globals.value, 'remoteMethod');
		application.output("value set to scopes.globals.number previous value "+ returnValue);
	}
	else
	{
		application.output("value get from scopes.globals.number :: " + null);
	}
}
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)id setDataProviderValue-String_String_Object_String
 Table Row (tr)
id name
 Table Cell (td)
setDataProviderValue
 Table Row (tr)id sig
 Table Cell (td) Span
style margin-right: 5px;
Object
 Span
style font-weight: bold;
setDataProviderValue
 SpanSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowsetDataProviderValuenamesetDataProviderValue(contextName, dataprovider, value, methodName) Table Row (tr)id Divclassdes Table Cell (td)idsIndentSet a data-provider value. Table Row (tr)prs Table Cell (td)
ParametersdivclasssIndent{String} contextName - The context of the given method, null if it is global method or a form name for a form method
{String} dataprovider - the data-provider name as seen in Servoy
{Object} value - the value to set
{String} methodName -  Table Row (tr)idif this is specified, the data-provider's value will only be set if the specified method is running in this headless client because the currently running client requested it to. Otherwise the value is not set into the data-provider and undefined is returned.ret
 Table Cell (td)class
Returns DivsIndentObject - id the old value or null if no changeclients Table Row (tr)
Supported Clients
sIndentSmartClient,WebClient,NGClientsam Table Cell (td)
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)
id shutdown
 Table Row (tr)
id name
 Table Cell (td)
shutdown
 Table Row (tr)
id sig
 Table Cell (td)
 Span
style margin-right: 5px;
void
 Span
style font-weight: bold;
shutdown
 Span
()
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
closes the client.
 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 (jsclient && jsclient.isValid())
{
	/*Queue a method where the callback can do something like this
	if (event.getType() == JSClient.CALLBACK_EVENT)
	{
		application.output("callback data, name: " + event.data);
	}
	else if (event.getType() == JSClient.CALLBACK_EXCEPTION_EVENT)
	{
		application.output("exception callback, name: " + event.data);
	}*/
	var x = new Object();
	x.name = 'remote1';
	x.number = 10;
	// this calls a 'remoteMethod' on the server as a global method, because the context (first argument is set to null), you can use a formname to call a form method
	jsclient.queueMethod(null, "remoteMethod", [x], callback);
}
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)id shutdown-Boolean
 Table Row (tr)
id name
 Table Cell (td)
shutdown
 Table Row (tr)
id sig
 Table Cell (td)
 Span
style margin-right: 5px;
void
 Span
style font-weight: bold;
shutdown
 Span
(force)
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
closes the client.
 Table Row (tr)
id prs
 Table Cell (td)
Parameters
 Div
class sIndent
{Boolean} force
 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 (jsclient && jsclient.isValid())
{
	/*Queue a method where the callback can do something like this
	if (event.getType() == JSClient.CALLBACK_EVENT)
	{
		application.output("callback data, name: " + event.data);
	}
	else if (event.getType() == JSClient.CALLBACK_EXCEPTION_EVENT)
	{
		application.output("exception callback, name: " + event.data);
	}*/
	var x = new Object();
	x.name = 'remote1';
	x.number = 10;
	// this calls a 'remoteMethod' on the server as a global method, because the context (first argument is set to null), you can use a formname to call a form method
	jsclient.queueMethod(null, "remoteMethod", [x], callback);
}
 Table Row (tr)class lastDetailRow
 Table Cell (td) Sample Div
class sIndent
 Code Block
language javascript
if (jsclient && jsclient.isValid())
{
	// only gets the globals.media when the 'remoteMethod' is currently executing for this client
	var value = jsclient.getDataProviderValue(null, "scopes.globals.number", 'remoteMethod');
	if (value != null)
	{
		application.output("value get from scopes.globals.number :: "+ value);
		scopes.globals.value = value+10;
		var returnValue = jsclient.setDataProviderValue(null, "scopes.globals.number", scopes.globals.value, 'remoteMethod');
		application.output("value set to scopes.globals.number previous value "+ returnValue);
	}
	else
	{
		application.output("value get from scopes.globals.number :: " + null);
	}
}
sIdentjavascriptlastDetailRowshutdownnameshutdown()dessIndentcloses the client.clientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowshutdownnameshutdown(force)dessIndentcloses the client.prsParameters
sIndentforce ;clientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRow

Child pages

Versions Compared

Old Version 21

New Version Current

Key

CALLBACK_EVENT

CALLBACK_EXCEPTION_EVENT

getClientID

getDataProviderValue

getClientID()

getDataProviderValue(contextName, dataprovider)

getDataProviderValue

getDataProviderValue(contextName, dataprovider, methodName)

isValid

queueMethod

isValid()

queueMethod(contextName, methodName, args)

queueMethod(contextName, methodName, args, notifyCallBackMethod)

setDataProviderValue

setDataProviderValue(contextName, dataprovider, value)

setDataProviderValue

setDataProviderValue(contextName, dataprovider, value, methodName)

shutdown

shutdown

shutdown()

shutdown(force)