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

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

Unknown macro: {sub-section}

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.

  • Prior to Servoy 6.1.1, the Headless Client would always start with the Active Solution, regardless which solution would be specified
  • As of Servoy 6.1.1 the specified solution will be honored, as long as the specified solution is the Active Solution or a solution/module included in the Active Solution

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


Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}

Return Types

Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSClient


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}

JSClient

Unknown macro: {td}

createClient(solutionName, username, password, solutionOpenMethodArgs)
Creates a headless client on the server that will open the given solution.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSClient

Unknown macro: {td}

getClient(clientID)
Gets an existing headless client for the given client uuid.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSClient

Unknown macro: {td}

getOrCreateClient(clientId, solutionname, username, password, solutionOpenMethodArgs)
This will try to get a existing client by the given id if that client is already created for that specific solution;
it will create a headless client on the server that will open the given solution if it didn't exists yet.


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}
createClient
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSClient

Unknown macro: {span}

createClient

Unknown macro: {span}

(solutionName, username, password, solutionOpenMethodArgs)

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Since

Unknown macro: {sub-section}
Unknown macro: {sub-section}

Replace with version info

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {sub-section}

{String} solutionName
{String} username
{String} password
{Object[]} solutionOpenMethodArgs

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

JSClient

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}
// 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);
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getClient
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSClient

Unknown macro: {span}

getClient

Unknown macro: {span}

(clientID)

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Since

Unknown macro: {sub-section}
Unknown macro: {sub-section}

Replace with version info

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {sub-section}

{String} clientID

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

JSClient

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}
// 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);
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getOrCreateClient
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSClient

Unknown macro: {span}

getOrCreateClient

Unknown macro: {span}

(clientId, solutionname, username, password, solutionOpenMethodArgs)

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {sub-section}
Unknown macro: {sub-section}

Replace with description

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Since

Unknown macro: {sub-section}
Unknown macro: {sub-section}

Replace with version info

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {sub-section}
Unknown macro: {sub-section}

{String} clientId – The id of the client if it already exists, or it will be the id of the client if it will be created.
{String} solutionname – The solution to load
{String} username – The user name that is used to login to the solution
{String} password – The password for the user
{Object[]} solutionOpenMethodArgs – The arguments that will be passed to the solution open method.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {sub-section}
Unknown macro: {sub-section}

JSClient – An existing JSClient or the JSClient that is created.

Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

Also see

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}
Unknown macro: {builder-show}
Unknown macro: {tr}
Unknown macro: {td}

External links

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}
Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {sub-section}
Unknown macro: {div}
Unknown macro: {sub-section}
// Creates a headless client that will open the given solution.
var storedSolutionSpecificID = "aaaabbbbccccc1111";
var headlessClient = plugins.headlessclient.getOrCreateClient(storedSolutionSpecificID, "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);
}
Unknown macro: {tr}
Unknown macro: {td}
  • No labels