Child pages
  • headlessclient

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
Hidden
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


HTML Table
classservoy sReturnTypes
Table Row (tr)
styleheight: 30px;
Table Head (th)
Return Types
Table Row (tr)
Table Cell (td)
Span
classsWordList
JSClient

HTML Table
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSClient
Table Cell (td)
#createClient(solutionName, username, password, solutionOpenMethodArgs)
Creates a headless client that will open the given solution.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
JSClient
Table Cell (td)
#getClient(clientID)
Gets an existing headless client for the given client uuid.

HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idcreateClient
classnode
Table Row (tr)
idname
Table Cell (td)
createClient
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSClient
Span
stylefloat: left; font-weight: bold;
idiets
createClient
Span
stylefloat: left;
idiets
(solutionName, username, password, solutionOpenMethodArgs)
Table Row (tr)
iddes
Table Cell (td)
Creates a headless client that will open the given solution.
Table Row (tr)
idprs
Table Cell (td)
Parameters
solutionName
username
password
solutionOpenMethodArgs
Table Row (tr)
idret
Table Cell (td)
Returns
JSClient
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// 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);
}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetClient
classnode
Table Row (tr)
idname
Table Cell (td)
getClient
Table Row (tr)
idsig
Table Cell (td)
Span
stylefloat: left; margin-right: 5px;
JSClient
Span
stylefloat: left; font-weight: bold;
idiets
getClient
Span
stylefloat: left;
idiets
(clientID)
Table Row (tr)
iddes
Table Cell (td)
Gets an existing headless client for the given client uuid.
Table Row (tr)
idprs
Table Cell (td)
Parameters
clientID
Table Row (tr)
idret
Table Cell (td)
Returns
JSClient
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript
// 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);
}
Table Row (tr)
classlastDetailRow
Table Cell (td)