Class Index | File Index

Classes


Class finesse.cslogger.ClientLogger

Allows gadgets to call the log function to publish client logging messages over the hub.
Defined in: finesse.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
init(hub, gadgetId, config)
Initiates the client logger with a hub a gadgetId and gadget's config object.
 
log(message)
Publishes a Log Message over the hub.
Class Detail
finesse.cslogger.ClientLogger()
Method Detail
init(hub, gadgetId, config)
Initiates the client logger with a hub a gadgetId and gadget's config object.
var _clientLogger = finesse.cslogger.ClientLogger;
_clientLogger.init(gadgets.Hub, "MyGadgetId", config);
Parameters:
{Object} hub
The hub to communicate with.
{String} gadgetId
A unique string to identify which gadget is doing the logging.
{finesse.gadget.Config} config
The config object used to get host name for that thirdparty gadget

log(message)
Publishes a Log Message over the hub.
_clientLogger.log("This is some important message for MyGadget");
Parameters:
{String} message
The string to log.

Documentation generated by JsDoc Toolkit 2.3.2 on Mon Nov 06 2017 08:00:55 GMT-0500 (EST)