JSClient

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}

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

Unknown macro: {tr}

Unknown macro: {th}

Constants Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

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

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}

String

Unknown macro: {td}

getClientID()
Gets the id of the client.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Object

Unknown macro: {td}

getDataProviderValue(contextName, dataprovider)
Get a data-provider value.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Object

Unknown macro: {td}

getDataProviderValue(contextName, dataprovider, methodName)
Get a data-provider value.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Boolean

Unknown macro: {td}

isValid()
returns true if this client is still valid/usable.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

queueMethod(contextName, methodName, args, notifyCallBackMethod)
Queues a method call on the remote server.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Object

Unknown macro: {td}

setDataProviderValue(contextName, dataprovider, value)
Set a data-provider value.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Object

Unknown macro: {td}

setDataProviderValue(contextName, dataprovider, value, methodName)
Set a data-provider value.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

shutdown()
closes the client.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

shutdown(force)
closes the client.

Unknown macro: {table}

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

Unknown macro: {tr}

Unknown macro: {th}

Constants Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

CALLBACK_EVENT

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

CALLBACK_EXCEPTION_EVENT

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

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}

getClientID

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

String

Unknown macro: {span}

getClientID

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getDataProviderValue

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Object

Unknown macro: {span}

getDataProviderValue

Unknown macro: {span}

(contextName, dataprovider)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Get a data-provider value.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Object – the value for the data-provider.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getDataProviderValue

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Object

Unknown macro: {span}

getDataProviderValue

Unknown macro: {span}

(contextName, dataprovider, methodName)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Get a data-provider value.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Object – the value of the data-provider.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

isValid

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Boolean

Unknown macro: {span}

isValid

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

returns true if this client is still valid/usable.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

queueMethod

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

queueMethod

Unknown macro: {span}

(contextName, methodName, args, notifyCallBackMethod)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{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 – The callback method that is called when the execution is finished.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

setDataProviderValue

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Object

Unknown macro: {span}

setDataProviderValue

Unknown macro: {span}

(contextName, dataprovider, value)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Set a data-provider value.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Object – the old value or null if no change.

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

setDataProviderValue

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Object

Unknown macro: {span}

setDataProviderValue

Unknown macro: {span}

(contextName, dataprovider, value, methodName)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Set a data-provider value.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Object – the old value or null if no change

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

shutdown

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

shutdown

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

closes the client.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

shutdown

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

shutdown

Unknown macro: {span}

(force)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

closes the client.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{Boolean} force

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Child pages

JSClient

CALLBACK_EVENT

CALLBACK_EXCEPTION_EVENT

getClientID

getDataProviderValue

getDataProviderValue

isValid

queueMethod

setDataProviderValue

setDataProviderValue

shutdown

shutdown