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
Unknown macro: {div}
Unknown macro: {table}
Unknown macro: {tr}
Unknown macro: {th}
Return Types
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}
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}
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: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
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}
Unknown macro: {span}
Unknown macro: {span}
createClient
Unknown macro: {span}
(solutionName, username, password, solutionOpenMethodArgs)
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
// 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}
Unknown macro: {span}
Unknown macro: {span}
getClient
Unknown macro: {span}
(clientID)
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
// 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}
Unknown macro: {span}
Unknown macro: {span}
getOrCreateClient
Unknown macro: {span}
(clientId, solutionname, username, password, solutionOpenMethodArgs)
Unknown macro: {tr}
Unknown macro: {td}
Parameters
Unknown macro: {div}
{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: {div}
JSClient – An existing JSClient or the JSClient that is created.
Unknown macro: {tr}
Unknown macro: {td}
Sample
Unknown macro: {div}
// 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}
Overview
Content Tools
Activity