npm package: @jibestream-dev/jmap-analytics-kit
Description: Jibestream plugin for using Analytics
Latest version: 1.0.3

# AnalyticsKit 

Jibestream plugin for using Analytics

### Documentation
## Functions

<dl>
<dt><a href="#constructor">constructor()</a> ⇒ <code>Object</code></dt>
<dd><p>Init method</p>
</dd>
<dt><a href="#sharedInstance">sharedInstance()</a> ⇒ <code>Object</code></dt>
<dd><p>Shared Instance singlton</p>
</dd>
<dt><a href="#setloggingOptions">setloggingOptions(loggingOptions)</a></dt>
<dd><p>Optional API to set parameters to log in analytics.</p>
</dd>
<dt><a href="#analyticsKitDidGetLog">analyticsKitDidGetLog(callback)</a></dt>
<dd><p>Used to receive any recorded data in real time.</p>
</dd>
<dt><a href="#_setNotifiers">_setNotifiers()</a></dt>
<dd><p>method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.</p>
</dd>
<dt><a href="#_shouldLogOption">_shouldLogOption(option)</a> ⇒ <code>Boolean</code></dt>
<dd><p>Used to check if log type sould be logged.</p>
</dd>
<dt><a href="#_recordTapOnShapeWithData">_recordTapOnShapeWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnIconWithData">_recordTapOnIconWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnXYWithData">_recordTapOnXYWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordLoadedMapCountWithData">_recordLoadedMapCountWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_startLoadFromServerEvent">_startLoadFromServerEvent(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endLoadFromServerEvent">_endLoadFromServerEvent(name, data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endRecordMapParsingWithKey">_endRecordMapParsingWithKey(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordWayfindPathWithValues">_recordWayfindPathWithValues(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_makeTimestampForData">_makeTimestampForData(data)</a> ⇒ <code>object</code></dt>
<dd><p>creates timestamp in data object</p>
</dd>
<dt><a href="#_recordCount">_recordCount(count, data)</a> ⇒ <code>Object</code></dt>
<dd><p>Helper method to record count and timestamp the event</p>
</dd>
<dt><a href="#_startEventWithTimerKey">_startEventWithTimerKey(timerKey)</a></dt>
<dd><p>Create and save a time key</p>
</dd>
<dt><a href="#_endEventWithTimerKey">_endEventWithTimerKey(timerKey)</a> ⇒ <code>Object</code></dt>
<dd><p>Log event with the timer key</p>
</dd>
</dl>

<a name="constructor"></a>

## constructor() ⇒ <code>Object</code>
Init method

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="sharedInstance"></a>

## sharedInstance() ⇒ <code>Object</code>
Shared Instance singlton

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="setloggingOptions"></a>

## setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.

**Kind**: global function  

| Param | Type |
| --- | --- |
| loggingOptions | <code>Array</code> | 

<a name="analyticsKitDidGetLog"></a>

## analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>function</code> | a function that can accept JSON. |

<a name="_setNotifiers"></a>

## _setNotifiers()
method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.

**Kind**: global function  
<a name="_shouldLogOption"></a>

## _shouldLogOption(option) ⇒ <code>Boolean</code>
Used to check if log type sould be logged.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| option | <code>String</code> | log option name |

<a name="_recordTapOnShapeWithData"></a>

## _recordTapOnShapeWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnIconWithData"></a>

## _recordTapOnIconWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnXYWithData"></a>

## _recordTapOnXYWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordLoadedMapCountWithData"></a>

## _recordLoadedMapCountWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_startLoadFromServerEvent"></a>

## _startLoadFromServerEvent(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_endLoadFromServerEvent"></a>

## _endLoadFromServerEvent(name, data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>String</code> | identifier |
| data | <code>object</code> | to parse |

<a name="_endRecordMapParsingWithKey"></a>

## _endRecordMapParsingWithKey(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordWayfindPathWithValues"></a>

## _recordWayfindPathWithValues(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_makeTimestampForData"></a>

## _makeTimestampForData(data) ⇒ <code>object</code>
creates timestamp in data object

**Kind**: global function  
**Returns**: <code>object</code> - data  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>Object</code> | to write |

<a name="_recordCount"></a>

## _recordCount(count, data) ⇒ <code>Object</code>
Helper method to record count and timestamp the event

**Kind**: global function  
**Returns**: <code>Object</code> - with count and timestamp  

| Param | Type |
| --- | --- |
| count | <code>Number</code> | 
| data | <code>Object</code> | 

<a name="_startEventWithTimerKey"></a>

## _startEventWithTimerKey(timerKey)
Create and save a time key

**Kind**: global function  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

<a name="_endEventWithTimerKey"></a>

## _endEventWithTimerKey(timerKey) ⇒ <code>Object</code>
Log event with the timer key

**Kind**: global function  
**Returns**: <code>Object</code> - with all timestamp details  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

## Functions

<dl>
<dt><a href="#constructor">constructor()</a> ⇒ <code>Object</code></dt>
<dd><p>Init method</p>
</dd>
<dt><a href="#sharedInstance">sharedInstance()</a> ⇒ <code>Object</code></dt>
<dd><p>Shared Instance singlton</p>
</dd>
<dt><a href="#setloggingOptions">setloggingOptions(loggingOptions)</a></dt>
<dd><p>Optional API to set parameters to log in analytics.</p>
</dd>
<dt><a href="#analyticsKitDidGetLog">analyticsKitDidGetLog(callback)</a></dt>
<dd><p>Used to receive any recorded data in real time.</p>
</dd>
<dt><a href="#_setNotifiers">_setNotifiers()</a></dt>
<dd><p>method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.</p>
</dd>
<dt><a href="#_shouldLogOption">_shouldLogOption(option)</a> ⇒ <code>Boolean</code></dt>
<dd><p>Used to check if log type sould be logged.</p>
</dd>
<dt><a href="#_recordTapOnShapeWithData">_recordTapOnShapeWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnIconWithData">_recordTapOnIconWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnXYWithData">_recordTapOnXYWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordLoadedMapCountWithData">_recordLoadedMapCountWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_startLoadFromServerEvent">_startLoadFromServerEvent(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endLoadFromServerEvent">_endLoadFromServerEvent(name, data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endRecordMapParsingWithKey">_endRecordMapParsingWithKey(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordWayfindPathWithValues">_recordWayfindPathWithValues(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_makeTimestampForData">_makeTimestampForData(data)</a> ⇒ <code>object</code></dt>
<dd><p>creates timestamp in data object</p>
</dd>
<dt><a href="#_recordCount">_recordCount(count, data)</a> ⇒ <code>Object</code></dt>
<dd><p>Helper method to record count and timestamp the event</p>
</dd>
<dt><a href="#_startEventWithTimerKey">_startEventWithTimerKey(timerKey)</a></dt>
<dd><p>Create and save a time key</p>
</dd>
<dt><a href="#_endEventWithTimerKey">_endEventWithTimerKey(timerKey)</a> ⇒ <code>Object</code></dt>
<dd><p>Log event with the timer key</p>
</dd>
</dl>

<a name="constructor"></a>

## constructor() ⇒ <code>Object</code>
Init method

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="sharedInstance"></a>

## sharedInstance() ⇒ <code>Object</code>
Shared Instance singlton

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="setloggingOptions"></a>

## setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.

**Kind**: global function  

| Param | Type |
| --- | --- |
| loggingOptions | <code>Array</code> | 

<a name="analyticsKitDidGetLog"></a>

## analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>function</code> | a function that can accept JSON. |

<a name="_setNotifiers"></a>

## _setNotifiers()
method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.

**Kind**: global function  
<a name="_shouldLogOption"></a>

## _shouldLogOption(option) ⇒ <code>Boolean</code>
Used to check if log type sould be logged.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| option | <code>String</code> | log option name |

<a name="_recordTapOnShapeWithData"></a>

## _recordTapOnShapeWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnIconWithData"></a>

## _recordTapOnIconWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnXYWithData"></a>

## _recordTapOnXYWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordLoadedMapCountWithData"></a>

## _recordLoadedMapCountWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_startLoadFromServerEvent"></a>

## _startLoadFromServerEvent(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_endLoadFromServerEvent"></a>

## _endLoadFromServerEvent(name, data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>String</code> | identifier |
| data | <code>object</code> | to parse |

<a name="_endRecordMapParsingWithKey"></a>

## _endRecordMapParsingWithKey(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordWayfindPathWithValues"></a>

## _recordWayfindPathWithValues(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_makeTimestampForData"></a>

## _makeTimestampForData(data) ⇒ <code>object</code>
creates timestamp in data object

**Kind**: global function  
**Returns**: <code>object</code> - data  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>Object</code> | to write |

<a name="_recordCount"></a>

## _recordCount(count, data) ⇒ <code>Object</code>
Helper method to record count and timestamp the event

**Kind**: global function  
**Returns**: <code>Object</code> - with count and timestamp  

| Param | Type |
| --- | --- |
| count | <code>Number</code> | 
| data | <code>Object</code> | 

<a name="_startEventWithTimerKey"></a>

## _startEventWithTimerKey(timerKey)
Create and save a time key

**Kind**: global function  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

<a name="_endEventWithTimerKey"></a>

## _endEventWithTimerKey(timerKey) ⇒ <code>Object</code>
Log event with the timer key

**Kind**: global function  
**Returns**: <code>Object</code> - with all timestamp details  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

## Functions

<dl>
<dt><a href="#constructor">constructor()</a> ⇒ <code>Object</code></dt>
<dd><p>Init method</p>
</dd>
<dt><a href="#sharedInstance">sharedInstance()</a> ⇒ <code>Object</code></dt>
<dd><p>Shared Instance singlton</p>
</dd>
<dt><a href="#setloggingOptions">setloggingOptions(loggingOptions)</a></dt>
<dd><p>Optional API to set parameters to log in analytics.</p>
</dd>
<dt><a href="#analyticsKitDidGetLog">analyticsKitDidGetLog(callback)</a></dt>
<dd><p>Used to receive any recorded data in real time.</p>
</dd>
<dt><a href="#_setNotifiers">_setNotifiers()</a></dt>
<dd><p>method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.</p>
</dd>
<dt><a href="#_shouldLogOption">_shouldLogOption(option)</a> ⇒ <code>Boolean</code></dt>
<dd><p>Used to check if log type sould be logged.</p>
</dd>
<dt><a href="#_recordTapOnShapeWithData">_recordTapOnShapeWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnIconWithData">_recordTapOnIconWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnXYWithData">_recordTapOnXYWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordLoadedMapCountWithData">_recordLoadedMapCountWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_startLoadFromServerEvent">_startLoadFromServerEvent(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endLoadFromServerEvent">_endLoadFromServerEvent(name, data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endRecordMapParsingWithKey">_endRecordMapParsingWithKey(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordWayfindPathWithValues">_recordWayfindPathWithValues(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_makeTimestampForData">_makeTimestampForData(data)</a> ⇒ <code>object</code></dt>
<dd><p>creates timestamp in data object</p>
</dd>
<dt><a href="#_recordCount">_recordCount(count, data)</a> ⇒ <code>Object</code></dt>
<dd><p>Helper method to record count and timestamp the event</p>
</dd>
<dt><a href="#_startEventWithTimerKey">_startEventWithTimerKey(timerKey)</a></dt>
<dd><p>Create and save a time key</p>
</dd>
<dt><a href="#_endEventWithTimerKey">_endEventWithTimerKey(timerKey)</a> ⇒ <code>Object</code></dt>
<dd><p>Log event with the timer key</p>
</dd>
</dl>

<a name="constructor"></a>

## constructor() ⇒ <code>Object</code>
Init method

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="sharedInstance"></a>

## sharedInstance() ⇒ <code>Object</code>
Shared Instance singlton

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="setloggingOptions"></a>

## setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.

**Kind**: global function  

| Param | Type |
| --- | --- |
| loggingOptions | <code>Array</code> | 

<a name="analyticsKitDidGetLog"></a>

## analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>function</code> | a function that can accept JSON. |

<a name="_setNotifiers"></a>

## _setNotifiers()
method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.

**Kind**: global function  
<a name="_shouldLogOption"></a>

## _shouldLogOption(option) ⇒ <code>Boolean</code>
Used to check if log type sould be logged.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| option | <code>String</code> | log option name |

<a name="_recordTapOnShapeWithData"></a>

## _recordTapOnShapeWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnIconWithData"></a>

## _recordTapOnIconWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnXYWithData"></a>

## _recordTapOnXYWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordLoadedMapCountWithData"></a>

## _recordLoadedMapCountWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_startLoadFromServerEvent"></a>

## _startLoadFromServerEvent(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_endLoadFromServerEvent"></a>

## _endLoadFromServerEvent(name, data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>String</code> | identifier |
| data | <code>object</code> | to parse |

<a name="_endRecordMapParsingWithKey"></a>

## _endRecordMapParsingWithKey(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordWayfindPathWithValues"></a>

## _recordWayfindPathWithValues(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_makeTimestampForData"></a>

## _makeTimestampForData(data) ⇒ <code>object</code>
creates timestamp in data object

**Kind**: global function  
**Returns**: <code>object</code> - data  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>Object</code> | to write |

<a name="_recordCount"></a>

## _recordCount(count, data) ⇒ <code>Object</code>
Helper method to record count and timestamp the event

**Kind**: global function  
**Returns**: <code>Object</code> - with count and timestamp  

| Param | Type |
| --- | --- |
| count | <code>Number</code> | 
| data | <code>Object</code> | 

<a name="_startEventWithTimerKey"></a>

## _startEventWithTimerKey(timerKey)
Create and save a time key

**Kind**: global function  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

<a name="_endEventWithTimerKey"></a>

## _endEventWithTimerKey(timerKey) ⇒ <code>Object</code>
Log event with the timer key

**Kind**: global function  
**Returns**: <code>Object</code> - with all timestamp details  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

## Functions

<dl>
<dt><a href="#constructor">constructor()</a> ⇒ <code>Object</code></dt>
<dd><p>Init method</p>
</dd>
<dt><a href="#sharedInstance">sharedInstance()</a> ⇒ <code>Object</code></dt>
<dd><p>Shared Instance singlton</p>
</dd>
<dt><a href="#setloggingOptions">setloggingOptions(loggingOptions)</a></dt>
<dd><p>Optional API to set parameters to log in analytics.</p>
</dd>
<dt><a href="#analyticsKitDidGetLog">analyticsKitDidGetLog(callback)</a></dt>
<dd><p>Used to receive any recorded data in real time.</p>
</dd>
<dt><a href="#_setNotifiers">_setNotifiers()</a></dt>
<dd><p>method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.</p>
</dd>
<dt><a href="#_shouldLogOption">_shouldLogOption(option)</a> ⇒ <code>Boolean</code></dt>
<dd><p>Used to check if log type sould be logged.</p>
</dd>
<dt><a href="#_recordTapOnShapeWithData">_recordTapOnShapeWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnIconWithData">_recordTapOnIconWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnXYWithData">_recordTapOnXYWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordLoadedMapCountWithData">_recordLoadedMapCountWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_startLoadFromServerEvent">_startLoadFromServerEvent(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endLoadFromServerEvent">_endLoadFromServerEvent(name, data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endRecordMapParsingWithKey">_endRecordMapParsingWithKey(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordWayfindPathWithValues">_recordWayfindPathWithValues(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_makeTimestampForData">_makeTimestampForData(data)</a> ⇒ <code>object</code></dt>
<dd><p>creates timestamp in data object</p>
</dd>
<dt><a href="#_recordCount">_recordCount(count, data)</a> ⇒ <code>Object</code></dt>
<dd><p>Helper method to record count and timestamp the event</p>
</dd>
<dt><a href="#_startEventWithTimerKey">_startEventWithTimerKey(timerKey)</a></dt>
<dd><p>Create and save a time key</p>
</dd>
<dt><a href="#_endEventWithTimerKey">_endEventWithTimerKey(timerKey)</a> ⇒ <code>Object</code></dt>
<dd><p>Log event with the timer key</p>
</dd>
</dl>

<a name="constructor"></a>

## constructor() ⇒ <code>Object</code>
Init method

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="sharedInstance"></a>

## sharedInstance() ⇒ <code>Object</code>
Shared Instance singlton

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="setloggingOptions"></a>

## setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.

**Kind**: global function  

| Param | Type |
| --- | --- |
| loggingOptions | <code>Array</code> | 

<a name="analyticsKitDidGetLog"></a>

## analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>function</code> | a function that can accept JSON. |

<a name="_setNotifiers"></a>

## _setNotifiers()
method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.

**Kind**: global function  
<a name="_shouldLogOption"></a>

## _shouldLogOption(option) ⇒ <code>Boolean</code>
Used to check if log type sould be logged.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| option | <code>String</code> | log option name |

<a name="_recordTapOnShapeWithData"></a>

## _recordTapOnShapeWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnIconWithData"></a>

## _recordTapOnIconWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnXYWithData"></a>

## _recordTapOnXYWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordLoadedMapCountWithData"></a>

## _recordLoadedMapCountWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_startLoadFromServerEvent"></a>

## _startLoadFromServerEvent(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_endLoadFromServerEvent"></a>

## _endLoadFromServerEvent(name, data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>String</code> | identifier |
| data | <code>object</code> | to parse |

<a name="_endRecordMapParsingWithKey"></a>

## _endRecordMapParsingWithKey(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordWayfindPathWithValues"></a>

## _recordWayfindPathWithValues(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_makeTimestampForData"></a>

## _makeTimestampForData(data) ⇒ <code>object</code>
creates timestamp in data object

**Kind**: global function  
**Returns**: <code>object</code> - data  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>Object</code> | to write |

<a name="_recordCount"></a>

## _recordCount(count, data) ⇒ <code>Object</code>
Helper method to record count and timestamp the event

**Kind**: global function  
**Returns**: <code>Object</code> - with count and timestamp  

| Param | Type |
| --- | --- |
| count | <code>Number</code> | 
| data | <code>Object</code> | 

<a name="_startEventWithTimerKey"></a>

## _startEventWithTimerKey(timerKey)
Create and save a time key

**Kind**: global function  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

<a name="_endEventWithTimerKey"></a>

## _endEventWithTimerKey(timerKey) ⇒ <code>Object</code>
Log event with the timer key

**Kind**: global function  
**Returns**: <code>Object</code> - with all timestamp details  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

## Functions

<dl>
<dt><a href="#constructor">constructor()</a> ⇒ <code>Object</code></dt>
<dd><p>Init method</p>
</dd>
<dt><a href="#sharedInstance">sharedInstance()</a> ⇒ <code>Object</code></dt>
<dd><p>Shared Instance singlton</p>
</dd>
<dt><a href="#setloggingOptions">setloggingOptions(loggingOptions)</a></dt>
<dd><p>Optional API to set parameters to log in analytics.</p>
</dd>
<dt><a href="#analyticsKitDidGetLog">analyticsKitDidGetLog(callback)</a></dt>
<dd><p>Used to receive any recorded data in real time.</p>
</dd>
<dt><a href="#_setNotifiers">_setNotifiers()</a></dt>
<dd><p>method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.</p>
</dd>
<dt><a href="#_shouldLogOption">_shouldLogOption(option)</a> ⇒ <code>Boolean</code></dt>
<dd><p>Used to check if log type sould be logged.</p>
</dd>
<dt><a href="#_recordTapOnShapeWithData">_recordTapOnShapeWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnIconWithData">_recordTapOnIconWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnXYWithData">_recordTapOnXYWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordLoadedMapCountWithData">_recordLoadedMapCountWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_startLoadFromServerEvent">_startLoadFromServerEvent(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endLoadFromServerEvent">_endLoadFromServerEvent(name, data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endRecordMapParsingWithKey">_endRecordMapParsingWithKey(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordWayfindPathWithValues">_recordWayfindPathWithValues(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_makeTimestampForData">_makeTimestampForData(data)</a> ⇒ <code>object</code></dt>
<dd><p>creates timestamp in data object</p>
</dd>
<dt><a href="#_recordCount">_recordCount(count, data)</a> ⇒ <code>Object</code></dt>
<dd><p>Helper method to record count and timestamp the event</p>
</dd>
<dt><a href="#_startEventWithTimerKey">_startEventWithTimerKey(timerKey)</a></dt>
<dd><p>Create and save a time key</p>
</dd>
<dt><a href="#_endEventWithTimerKey">_endEventWithTimerKey(timerKey)</a> ⇒ <code>Object</code></dt>
<dd><p>Log event with the timer key</p>
</dd>
</dl>

<a name="constructor"></a>

## constructor() ⇒ <code>Object</code>
Init method

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="sharedInstance"></a>

## sharedInstance() ⇒ <code>Object</code>
Shared Instance singlton

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="setloggingOptions"></a>

## setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.

**Kind**: global function  

| Param | Type |
| --- | --- |
| loggingOptions | <code>Array</code> | 

<a name="analyticsKitDidGetLog"></a>

## analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>function</code> | a function that can accept JSON. |

<a name="_setNotifiers"></a>

## _setNotifiers()
method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.

**Kind**: global function  
<a name="_shouldLogOption"></a>

## _shouldLogOption(option) ⇒ <code>Boolean</code>
Used to check if log type sould be logged.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| option | <code>String</code> | log option name |

<a name="_recordTapOnShapeWithData"></a>

## _recordTapOnShapeWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnIconWithData"></a>

## _recordTapOnIconWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnXYWithData"></a>

## _recordTapOnXYWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordLoadedMapCountWithData"></a>

## _recordLoadedMapCountWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_startLoadFromServerEvent"></a>

## _startLoadFromServerEvent(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_endLoadFromServerEvent"></a>

## _endLoadFromServerEvent(name, data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>String</code> | identifier |
| data | <code>object</code> | to parse |

<a name="_endRecordMapParsingWithKey"></a>

## _endRecordMapParsingWithKey(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordWayfindPathWithValues"></a>

## _recordWayfindPathWithValues(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_makeTimestampForData"></a>

## _makeTimestampForData(data) ⇒ <code>object</code>
creates timestamp in data object

**Kind**: global function  
**Returns**: <code>object</code> - data  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>Object</code> | to write |

<a name="_recordCount"></a>

## _recordCount(count, data) ⇒ <code>Object</code>
Helper method to record count and timestamp the event

**Kind**: global function  
**Returns**: <code>Object</code> - with count and timestamp  

| Param | Type |
| --- | --- |
| count | <code>Number</code> | 
| data | <code>Object</code> | 

<a name="_startEventWithTimerKey"></a>

## _startEventWithTimerKey(timerKey)
Create and save a time key

**Kind**: global function  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

<a name="_endEventWithTimerKey"></a>

## _endEventWithTimerKey(timerKey) ⇒ <code>Object</code>
Log event with the timer key

**Kind**: global function  
**Returns**: <code>Object</code> - with all timestamp details  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

## Functions

<dl>
<dt><a href="#constructor">constructor()</a> ⇒ <code>Object</code></dt>
<dd><p>Init method</p>
</dd>
<dt><a href="#sharedInstance">sharedInstance()</a> ⇒ <code>Object</code></dt>
<dd><p>Shared Instance singlton</p>
</dd>
<dt><a href="#setloggingOptions">setloggingOptions(loggingOptions)</a></dt>
<dd><p>Optional API to set parameters to log in analytics.</p>
</dd>
<dt><a href="#analyticsKitDidGetLog">analyticsKitDidGetLog(callback)</a></dt>
<dd><p>Used to receive any recorded data in real time.</p>
</dd>
<dt><a href="#_setNotifiers">_setNotifiers()</a></dt>
<dd><p>method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.</p>
</dd>
<dt><a href="#_shouldLogOption">_shouldLogOption(option)</a> ⇒ <code>Boolean</code></dt>
<dd><p>Used to check if log type sould be logged.</p>
</dd>
<dt><a href="#_recordTapOnShapeWithData">_recordTapOnShapeWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnIconWithData">_recordTapOnIconWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnXYWithData">_recordTapOnXYWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordLoadedMapCountWithData">_recordLoadedMapCountWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_startLoadFromServerEvent">_startLoadFromServerEvent(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endLoadFromServerEvent">_endLoadFromServerEvent(name, data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endRecordMapParsingWithKey">_endRecordMapParsingWithKey(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordWayfindPathWithValues">_recordWayfindPathWithValues(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_makeTimestampForData">_makeTimestampForData(data)</a> ⇒ <code>object</code></dt>
<dd><p>creates timestamp in data object</p>
</dd>
<dt><a href="#_recordCount">_recordCount(count, data)</a> ⇒ <code>Object</code></dt>
<dd><p>Helper method to record count and timestamp the event</p>
</dd>
<dt><a href="#_startEventWithTimerKey">_startEventWithTimerKey(timerKey)</a></dt>
<dd><p>Create and save a time key</p>
</dd>
<dt><a href="#_endEventWithTimerKey">_endEventWithTimerKey(timerKey)</a> ⇒ <code>Object</code></dt>
<dd><p>Log event with the timer key</p>
</dd>
</dl>

<a name="constructor"></a>

## constructor() ⇒ <code>Object</code>
Init method

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="sharedInstance"></a>

## sharedInstance() ⇒ <code>Object</code>
Shared Instance singlton

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="setloggingOptions"></a>

## setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.

**Kind**: global function  

| Param | Type |
| --- | --- |
| loggingOptions | <code>Array</code> | 

<a name="analyticsKitDidGetLog"></a>

## analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>function</code> | a function that can accept JSON. |

<a name="_setNotifiers"></a>

## _setNotifiers()
method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.

**Kind**: global function  
<a name="_shouldLogOption"></a>

## _shouldLogOption(option) ⇒ <code>Boolean</code>
Used to check if log type sould be logged.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| option | <code>String</code> | log option name |

<a name="_recordTapOnShapeWithData"></a>

## _recordTapOnShapeWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnIconWithData"></a>

## _recordTapOnIconWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnXYWithData"></a>

## _recordTapOnXYWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordLoadedMapCountWithData"></a>

## _recordLoadedMapCountWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_startLoadFromServerEvent"></a>

## _startLoadFromServerEvent(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_endLoadFromServerEvent"></a>

## _endLoadFromServerEvent(name, data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>String</code> | identifier |
| data | <code>object</code> | to parse |

<a name="_endRecordMapParsingWithKey"></a>

## _endRecordMapParsingWithKey(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordWayfindPathWithValues"></a>

## _recordWayfindPathWithValues(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_makeTimestampForData"></a>

## _makeTimestampForData(data) ⇒ <code>object</code>
creates timestamp in data object

**Kind**: global function  
**Returns**: <code>object</code> - data  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>Object</code> | to write |

<a name="_recordCount"></a>

## _recordCount(count, data) ⇒ <code>Object</code>
Helper method to record count and timestamp the event

**Kind**: global function  
**Returns**: <code>Object</code> - with count and timestamp  

| Param | Type |
| --- | --- |
| count | <code>Number</code> | 
| data | <code>Object</code> | 

<a name="_startEventWithTimerKey"></a>

## _startEventWithTimerKey(timerKey)
Create and save a time key

**Kind**: global function  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

<a name="_endEventWithTimerKey"></a>

## _endEventWithTimerKey(timerKey) ⇒ <code>Object</code>
Log event with the timer key

**Kind**: global function  
**Returns**: <code>Object</code> - with all timestamp details  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

## Functions

<dl>
<dt><a href="#constructor">constructor()</a> ⇒ <code>Object</code></dt>
<dd><p>Init method</p>
</dd>
<dt><a href="#sharedInstance">sharedInstance()</a> ⇒ <code>Object</code></dt>
<dd><p>Shared Instance singlton</p>
</dd>
<dt><a href="#setloggingOptions">setloggingOptions(loggingOptions)</a></dt>
<dd><p>Optional API to set parameters to log in analytics.</p>
</dd>
<dt><a href="#analyticsKitDidGetLog">analyticsKitDidGetLog(callback)</a></dt>
<dd><p>Used to receive any recorded data in real time.</p>
</dd>
<dt><a href="#_setNotifiers">_setNotifiers()</a></dt>
<dd><p>method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.</p>
</dd>
<dt><a href="#_shouldLogOption">_shouldLogOption(option)</a> ⇒ <code>Boolean</code></dt>
<dd><p>Used to check if log type sould be logged.</p>
</dd>
<dt><a href="#_recordTapOnShapeWithData">_recordTapOnShapeWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnIconWithData">_recordTapOnIconWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnXYWithData">_recordTapOnXYWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordLoadedMapCountWithData">_recordLoadedMapCountWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_startLoadFromServerEvent">_startLoadFromServerEvent(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endLoadFromServerEvent">_endLoadFromServerEvent(name, data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endRecordMapParsingWithKey">_endRecordMapParsingWithKey(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordWayfindPathWithValues">_recordWayfindPathWithValues(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_makeTimestampForData">_makeTimestampForData(data)</a> ⇒ <code>object</code></dt>
<dd><p>creates timestamp in data object</p>
</dd>
<dt><a href="#_recordCount">_recordCount(count, data)</a> ⇒ <code>Object</code></dt>
<dd><p>Helper method to record count and timestamp the event</p>
</dd>
<dt><a href="#_startEventWithTimerKey">_startEventWithTimerKey(timerKey)</a></dt>
<dd><p>Create and save a time key</p>
</dd>
<dt><a href="#_endEventWithTimerKey">_endEventWithTimerKey(timerKey)</a> ⇒ <code>Object</code></dt>
<dd><p>Log event with the timer key</p>
</dd>
</dl>

<a name="constructor"></a>

## constructor() ⇒ <code>Object</code>
Init method

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="sharedInstance"></a>

## sharedInstance() ⇒ <code>Object</code>
Shared Instance singlton

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="setloggingOptions"></a>

## setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.

**Kind**: global function  

| Param | Type |
| --- | --- |
| loggingOptions | <code>Array</code> | 

<a name="analyticsKitDidGetLog"></a>

## analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>function</code> | a function that can accept JSON. |

<a name="_setNotifiers"></a>

## _setNotifiers()
method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.

**Kind**: global function  
<a name="_shouldLogOption"></a>

## _shouldLogOption(option) ⇒ <code>Boolean</code>
Used to check if log type sould be logged.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| option | <code>String</code> | log option name |

<a name="_recordTapOnShapeWithData"></a>

## _recordTapOnShapeWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnIconWithData"></a>

## _recordTapOnIconWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnXYWithData"></a>

## _recordTapOnXYWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordLoadedMapCountWithData"></a>

## _recordLoadedMapCountWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_startLoadFromServerEvent"></a>

## _startLoadFromServerEvent(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_endLoadFromServerEvent"></a>

## _endLoadFromServerEvent(name, data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>String</code> | identifier |
| data | <code>object</code> | to parse |

<a name="_endRecordMapParsingWithKey"></a>

## _endRecordMapParsingWithKey(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordWayfindPathWithValues"></a>

## _recordWayfindPathWithValues(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_makeTimestampForData"></a>

## _makeTimestampForData(data) ⇒ <code>object</code>
creates timestamp in data object

**Kind**: global function  
**Returns**: <code>object</code> - data  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>Object</code> | to write |

<a name="_recordCount"></a>

## _recordCount(count, data) ⇒ <code>Object</code>
Helper method to record count and timestamp the event

**Kind**: global function  
**Returns**: <code>Object</code> - with count and timestamp  

| Param | Type |
| --- | --- |
| count | <code>Number</code> | 
| data | <code>Object</code> | 

<a name="_startEventWithTimerKey"></a>

## _startEventWithTimerKey(timerKey)
Create and save a time key

**Kind**: global function  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

<a name="_endEventWithTimerKey"></a>

## _endEventWithTimerKey(timerKey) ⇒ <code>Object</code>
Log event with the timer key

**Kind**: global function  
**Returns**: <code>Object</code> - with all timestamp details  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

## Functions

<dl>
<dt><a href="#constructor">constructor()</a> ⇒ <code>Object</code></dt>
<dd><p>Init method</p>
</dd>
<dt><a href="#sharedInstance">sharedInstance()</a> ⇒ <code>Object</code></dt>
<dd><p>Shared Instance singlton</p>
</dd>
<dt><a href="#setloggingOptions">setloggingOptions(loggingOptions)</a></dt>
<dd><p>Optional API to set parameters to log in analytics.</p>
</dd>
<dt><a href="#analyticsKitDidGetLog">analyticsKitDidGetLog(callback)</a></dt>
<dd><p>Used to receive any recorded data in real time.</p>
</dd>
<dt><a href="#_setNotifiers">_setNotifiers()</a></dt>
<dd><p>method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.</p>
</dd>
<dt><a href="#_shouldLogOption">_shouldLogOption(option)</a> ⇒ <code>Boolean</code></dt>
<dd><p>Used to check if log type sould be logged.</p>
</dd>
<dt><a href="#_recordTapOnShapeWithData">_recordTapOnShapeWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnIconWithData">_recordTapOnIconWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnXYWithData">_recordTapOnXYWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordLoadedMapCountWithData">_recordLoadedMapCountWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_startLoadFromServerEvent">_startLoadFromServerEvent(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endLoadFromServerEvent">_endLoadFromServerEvent(name, data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endRecordMapParsingWithKey">_endRecordMapParsingWithKey(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordWayfindPathWithValues">_recordWayfindPathWithValues(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_makeTimestampForData">_makeTimestampForData(data)</a> ⇒ <code>object</code></dt>
<dd><p>creates timestamp in data object</p>
</dd>
<dt><a href="#_recordCount">_recordCount(count, data)</a> ⇒ <code>Object</code></dt>
<dd><p>Helper method to record count and timestamp the event</p>
</dd>
<dt><a href="#_startEventWithTimerKey">_startEventWithTimerKey(timerKey)</a></dt>
<dd><p>Create and save a time key</p>
</dd>
<dt><a href="#_endEventWithTimerKey">_endEventWithTimerKey(timerKey)</a> ⇒ <code>Object</code></dt>
<dd><p>Log event with the timer key</p>
</dd>
</dl>

<a name="constructor"></a>

## constructor() ⇒ <code>Object</code>
Init method

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="sharedInstance"></a>

## sharedInstance() ⇒ <code>Object</code>
Shared Instance singlton

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="setloggingOptions"></a>

## setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.

**Kind**: global function  

| Param | Type |
| --- | --- |
| loggingOptions | <code>Array</code> | 

<a name="analyticsKitDidGetLog"></a>

## analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>function</code> | a function that can accept JSON. |

<a name="_setNotifiers"></a>

## _setNotifiers()
method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.

**Kind**: global function  
<a name="_shouldLogOption"></a>

## _shouldLogOption(option) ⇒ <code>Boolean</code>
Used to check if log type sould be logged.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| option | <code>String</code> | log option name |

<a name="_recordTapOnShapeWithData"></a>

## _recordTapOnShapeWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnIconWithData"></a>

## _recordTapOnIconWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnXYWithData"></a>

## _recordTapOnXYWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordLoadedMapCountWithData"></a>

## _recordLoadedMapCountWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_startLoadFromServerEvent"></a>

## _startLoadFromServerEvent(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_endLoadFromServerEvent"></a>

## _endLoadFromServerEvent(name, data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>String</code> | identifier |
| data | <code>object</code> | to parse |

<a name="_endRecordMapParsingWithKey"></a>

## _endRecordMapParsingWithKey(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordWayfindPathWithValues"></a>

## _recordWayfindPathWithValues(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_makeTimestampForData"></a>

## _makeTimestampForData(data) ⇒ <code>object</code>
creates timestamp in data object

**Kind**: global function  
**Returns**: <code>object</code> - data  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>Object</code> | to write |

<a name="_recordCount"></a>

## _recordCount(count, data) ⇒ <code>Object</code>
Helper method to record count and timestamp the event

**Kind**: global function  
**Returns**: <code>Object</code> - with count and timestamp  

| Param | Type |
| --- | --- |
| count | <code>Number</code> | 
| data | <code>Object</code> | 

<a name="_startEventWithTimerKey"></a>

## _startEventWithTimerKey(timerKey)
Create and save a time key

**Kind**: global function  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

<a name="_endEventWithTimerKey"></a>

## _endEventWithTimerKey(timerKey) ⇒ <code>Object</code>
Log event with the timer key

**Kind**: global function  
**Returns**: <code>Object</code> - with all timestamp details  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

## Functions

<dl>
<dt><a href="#constructor">constructor()</a> ⇒ <code>Object</code></dt>
<dd><p>Init method</p>
</dd>
<dt><a href="#sharedInstance">sharedInstance()</a> ⇒ <code>Object</code></dt>
<dd><p>Shared Instance singlton</p>
</dd>
<dt><a href="#setloggingOptions">setloggingOptions(loggingOptions)</a></dt>
<dd><p>Optional API to set parameters to log in analytics.</p>
</dd>
<dt><a href="#analyticsKitDidGetLog">analyticsKitDidGetLog(callback)</a></dt>
<dd><p>Used to receive any recorded data in real time.</p>
</dd>
<dt><a href="#_setNotifiers">_setNotifiers()</a></dt>
<dd><p>method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.</p>
</dd>
<dt><a href="#_shouldLogOption">_shouldLogOption(option)</a> ⇒ <code>Boolean</code></dt>
<dd><p>Used to check if log type sould be logged.</p>
</dd>
<dt><a href="#_recordTapOnShapeWithData">_recordTapOnShapeWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnIconWithData">_recordTapOnIconWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnXYWithData">_recordTapOnXYWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordLoadedMapCountWithData">_recordLoadedMapCountWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_startLoadFromServerEvent">_startLoadFromServerEvent(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endLoadFromServerEvent">_endLoadFromServerEvent(name, data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endRecordMapParsingWithKey">_endRecordMapParsingWithKey(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordWayfindPathWithValues">_recordWayfindPathWithValues(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_makeTimestampForData">_makeTimestampForData(data)</a> ⇒ <code>object</code></dt>
<dd><p>creates timestamp in data object</p>
</dd>
<dt><a href="#_recordCount">_recordCount(count, data)</a> ⇒ <code>Object</code></dt>
<dd><p>Helper method to record count and timestamp the event</p>
</dd>
<dt><a href="#_startEventWithTimerKey">_startEventWithTimerKey(timerKey)</a></dt>
<dd><p>Create and save a time key</p>
</dd>
<dt><a href="#_endEventWithTimerKey">_endEventWithTimerKey(timerKey)</a> ⇒ <code>Object</code></dt>
<dd><p>Log event with the timer key</p>
</dd>
</dl>

<a name="constructor"></a>

## constructor() ⇒ <code>Object</code>
Init method

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="sharedInstance"></a>

## sharedInstance() ⇒ <code>Object</code>
Shared Instance singlton

**Kind**: global function  
**Returns**: <code>Object</code> - AnalyticsKit  
<a name="setloggingOptions"></a>

## setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.

**Kind**: global function  

| Param | Type |
| --- | --- |
| loggingOptions | <code>Array</code> | 

<a name="analyticsKitDidGetLog"></a>

## analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| callback | <code>function</code> | a function that can accept JSON. |

<a name="_setNotifiers"></a>

## _setNotifiers()
method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.

**Kind**: global function  
<a name="_shouldLogOption"></a>

## _shouldLogOption(option) ⇒ <code>Boolean</code>
Used to check if log type sould be logged.

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| option | <code>String</code> | log option name |

<a name="_recordTapOnShapeWithData"></a>

## _recordTapOnShapeWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnIconWithData"></a>

## _recordTapOnIconWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordTapOnXYWithData"></a>

## _recordTapOnXYWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordLoadedMapCountWithData"></a>

## _recordLoadedMapCountWithData(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_startLoadFromServerEvent"></a>

## _startLoadFromServerEvent(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_endLoadFromServerEvent"></a>

## _endLoadFromServerEvent(name, data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| name | <code>String</code> | identifier |
| data | <code>object</code> | to parse |

<a name="_endRecordMapParsingWithKey"></a>

## _endRecordMapParsingWithKey(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_recordWayfindPathWithValues"></a>

## _recordWayfindPathWithValues(data)
helper method to parse and write to logs

**Kind**: global function  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>object</code> | to parse |

<a name="_makeTimestampForData"></a>

## _makeTimestampForData(data) ⇒ <code>object</code>
creates timestamp in data object

**Kind**: global function  
**Returns**: <code>object</code> - data  

| Param | Type | Description |
| --- | --- | --- |
| data | <code>Object</code> | to write |

<a name="_recordCount"></a>

## _recordCount(count, data) ⇒ <code>Object</code>
Helper method to record count and timestamp the event

**Kind**: global function  
**Returns**: <code>Object</code> - with count and timestamp  

| Param | Type |
| --- | --- |
| count | <code>Number</code> | 
| data | <code>Object</code> | 

<a name="_startEventWithTimerKey"></a>

## _startEventWithTimerKey(timerKey)
Create and save a time key

**Kind**: global function  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

<a name="_endEventWithTimerKey"></a>

## _endEventWithTimerKey(timerKey) ⇒ <code>Object</code>
Log event with the timer key

**Kind**: global function  
**Returns**: <code>Object</code> - with all timestamp details  

| Param | Type |
| --- | --- |
| timerKey | <code>String</code> | 

## Functions

<dl>
<dt><a href="#constructor">constructor()</a> ⇒ <code>Object</code></dt>
<dd><p>Init method</p>
</dd>
<dt><a href="#sharedInstance">sharedInstance()</a> ⇒ <code>Object</code></dt>
<dd><p>Shared Instance singlton</p>
</dd>
<dt><a href="#setloggingOptions">setloggingOptions(loggingOptions)</a></dt>
<dd><p>Optional API to set parameters to log in analytics.</p>
</dd>
<dt><a href="#analyticsKitDidGetLog">analyticsKitDidGetLog(callback)</a></dt>
<dd><p>Used to receive any recorded data in real time.</p>
</dd>
<dt><a href="#_setNotifiers">_setNotifiers()</a></dt>
<dd><p>method to registers all listeners to begin listening for notifiers
within the SDK and route to the appropriate method.
 This method should be called in the class init file.</p>
</dd>
<dt><a href="#_shouldLogOption">_shouldLogOption(option)</a> ⇒ <code>Boolean</code></dt>
<dd><p>Used to check if log type sould be logged.</p>
</dd>
<dt><a href="#_recordTapOnShapeWithData">_recordTapOnShapeWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnIconWithData">_recordTapOnIconWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordTapOnXYWithData">_recordTapOnXYWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_recordLoadedMapCountWithData">_recordLoadedMapCountWithData(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_startLoadFromServerEvent">_startLoadFromServerEvent(data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endLoadFromServerEvent">_endLoadFromServerEvent(name, data)</a></dt>
<dd><p>helper method to parse and write to logs</p>
</dd>
<dt><a href="#_endRecordMapParsin