Child pages
  • headlessclient
Skip to end of metadata
Go to start of metadata


Return Types
JSClient

Method Summary
JSClient #createClient(solutionName, username, password, solutionOpenMethodArgs)
Creates a headless client that will open the given solution.
JSClient #getClient(clientID)
Gets an existing headless client for the given client uuid.

Method Details
createClient

JSClient createClient (solutionName, username, password, solutionOpenMethodArgs)

Creates a headless client that will open the given solution.
Parameters
solutionName
username
password
solutionOpenMethodArgs
Returns
JSClient
Sample
// Creates a headless client that will open the given solution.
var headlessClient = plugins.headlessclient.createClient("someSolution", "user", "pass", null);
if (headlessClient != null && headlessClient.isValid()) { 
	 var x = new Object();
	 x.name = 'remote1';
	 x.number = 10;
headlessClient.queueMethod(null, "remoteMethod", [x], callback);
}
getClient

JSClient getClient (clientID)

Gets an existing headless client for the given client uuid.
Parameters
clientID
Returns
JSClient
Sample
// Gets an existing headless client for the given client uuid.
var headlessClient = plugins.headlessclient.getClient("clientID");
if (headlessClient != null && headlessClient.isValid()) {
	 headlessClient.queueMethod(null, "someRemoteMethod", null, callback);
}
  • No labels