JSClient

Unknown macro: {sub-section}

Unknown macro: {table}

{column:width=80px}{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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

CALLBACK_EXCEPTION_EVENT

Unknown macro: {table}

{column:width=80px}{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(context, variableName, currentMethodName)
get a dataprovider value from the client

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(context, methodName, args, callbackFunction)
queue a method on the client

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Object

Unknown macro: {td}

setDataProviderValue(context, variableName, value, currentMethodName)
set a dataprovider value on the client

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

shutdown(force)
shutdown

Unknown macro: {table}

{column:width=100%}{column}

Unknown macro: {tr}

Unknown macro: {th}

Constants Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

CALLBACK_EVENT

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

String

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

CALLBACK_EXCEPTION_EVENT

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

String

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {table}

{column:width=100%}{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: {sub-section}

gets the id of the client

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

String

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

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;
	jsclient.queueMethod(null, "remoteMethod", [x], 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}

(context, variableName, currentMethodName)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

get a dataprovider value from the client

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

context
variableName
[currentMethodName]

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Object

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

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

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: {sub-section}

returns true if this client is still valid/usable

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Boolean

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

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

(context, methodName, args, callbackFunction)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

queue a method on the client

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

context
methodName
args
callbackFunction

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

void

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

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

(context, variableName, value, currentMethodName)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {sub-section}

set a dataprovider value on the client

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

context
variableName
value
[currentMethodName]

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

Object

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

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

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: {sub-section}

shutdown

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {sub-section}

Unknown macro: {div}

Unknown macro: {sub-section}

force

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {sub-section}

void

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

Also see

Unknown macro: {sub-section}

Unknown macro: {builder-show}

Unknown macro: {tr}

Unknown macro: {td}

External links

Unknown macro: {sub-section}

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {sub-section}

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;
	jsclient.queueMethod(null, "remoteMethod", [x], callback);
}

Unknown macro: {tr}

Unknown macro: {td}

No labels

Child pages

JSClient

CALLBACK_EVENT

CALLBACK_EXCEPTION_EVENT

getClientID

getDataProviderValue

isValid

queueMethod

setDataProviderValue

shutdown