Page History

Hidden

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE

HTML Table

class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#CALLBACK_EVENT

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#CALLBACK_EXCEPTION_EVENT

HTML Table

class	servoy sSummary

Colgroup Tag

Column

padding	0px
width	80px

Column

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

Table Body (tbody)

Table Row (tr)

Table Cell (td)
String

Table Cell (td)
#getClientID() gets the id of the client

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
#getDataProviderValue(context, variableName, [currentMethodName]) get a dataprovider value from the client

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
#isValid() returns true if this client is still valid/usable

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#queueMethod(context, methodName, args, callbackFunction) queue a method on the client, calling the method name specified on the context, the callback method will get a JSEvent as the first and a JSClient (the this of the client that did the call) as the second parameter

Table Body (tbody)

Table Row (tr)

Table Cell (td)
Object

Table Cell (td)
#setDataProviderValue(context, variableName, value, [currentMethodName]) set a dataprovider value on the client

Table Body (tbody)

Table Row (tr)

Table Cell (td)
void

Table Cell (td)
#shutdown(force) shutdown

HTML Table

id	constant
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Constants Details

Table Body (tbody)

id	CALLBACK_EVENT
class	node

Table Row (tr)

id	name

Table Cell (td)
CALLBACK_EVENT

Table Row (tr)

id	des

Table Cell (td)
Replace with description

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	CALLBACK_EXCEPTION_EVENT
class	node

Table Row (tr)

id	name

Table Cell (td)
CALLBACK_EXCEPTION_EVENT

Table Row (tr)

id	des

Table Cell (td)
Replace with description

Table Row (tr)

id	ret

Table Cell (td)
Returns String

Table Row (tr)

class	lastDetailRow

Table Cell (td)

HTML Table

id	function
class	servoy sDetail

Colgroup Tag

Column

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

Table Body (tbody)

id	getClientID
class	node

Table Row (tr)

id	name

Table Cell (td)
getClientID

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

String

Span

style	float: left; font-weight: bold;
id	iets

getClientID

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
gets the id of the client

Table Row (tr)

id	ret

Table Cell (td)
Returns String

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	getDataProviderValue
class	node

Table Row (tr)

id	name

Table Cell (td)
getDataProviderValue

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Object

Span

style	float: left; font-weight: bold;
id	iets

getDataProviderValue

Span

style	float: left;
id	iets

(context, variableName, [currentMethodName])

Table Row (tr)

id	des

Table Cell (td)
get a dataprovider value from the client

Table Row (tr)

id	prs

Table Cell (td)
Parameters context variableName [currentMethodName]

Table Row (tr)

id	ret

Table Cell (td)
Returns Object

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, "globals.number", 'remoteMethod');
	if (value != null)
	{
		application.output("value get from globals.number :: "+ value);
		globals.value = value+10;
		var returnValue = jsclient.setDataProviderValue(null, "globals.number", globals.value, 'remoteMethod');
		application.output("value set to globals.number previous value "+ returnValue);
	}
	else
	{
		application.output("value get from globals.number :: " + null);
	}
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	isValid
class	node

Table Row (tr)

id	name

Table Cell (td)
isValid

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Boolean

Span

style	float: left; font-weight: bold;
id	iets

isValid

Span

style	float: left;
id	iets

()

Table Row (tr)

id	des

Table Cell (td)
returns true if this client is still valid/usable

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
queueMethod

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

queueMethod

Span

style	float: left;
id	iets

(context, methodName, args, callbackFunction)

Table Row (tr)

id	des

Table Cell (td)
queue a method on the client, calling the method name specified on the context, the callback method will get a JSEvent as the first and a JSClient (the this of the client that did the call) as the second parameter

Table Row (tr)

id	prs

Table Cell (td)
Parameters context methodName args callbackFunction

Table Row (tr)

id	ret

Table Cell (td)
Returns 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
class	node

Table Row (tr)

id	name

Table Cell (td)
setDataProviderValue

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

Object

Span

style	float: left; font-weight: bold;
id	iets

setDataProviderValue

Span

style	float: left;
id	iets

(context, variableName, value, [currentMethodName])

Table Row (tr)

id	des

Table Cell (td)
set a dataprovider value on the client

Table Row (tr)

id	prs

Table Cell (td)
Parameters context variableName value [currentMethodName]

Table Row (tr)

id	ret

Table Cell (td)
Returns Object

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, "globals.number", 'remoteMethod');
	if (value != null)
	{
		application.output("value get from globals.number :: "+ value);
		globals.value = value+10;
		var returnValue = jsclient.setDataProviderValue(null, "globals.number", globals.value, 'remoteMethod');
		application.output("value set to globals.number previous value "+ returnValue);
	}
	else
	{
		application.output("value get from globals.number :: " + null);
	}
}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	shutdown
class	node

Table Row (tr)

id	name

Table Cell (td)
shutdown

Table Row (tr)

id	sig

Table Cell (td)

Span

style	float: left; margin-right: 5px;

void

Span

style	float: left; font-weight: bold;
id	iets

shutdown

Span

style	float: left;
id	iets

(force)

Table Row (tr)

id	des

Table Cell (td)
shutdown

Table Row (tr)

id	prs

Table Cell (td)
Parameters force

Table Row (tr)

id	ret

Table Cell (td)
Returns 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)

Child pages

Versions Compared

Old Version 16

New Version Current

Key

CALLBACK_EVENT

CALLBACK_EXCEPTION_EVENT

getClientID

getDataProviderValue

isValid

queueMethod

setDataProviderValue

shutdown