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

Starting Headless Clients from Debug Clients in Servoy Developer

When starting a Headless Client from a Debug Client in Servoy Developer, there are restrictions to which solution can be started in the Headless Client.

By default the Headless Client which is started will be a debug-able Headless Client. As there can only one debug-able Client of a specific type at the same time (so one debug-able Web Client, one debug-able Smart Client and one debug-able Headless Client), starting a new debug-able Headless Client will close an existent debug-able Headless Client.

It's possible to start non-debug-able Headless Clients using the Headless Client plugin while in Servoy Developer by sending in the value "nodebug" as the last value in the "solutionOpenMethodArgs" array parameter. In this case it is also possible to start the Headless Client with a solution/module that isn't the Active Solution or one of it's modules, as long as the specified solution is available in the workspace and uses the same Resources project as the Active Solution


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
{String} solutionName
{String} username
{String} password
{Object[]} 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
{String} 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);
}