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

Refresh page Mar 21, 2024 22:54

Supported Clients
SmartClient WebClient NGClient

Methods Summary
Number getApplicationType() The type of the application started by this client.
String getClientID() The ID of this client.
Array getClientInfos() Gets the array of client information strings as seen on the admin page.
String getHostAddress() The host address of this client.
String getHostIdentifier() The host identifier of this client.
String getHostName() The host name of this client.
Date getIdleTime() The time and date since the user has been idle.
Date getLastAccessedTime() Gets the last date and time when a user has physically accessed the application.
Date getLoginTime() The time and date the user logged into the system.
String getOpenSolutionName() The name of the solution that is currently open by the client.
String getStatusLine() This returns the status line of a NGClient (other clients don't have a value for this)
String getUserName() The name of the user who is logged in at this client.
String getUserUID() The ID of the user who is logged in at this client.

Methods Details

getApplicationType()

The type of the application started by this client.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var clients = plugins.clientmanager.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
	var client = clients[i];
	application.output('Client details:');
	application.output('	ID: ' + client.getClientID());
	application.output('	Application type: ' + client.getApplicationType());
	application.output('	Host address: ' + client.getHostAddress());
	application.output('	Host identifier: ' + client.getHostIdentifier());
	application.output('	Host name: ' + client.getHostName());
	application.output('	User name: ' + client.getUserName());
	application.output('	Used UID: ' + client.getUserUID());
	application.output('	Open solution: ' + client.getOpenSolutionName());
	application.output('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());
application.output('	Status line: ' + client.getStatusLine());
}

getClientID()

The ID of this client.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var clients = plugins.clientmanager.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
	var client = clients[i];
	application.output('Client details:');
	application.output('	ID: ' + client.getClientID());
	application.output('	Application type: ' + client.getApplicationType());
	application.output('	Host address: ' + client.getHostAddress());
	application.output('	Host identifier: ' + client.getHostIdentifier());
	application.output('	Host name: ' + client.getHostName());
	application.output('	User name: ' + client.getUserName());
	application.output('	Used UID: ' + client.getUserUID());
	application.output('	Open solution: ' + client.getOpenSolutionName());
	application.output('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());
application.output('	Status line: ' + client.getStatusLine());
}

getClientInfos()

Gets the array of client information strings as seen on the admin page.

Returns

Array a String array with the client information

Supported Clients

SmartClient,WebClient,NGClient

Sample

 

getHostAddress()

The host address of this client.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var clients = plugins.clientmanager.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
	var client = clients[i];
	application.output('Client details:');
	application.output('	ID: ' + client.getClientID());
	application.output('	Application type: ' + client.getApplicationType());
	application.output('	Host address: ' + client.getHostAddress());
	application.output('	Host identifier: ' + client.getHostIdentifier());
	application.output('	Host name: ' + client.getHostName());
	application.output('	User name: ' + client.getUserName());
	application.output('	Used UID: ' + client.getUserUID());
	application.output('	Open solution: ' + client.getOpenSolutionName());
	application.output('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());
application.output('	Status line: ' + client.getStatusLine());
}

getHostIdentifier()

The host identifier of this client.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var clients = plugins.clientmanager.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
	var client = clients[i];
	application.output('Client details:');
	application.output('	ID: ' + client.getClientID());
	application.output('	Application type: ' + client.getApplicationType());
	application.output('	Host address: ' + client.getHostAddress());
	application.output('	Host identifier: ' + client.getHostIdentifier());
	application.output('	Host name: ' + client.getHostName());
	application.output('	User name: ' + client.getUserName());
	application.output('	Used UID: ' + client.getUserUID());
	application.output('	Open solution: ' + client.getOpenSolutionName());
	application.output('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());
application.output('	Status line: ' + client.getStatusLine());
}

getHostName()

The host name of this client.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var clients = plugins.clientmanager.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
	var client = clients[i];
	application.output('Client details:');
	application.output('	ID: ' + client.getClientID());
	application.output('	Application type: ' + client.getApplicationType());
	application.output('	Host address: ' + client.getHostAddress());
	application.output('	Host identifier: ' + client.getHostIdentifier());
	application.output('	Host name: ' + client.getHostName());
	application.output('	User name: ' + client.getUserName());
	application.output('	Used UID: ' + client.getUserUID());
	application.output('	Open solution: ' + client.getOpenSolutionName());
	application.output('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());
application.output('	Status line: ' + client.getStatusLine());
}

getIdleTime()

The time and date since the user has been idle.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var clients = plugins.clientmanager.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
	var client = clients[i];
	application.output('Client details:');
	application.output('	ID: ' + client.getClientID());
	application.output('	Application type: ' + client.getApplicationType());
	application.output('	Host address: ' + client.getHostAddress());
	application.output('	Host identifier: ' + client.getHostIdentifier());
	application.output('	Host name: ' + client.getHostName());
	application.output('	User name: ' + client.getUserName());
	application.output('	Used UID: ' + client.getUserUID());
	application.output('	Open solution: ' + client.getOpenSolutionName());
	application.output('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());
application.output('	Status line: ' + client.getStatusLine());
}

getLastAccessedTime()

Gets the last date and time when a user has physically accessed the application. NGClient only!

Returns

Date a date object or null if the client doesn't support this

Supported Clients

SmartClient,WebClient,NGClient

Sample

var clients = plugins.clientmanager.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
	var client = clients[i];
	application.output('Client details:');
	application.output('	ID: ' + client.getClientID());
	application.output('	Application type: ' + client.getApplicationType());
	application.output('	Host address: ' + client.getHostAddress());
	application.output('	Host identifier: ' + client.getHostIdentifier());
	application.output('	Host name: ' + client.getHostName());
	application.output('	User name: ' + client.getUserName());
	application.output('	Used UID: ' + client.getUserUID());
	application.output('	Open solution: ' + client.getOpenSolutionName());
	application.output('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());
application.output('	Status line: ' + client.getStatusLine());
}

getLoginTime()

The time and date the user logged into the system.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var clients = plugins.clientmanager.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
	var client = clients[i];
	application.output('Client details:');
	application.output('	ID: ' + client.getClientID());
	application.output('	Application type: ' + client.getApplicationType());
	application.output('	Host address: ' + client.getHostAddress());
	application.output('	Host identifier: ' + client.getHostIdentifier());
	application.output('	Host name: ' + client.getHostName());
	application.output('	User name: ' + client.getUserName());
	application.output('	Used UID: ' + client.getUserUID());
	application.output('	Open solution: ' + client.getOpenSolutionName());
	application.output('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());
application.output('	Status line: ' + client.getStatusLine());
}

getOpenSolutionName()

The name of the solution that is currently open by the client.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var clients = plugins.clientmanager.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
	var client = clients[i];
	application.output('Client details:');
	application.output('	ID: ' + client.getClientID());
	application.output('	Application type: ' + client.getApplicationType());
	application.output('	Host address: ' + client.getHostAddress());
	application.output('	Host identifier: ' + client.getHostIdentifier());
	application.output('	Host name: ' + client.getHostName());
	application.output('	User name: ' + client.getUserName());
	application.output('	Used UID: ' + client.getUserUID());
	application.output('	Open solution: ' + client.getOpenSolutionName());
	application.output('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());
application.output('	Status line: ' + client.getStatusLine());
}

getStatusLine()

This returns the status line of a NGClient (other clients don't have a value for this)

Returns

String a string that is the status line as reported on the admin page.

Supported Clients

SmartClient,WebClient,NGClient

Sample

var clients = plugins.clientmanager.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
	var client = clients[i];
	application.output('Client details:');
	application.output('	ID: ' + client.getClientID());
	application.output('	Application type: ' + client.getApplicationType());
	application.output('	Host address: ' + client.getHostAddress());
	application.output('	Host identifier: ' + client.getHostIdentifier());
	application.output('	Host name: ' + client.getHostName());
	application.output('	User name: ' + client.getUserName());
	application.output('	Used UID: ' + client.getUserUID());
	application.output('	Open solution: ' + client.getOpenSolutionName());
	application.output('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());
application.output('	Status line: ' + client.getStatusLine());
}

getUserName()

The name of the user who is logged in at this client.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var clients = plugins.clientmanager.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
	var client = clients[i];
	application.output('Client details:');
	application.output('	ID: ' + client.getClientID());
	application.output('	Application type: ' + client.getApplicationType());
	application.output('	Host address: ' + client.getHostAddress());
	application.output('	Host identifier: ' + client.getHostIdentifier());
	application.output('	Host name: ' + client.getHostName());
	application.output('	User name: ' + client.getUserName());
	application.output('	Used UID: ' + client.getUserUID());
	application.output('	Open solution: ' + client.getOpenSolutionName());
	application.output('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());
application.output('	Status line: ' + client.getStatusLine());
}

getUserUID()

The ID of the user who is logged in at this client.

Returns

Supported Clients

SmartClient,WebClient,NGClient

Sample

var clients = plugins.clientmanager.getConnectedClients();
application.output('There are ' + clients.length + ' connected clients.');
for (var i = 0; i < clients.length; i++)
{
	var client = clients[i];
	application.output('Client details:');
	application.output('	ID: ' + client.getClientID());
	application.output('	Application type: ' + client.getApplicationType());
	application.output('	Host address: ' + client.getHostAddress());
	application.output('	Host identifier: ' + client.getHostIdentifier());
	application.output('	Host name: ' + client.getHostName());
	application.output('	User name: ' + client.getUserName());
	application.output('	Used UID: ' + client.getUserUID());
	application.output('	Open solution: ' + client.getOpenSolutionName());
	application.output('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());
application.output('	Status line: ' + client.getStatusLine());
}

  • No labels