diffusion
Version:
Diffusion JavaScript client
35 lines (33 loc) • 1.01 kB
JavaScript
var _interface = require('util/interface')._interface;
/**
* A set of details relating to a client session.
*
* @class SessionDetails
* @property {Array<DetailType>} available - available detail types
* @property {String} connector - the configuration name of the server connector the client is connected to,
* or <pre>undefined</pre> if unavailable
* @property {String} server - server name or <pre>undefined</pre> if unavailable
* @property {ClientLocation} location - client location or <pre>undefined</pre> if unavailable
* @property {ClientSummary} summary - client summary or <pre>undefined</pre> if unavailable.
*/
module.exports = _interface('SessionDetails', [
'available',
'connector',
'server',
'location',
'summary'
]);
/**
* Enum containing possible Session Detail types.
*
* @readonly
* @enum
* @memberOf diffusion.clients
* @alias DetailType
*/
module.exports.DetailType = {
SUMMARY : 0,
LOCATION : 1,
CONNECTOR_NAME : 2,
SERVER_NAME : 3
};