Page History

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'

Divcache

styleindex	display:none

...

id	description

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Constants Summary

...

Table Cell (td)
String

...

Table Cell (td)
String

...

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.

...

padding	0px
width	80px

...

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

...

Table Cell (td)
String

...

servoy sSummary

12%

30%

58%

height: 30px;

...

Table Head (th)

colspan	2

Method Summary

3

Methods Summary

Gets the id of the client.

...

Table Cell (td)
Object

...

Get a data-provider value.

...

Table Cell (td)
Object

...

Table Cell (td)
Boolean

...

Get a data-provider value.

...

returns true if this client is still valid/usable.

...

Table Cell (td)
void

...

Table Cell (td)
Object

...

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

...

Set a data-provider value.

...

void

...

closes the client.

...

void

...

closes the client.

...

constant

...

servoy sDetail

...

padding	0px
width	100%

...

2100%

height:30px

...

colspan	1

...

2

Constants Details

...

CALLBACK_EVENT

...

name

...

CALLBACK_EVENT

...

des

...

sIndent

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

...

ret

...

Returns

...

sIndent

clients

...

Supported Clients

sIndent

...

id	sam

...

class	lastDetailRow

...

SmartClient,WebClient,NGClient

sam

Sample

...

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);
}

sIdent

javascript

lastDetailRow

CALLBACK_EXCEPTION_EVENT

...

name

...

CALLBACK_EXCEPTION_EVENT

...

des

...

sIndent

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

...

ret

...

Returns

...

sIndent

clients

...

Supported Clients

sIndent

...

SmartClient,WebClient,NGClient

sam

...

Sample

...

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);
}

...

class	lastDetailRow

...

id	function
class	servoy sDetail

...

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

...

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);
}

...

class	lastDetailRow

...

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.

...

id	prs

...

class	sIndent

...

sIdent

javascript

lastDetailRow

functionservoy sDetail2100%height:30px2Methods DetailsgetClientIDname

getClientID()

des

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.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getDataProviderValue

name

getDataProviderValue(contextName, dataprovider)

des

sIndent

Get a data-provider value.

prs

Parameters

sIndent

contextName

The context of the given method, null if it is global method or a form name for a form method

...

dataprovider

...

the data-provider name as seen in Servoy

...

ret

...

Returns

...

sIndent

...

the value for the data-provider.

clients

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

...

class	lastDetailRow

...

id	getDataProviderValue-String_String_String

Table Row (tr)

id	name

Table Cell (td)
getDataProviderValue

...

id	sig

...

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

getDataProviderValue

...

Sample

...

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);
	}
}

...

sIdent

javascript

lastDetailRow

getDataProviderValue

name

getDataProviderValue(contextName, dataprovider, methodName)

...

des

...

sIndent

Get a data-provider value.

...

prs

...

Parameters

...

sIndent

...

contextName

...

The context of the given method; null if it is global method or a form name for a form method.

...

dataprovider

...

the data-provider name as seen in Servoy.

...

methodName

...

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

...

ret

...

Returns

...

sIndent

...

class	lastDetailRow

...

id	queueMethod-String_String_ObjectArray_Function

Table Row (tr)

id	name

Table Cell (td)
queueMethod

...

id	sig

...

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

queueMethod

...

the value of the data-provider.

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);
	}
}

...

class	lastDetailRow

...

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);
}

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

isValid

name

isValid()

des

sIndent

returns true if this client is still valid/usable.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

queueMethod

name

queueMethod(contextName, methodName, args)

des

sIndent

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

prs

Parameters

sIndent

contextName

The context of the given method, null if it is global method or a form name for a form method.

methodName

The method name.

args

The arguments that should be passed to the method.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

queueMethod

name

queueMethod(contextName, methodName, args, notifyCallBackMethod)

...

des

...

sIndent

Queues 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

...


The second argument that is give back is the JSClient instance that did the call.

...

prs

...

Parameters

...

sIndent

...

contextName

...

The context of the given method, null if it is global method or a form name for a form method.

...

methodName

...

The method name.

...

args

...

The arguments that should be passed to the method.

...

notifyCallBackMethod

...

class	lastDetailRow

...

id	setDataProviderValue-String_String_Object

Table Row (tr)

id	name

Table Cell (td)
setDataProviderValue

...

id	sig

...

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

setDataProviderValue

...

The callback method that is called when the execution is finished.

clients

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);
}

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

setDataProviderValue

name

setDataProviderValue(contextName, dataprovider, value)

...

des

...

sIndent

Set a data-provider value.

...

prs

...

Parameters

...

sIndent

...

contextName

...

The context of the given method, null if it is global method or a form name for a form method.

...

dataprovider

...

the data-provider name as seen in Servoy.

...

value

...

the value to set.

...

ret

...

Returns

...

sIndent

...

the old value or null if no change.

clients

...

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

...

class	lastDetailRow

...

id	setDataProviderValue-String_String_Object_String

Table Row (tr)

id	name

Table Cell (td)
setDataProviderValue

...

id	sig

...

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

setDataProviderValue

...

Sample

...

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);
	}
}

sIdent

javascript

lastDetailRow

setDataProviderValue

name

setDataProviderValue(contextName, dataprovider, value, methodName)

...

des

...

sIndent

Set a data-provider value.

...

prs

...

Parameters

...

sIndent

...

contextName

...

The context of the given method, null if it is global method or a form name for a form method

...

dataprovider

...

the data-provider name as seen in Servoy

...

value

...

the value to set

...

methodName

...

if 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

...

Returns

...

sIndent

...

class	lastDetailRow

...

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);
}

...

class	lastDetailRow

...

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);
}

...

class	lastDetailRow

...

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);
	}
}

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

shutdown

name

shutdown()

des

sIndent

closes the client.

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

shutdown

name

shutdown(force)

des

sIndent

closes the client.

prs

Parameters

sIndent

force

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Versions Compared

Old Version 18

New Version Current

Key

CALLBACK_EVENT

CALLBACK_EXCEPTION_EVENT

des

getClientID

getDataProviderValue

getClientID()

getDataProviderValue(contextName, dataprovider)

getDataProviderValue

getDataProviderValue(contextName, dataprovider, methodName)

queueMethod

isValid

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)