Documentation generator: JsDoc Toolkit 2.3.2
Template: Codeview 1.2
Generated on: 2011-2-11 17:21

Class EventTracer

EventTracer

Class Summary
Constructor Attributes Constructor Name and Description
 
EventTracer(options)
Field Summary
Field Attributes Field Name and Description
<static>  
EventTracer.ATTRIBUTES_TO_CATCH
the list of attributes to be catched
<static>  
EventTracer.destinationService
The parameters defining how and where to send the events
<static>  
EventTracer.eventPool
array of events arrays
<static>  
EventTracer.EVENTS_TO_CATCH
the list of events to be catched
<static>  
EventTracer.eventsToBeSend
array of strings
<static>  
EventTracer.options
<static>  
EventTracer.opts
The tracer common options
<static>  
EventTracer.sourceService
The parameters defining how and where to load the events list to catch

Method Summary

Method Attributes Method Name and Description
<static>  
EventTracer.bind_platform()
bind platform events
<static>  
EventTracer.describeElement(e, pload)
set all information from the target dom element to the pLoad
<static>  
EventTracer.describeEvent(e, pload)
set all information from the event to the pLoad
<static>  
EventTracer.eventStation(e)
controler that send events to feedtrace
<static>  
EventTracer.feedTrace(target_tag, event_type, pLoad, pLoad)
in the API to allow the unit creator to send events himself to the event log record events of interaction between interviewee and the test
<static>  
EventTracer.hooks(e)
return true if the event passed is a business event
<static>  
EventTracer.increaseEventsPoolSize()
the request took too much time, we increase the size of traces package, to have less frequent requests
<static>  
EventTracer.initDestinationService(environment)
Initialize the service interface forthe destination service: how and where we send the catched events
<static>  
EventTracer.initSourceService(environment)
Initialize the service interface for the source service: how and where we retrieve the events to catch
<static>  
EventTracer.jQuery.fn.bindDom(eventTracer)
bind every non bubbling events to dom elements.
<static>  
EventTracer.jQuery.fn.unBindDom(eventTracer)
unbind platform events
<static>  
EventTracer.prepareFeedTrace()
prepare one block of stored traces for being sent
<static>  
EventTracer.reduceEventsPoolSize()
the request was fast enough, we increase the frequency of requests by reducing the size of traces package
<static>  
EventTracer.sendAllFeedTrace_now()
send all traces with a blocking function
<static>  
EventTracer.sendFeedTrace()
send one block of traces (non blocking) Does send the content of eventsToBeSend[0] to the server
<static>  
EventTracer.sendFeedTraceFail(xhr, errorString, exception, events)
callback function after request failed (TODO)
<static>  
EventTracer.sendFeedTraceSucceed(data, textStatus, sent_timeStamp)
success callback after traces sent.
<static>  
EventTracer.setEventParameters(e, pload)
set wanted information from the event to the pLoad
<static>  
EventTracer.setEventsToCatch(data)
record events of interaction between interviewee and the test
<static>  
EventTracer.unbind_platform()
unbind platform events

Class Detail

EventTracer(options)
Parameters:
options

Field Detail

<static> EventTracer.ATTRIBUTES_TO_CATCH
the list of attributes to be catched
<static> EventTracer.destinationService
The parameters defining how and where to send the events
<static> EventTracer.eventPool
array of events arrays
<static> EventTracer.EVENTS_TO_CATCH
the list of events to be catched
<static> EventTracer.eventsToBeSend
array of strings
<static> {Object} EventTracer.options
<static> EventTracer.opts
The tracer common options
<static> EventTracer.sourceService
The parameters defining how and where to load the events list to catch

Method Detail

  • <static> EventTracer.bind_platform()
    bind platform events
  • <static> EventTracer.describeElement(e, pload)
    set all information from the target dom element to the pLoad
    Parameters:
    {event} e
    dom event triggered
    {Object} pload
    callback function called when 'ok' clicked
  • <static> EventTracer.describeEvent(e, pload)
    set all information from the event to the pLoad
    Parameters:
    {event} e
    dom event triggered
    {Object} pload
    callback function called when 'ok' clicked
  • <static> EventTracer.eventStation(e)
    controler that send events to feedtrace
    Parameters:
    {event} e
    dom event triggered
  • <static> EventTracer.feedTrace(target_tag, event_type, pLoad, pLoad)
    in the API to allow the unit creator to send events himself to the event log record events of interaction between interviewee and the test
    feedTrace('BUSINESS','start_drawing',getGlobalTime(), {'unitTime':getUnitTime()});
    Parameters:
    {String} target_tag
    element type receiving the event.
    {String} event_type
    type of event being catched
    {Object} pLoad
    object containing various information about the event. you may put whatever you need in it.
    pLoad
  • <static> {boolean} EventTracer.hooks(e)
    return true if the event passed is a business event
    Parameters:
    {event} e
    dom event triggered
    Returns:
    {boolean}
  • <static> EventTracer.increaseEventsPoolSize()
    the request took too much time, we increase the size of traces package, to have less frequent requests
  • <static> EventTracer.initDestinationService(environment)
    Initialize the service interface forthe destination service: how and where we send the catched events
    Parameters:
    {Object} environment
  • <static> EventTracer.initSourceService(environment)
    Initialize the service interface for the source service: how and where we retrieve the events to catch
    Parameters:
    {Object} environment
  • <static> EventTracer.jQuery.fn.bindDom(eventTracer)
    bind every non bubbling events to dom elements.
    Parameters:
    eventTracer
  • <static> EventTracer.jQuery.fn.unBindDom(eventTracer)
    unbind platform events
    Parameters:
    eventTracer
  • <static> EventTracer.prepareFeedTrace()
    prepare one block of stored traces for being sent
  • <static> EventTracer.reduceEventsPoolSize()
    the request was fast enough, we increase the frequency of requests by reducing the size of traces package
  • <static> EventTracer.sendAllFeedTrace_now()
    send all traces with a blocking function
  • <static> EventTracer.sendFeedTrace()
    send one block of traces (non blocking) Does send the content of eventsToBeSend[0] to the server
  • <static> EventTracer.sendFeedTraceFail(xhr, errorString, exception, events)
    callback function after request failed (TODO)
    Parameters:
    {ressource} xhr
    ajax request ressource
    {String} errorString
    error message
    {exception} exception Optional
    exception object thrown
    events
  • <static> EventTracer.sendFeedTraceSucceed(data, textStatus, sent_timeStamp)
    success callback after traces sent. does affinate the size of traces package sent
    Parameters:
    {String} data
    response from server
    {String} textStatus
    status of request
    {int} sent_timeStamp
    time the request was sent
  • <static> EventTracer.setEventParameters(e, pload)
    set wanted information from the event to the pLoad
    Parameters:
    {event} e
    dom event triggered
    {Object} pload
    callback function called when 'ok' clicked
  • <static> {Object} EventTracer.setEventsToCatch(data)
    record events of interaction between interviewee and the test
    Parameters:
    {Object} data
    event type list
    Returns:
    {Object} the events to catch
  • <static> EventTracer.unbind_platform()
    unbind platform events