Hemi.monitorHemi JavaScript FrameworkHemi JavaScript Framework/Hemi/Hemi.monitorHemiThe Monitor service provides a passive client-side monitor framework. Monitors collect and aggregate data per page view and send that data to a server for Web analytics processing. The Account Manager 4 project includes a reference implementation.serviceStatic instance of serviceImpl3.1.9MonitorAn object registerer with the ObjectRegistry, that defines an initializeMonitor method, and that may define any handle_{event name} method listed for the MonitorService. The initializeMonitor method must return true for the object to be treated as a monitor and receive event notifications and intervall callbacks.3.1.9Example Monitor #1Demonstrate how to create and register a basic monitor object.var oMonitor = { handle_window_load:function(){ }, // Required by MonitorService initializeMonitor:function(){ // must return true for monitoring to be enabled; return 1; }};// important to prepare object so 1) it can be registered, and 2) add it to the ObjectRegistryHemi.prepareObject("MyMonitor","1.0",true,oMonitor);// add the monitor objectHemi.monitor.service.addMonitor(oMonitor);Example Monitor #2Demonstrate alternate method to create and register a basic monitor object, and include inline configuration for the monitor.function Monitor(){}Monitor.prototype.initializeMonitor = function(){ alert("Access configuration value: " + this.getConfigKey("myprop")); // must return true for monitoring to be enabled; return 1;}var oMonitor = new Monitor();// important to prepare object so it can be registered; skip auto-registering for this demonstration.Hemi.prepareObject("MyMonitor","1.0",false,oMonitor");// Add object to the registry. It must be registered in order to be added as a monitor.Hemi.registry.service.addObject(oMonitor);Example Monitor #3Demonstrate how to create and register a monitor using an ApplicationComponent.]]>]]>]]>CDATA[ component_init:function(){ Hemi.monitor.service.addMonitor(this); }, initializeMonitor:function(){ return true; }, handle_window_load:function(e){ alert("window load via monitor service"); } ]]]]>]]>]]>]]>]]>var oComponent = Hemi.app.comp.newInstance();oComponent.loadComponent("demo_monitor","/path/to/file.xml");]]>getMonitorServiceReturns the MonitorService to which this Monitor is registered.A MonitorService implementation.getConfigKeysReturns the config_keys hash.Returns the hash containing the parsed inline configuration name/value pairs.getConfigKeyName of a config key.Returns the String or int value for the corresponding key.initializeMonitorTrue if the object initialized and should be treated as a monitor, false if the object should be ignored.Invoked by addMonitor if the object met the basic criteria for participating in the MonitorService: it must be registered, and it must define this method. Returns true if the object was initialized, false otherwise. If returning false, the object will not be treated as monitor and receive no notifications or callbacks. Whether this returns true or false, the object will continue to define the members set when addMonitor was invoked.doIntervalInvoked by MonitorService doInterval. By default, this is invoked every one second. Each monitor can conttrol participating in the interval by setting the can_interval property to true or false, and can increase delay by setting the interval_offset property to the number of whole seconds that should elapse before doInterval is invoked again. The interval_offset is used as a degrading counter, so each monitor is responsible for setting its own delay after each invocation of doInterval.handle_select_changeInvoked by MonitorService dispatchEvent to delegate the select change event.Event object raised for this event notification.handle_form_submitInvoked by MonitorService dispatchEvent to delegate the form submit event.Event object raised for this event notification.handle_form_resetInvoked by MonitorService dispatchEvent to delegate the form reset event.Event object raised for this event notification.handle_window_resizeInvoked by MonitorService dispatchEvent to delegate the window resize event.Event object raised for this event notification.handle_window_keydownInvoked by MonitorService dispatchEvent to delegate the window keydown event.Event object raised for this event notification.handle_input_blurInvoked by MonitorService dispatchEvent to delegate the input blur event.Event object raised for this event notification.handle_input_focusInvoked by MonitorService dispatchEvent to delegate the input focus event.Event object raised for this event notification.handle_window_blurInvoked by MonitorService dispatchEvent to delegate the window blur event.Event object raised for this event notification.handle_window_focusInvoked by MonitorService dispatchEvent to delegate the window focus event.Event object raised for this event notification.handle_document_scrollInvoked by MonitorService dispatchEvent to delegate the document scroll event.Event object raised for this event notification.handle_mouse_moveInvoked by MonitorService dispatchEvent to delegate the mouse move event.Event object raised for this event notification.handle_mouse_clickInvoked by MonitorService dispatchEvent to delegate the mouse click event.Event object raised for this event notification.handle_window_errorInvoked by MonitorService dispatchEvent to delegate the error event. TODO: need to fix handler parameters. At the moment, error information is not being passed.Event object raised for this event notification.handle_context_menuInvoked by MonitorService dispatchEvent to delegate the contextmenu event.Event object raised for this event notification.handle_window_unloadInvoked by MonitorService dispatchEvent to delegate the unload event.Event object raised for this event notification.handle_window_beforeunloadInvoked by MonitorService dispatchEvent to delegate the beforeunload event.Event object raised for this event notification.handle_window_loadInvoked by MonitorService dispatchEvent to delegate the load event and binds elements to internal handlers. Dispatches window_load to monitors.Event object raised for this event notification.MonitorServiceImplA base class for creating beacon and XML transponders for monitoring Web pages.3.1.9object_idUnique instance identifier.object_versionVersion of the object class.object_typeThe type of this object.ready_stateObject load and execution state. Follows: 0 unitialized, 1 through 3 variant, 4 ready, 5 destroyed.object_configObject API structure for storing sub structures: object_config.pointers and object_config.status.getObjectIdThe unique object instance id.Returns the unique id of the object.getObjectTypeThe type of the object instance.Returns the type of the object.getObjectVersionThe version of the object instance.Returns the version of the object.getReadyStateThe object ready state.Returns the state of the object.getStatusThe object_config.status substructure.Returns the object_config.status sub structure.getPointersThe object_config.pointers substructure.Returns the object_config.pointers sub structure.getContextObjectThe context node in which monitoring is to take place.Returns the object in which all monitoring should take place. Defaults to document. Can be specified by setting the global CONTEXT_OBJECT variable to a different object prior to loading the MonitorService.getDatasetIdIdentifier representing the type of data being collected.Returns the identifier used to describe the data being collected. Defaults to public. Can be specified by defining the global DATASET_ID variable to a custom value. getDatasetIdBit indicating whether the document has loaded and, under normal circumstances, whether it is rendered.Returns true if the document has loaded, false otherwise.getWindowStateThe current state of the browser window.Returns an int representing the current state of the browser window. 0 = unknown, 1 = uninitialized, 2 = window not loaded, 3 = window loaded, 4 = window before unload, 5 = window unloadgetSessionIdString indicating the application session identifier.Returns the session id based on the pre-configured session cookie name. By default, the MonitorService ships with MONITOR_SESSION_ID, and the value is auto-generated. To use a different cookie name, the SDK must be used to alter the build configuration. TODO: Add support for configurable names at runtime.getApplicationIdString indicating the application identifier.Returns the application id. Defaults to Global. Can be specified by defining the global APPLICATION_ID variable to a custom value.getContextIdLight hash of the current Web page location plus a few random numbers.Returns a light hash of the current page location plus a few random numbers to uniquely identify the current page visit from other pages visits by this particular session. This value only has to be unique in relation to other context_ids for the session id.hashCookieName of a specific cookie value to hash and promote its values into the main hash of cookie values.Bit indicating whether to hash embedded cookie values using the specified value name.Bit indicating to hash the cookie and ignore whether the cookie was previously hashed. By default, the cookie may only be hashed once per page view.cookies hash, where the default cookie structure of most browsers is: name=value; name2=value2. Optionally hashes embedded cookie values that use the following syntax: subname:subvalue&subname2:subvalue2. For example: name=subname:subvalue; name2=subname2:subvalue2&subname3:subvalue3]]>hashValueThe value to be hashed (eg: name=value; name2=value2).The delimiter of the value (eg: ;).The name/value assignment operator (eg: =).Object hash into which the retrieved name and value pairs will be applied.name=value; name2=value2.]]>doIntervalA an interval (one second / one thousand milliseconds) that invokes the doInterval method on Monitor instances that set the can_interval property to true. Monitors can increase delay by setting the interval_offset property to the number of seconds that should elapse before doInterval is invoked again. The interval_offset is used as a degrading counter, so each monitor is responsible for setting its own delay after each invocation of doInterval.handle_window_intervalHandler that manages the interval thread. Note: this doesn't use the ThreadService, though probably should.handle_document_stopHandler that manages the stop event. Dispatches document_stop to monitors.handle_window_loadHandler that manages the load event and binds elements to internal handlers. Dispatches window_load to monitors.handle_window_beforeunloadHandler that manages the beforeunload event. Dispatches window_beforeunload to monitors.handle_window_unloadHandler that manages the unload event. Dispatches window_unload to monitors.dispatchEventEvent key, such is window_load or window_unload.Event object.Dispatches event notifications to Monitor instances that define a function named handle_{event key}, such as handle_window_load. The event object is passed as the only parameter. NOTES: should we bother with cancelling events? These are monitors, which shouldn't be tampering with anything.initializeMonitorServiceStarts the MonitorService. This is automatically invoke when a MonitorService instance is created.handle_context_menuHandler that manages the contextmenu event. Dispatches context_menu to monitors.handle_window_errorHandler that manages the error event. Dispatches window_error to monitors. TODO: need to fix handler parameters. At the moment, error information is not being passed.handle_mouse_clickHandler that manages the mouse click event. Dispatches mouse_click to monitors.handle_mouse_moveHandler that manages the mouse move event. Dispatches mouse_move to monitors.handle_document_scrollHandler that manages the document scroll event. Dispatches document_scroll to monitors.handle_window_focusHandler that manages the window focus event. Dispatches window_focus to monitors.handle_window_blurHandler that manages the window blur event. Dispatches window_blur to monitors.handle_input_focusHandler that manages the input focus event. Dispatches input_focus to monitors.handle_input_blurHandler that manages the input blur event. Dispatches input_blur to monitors.handle_window_keydownHandler that manages the window keydown event. Dispatches window_keydown to monitors.handle_window_resizeHandler that manages the window resize event. Dispatches window_resize to monitors.handle_form_submitHandler that manages the form submit event. Dispatches form_submit to monitors.handle_form_resetHandler that manages the form reset event. Dispatches form_reset to monitors.handle_select_changeHandler that manages the select change event. Dispatches select_change to monitors.bindObjectsBinds MonitorService event handlers to common browser objects. Individual monitors participate in the event handler by defining a handle_{event name} function, such as handle_window_load. d.onstop = t.handle_window_stop; bindElementsBinds MonitorService event handlers to common Web page objects. Individual monitors participate in the event handler by defining a handle_{event name} function, such as handle_window_load. f(o,"submit",hs); f(o,"reset",hs); removeMonitorObject registered as a Monitor.Bit indicating whether the monitor was removed.Remove an object from the monitor service.addMonitorObject registered with the ObjectRegistry.config_keys hash on the Monitor instance to retrieve individual values.]]>Adds an object to the monitor service, and allows that object to automatically receive event callbacks and easy access to MonitorService information. The specified object must define an initializeMonitor method, and the method must return true for the monitor to be added. Defines the getMonitorService method, can_interval, and interval_offset on the specified object.The Monitor service provides a passive client-side monitor framework. Monitors collect and aggregate data per page view and send that data to a server for Web analytics processing. The Account Manager 4 project includes a reference implementation.Hemi_api.htmlAPI Index