View Source

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

Method Summary

Number

#getApplicationType()
The type of the application started by this client.

String

#getClientID()
The ID of this client.

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

#getLoginTime()
The time and date the user logged into the system.

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.

Method Details

getApplicationType

Number

getApplicationType

()

The type of the application started by this client.

Returns
Number

Sample

var clients = plugins.maintenance.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('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());}

getClientID

String

getClientID

()

The ID of this client.

Returns
String

Sample

var clients = plugins.maintenance.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('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());}

getHostAddress

String

getHostAddress

()

The host address of this client.

Returns
String

Sample

var clients = plugins.maintenance.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('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());}

getHostIdentifier

String

getHostIdentifier

()

The host identifier of this client.

Returns
String

Sample

var clients = plugins.maintenance.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('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());}

getHostName

String

getHostName

()

The host name of this client.

Returns
String

Sample

var clients = plugins.maintenance.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('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());}

getIdleTime

Date

getIdleTime

()

The time and date since the user has been idle.

Returns
Date

Sample

var clients = plugins.maintenance.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('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());}

getLoginTime

Date

getLoginTime

()

The time and date the user logged into the system.

Returns
Date

Sample

var clients = plugins.maintenance.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('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());}

getUserName

String

getUserName

()

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

Returns
String

Sample

var clients = plugins.maintenance.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('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());}

getUserUID

String

getUserUID

()

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

Returns
String

Sample

var clients = plugins.maintenance.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('	User login time and date: ' + client.getLoginTime());
	application.output('	User idle since: ' + client.getIdleTime());}