Security News
PyPI Now Supports iOS and Android Wheels for Mobile Python Development
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.
By Sarah Gooding - Feb 12, 2025
New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
@jibestream-dev/jmap-analytics-kit
Advanced tools
AnalyticsKit
Jibestream plugin for using Analytics
Documentation
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
Functions
- constructor() ⇒
Object Init method
- sharedInstance() ⇒
Object Shared Instance singlton
- setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
- analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
- _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.
- _shouldLogOption(option) ⇒
Boolean Used to check if log type sould be logged.
- _recordTapOnShapeWithData(data)
helper method to parse and write to logs
- _recordTapOnIconWithData(data)
helper method to parse and write to logs
- _recordTapOnXYWithData(data)
helper method to parse and write to logs
- _recordLoadedMapCountWithData(data)
helper method to parse and write to logs
- _startLoadFromServerEvent(data)
helper method to parse and write to logs
- _endLoadFromServerEvent(name, data)
helper method to parse and write to logs
- _endRecordMapParsingWithKey(data)
helper method to parse and write to logs
- _recordWayfindPathWithValues(data)
helper method to parse and write to logs
- _makeTimestampForData(data) ⇒
object creates timestamp in data object
- _recordCount(count, data) ⇒
Object Helper method to record count and timestamp the event
- _startEventWithTimerKey(timerKey)
Create and save a time key
- _endEventWithTimerKey(timerKey) ⇒
Object Log event with the timer key
constructor() ⇒ Object
Init method
Kind: global function
Returns: Object - AnalyticsKit
sharedInstance() ⇒ Object
Shared Instance singlton
Kind: global function
Returns: Object - AnalyticsKit
setloggingOptions(loggingOptions)
Optional API to set parameters to log in analytics.
Kind: global function
| Param | Type |
|---|---|
| loggingOptions | Array |
analyticsKitDidGetLog(callback)
Used to receive any recorded data in real time.
Kind: global function
| Param | Type | Description |
|---|---|---|
| callback | function | a function that can accept JSON. |
_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.
_shouldLogOption(option) ⇒ Boolean
Used to check if log type sould be logged.
Kind: global function
| Param | Type | Description |
|---|---|---|
| option | String | log option name |
_recordTapOnShapeWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnIconWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordTapOnXYWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordLoadedMapCountWithData(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_startLoadFromServerEvent(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_endLoadFromServerEvent(name, data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| name | String | identifier |
| data | object | to parse |
_endRecordMapParsingWithKey(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_recordWayfindPathWithValues(data)
helper method to parse and write to logs
Kind: global function
| Param | Type | Description |
|---|---|---|
| data | object | to parse |
_makeTimestampForData(data) ⇒ object
creates timestamp in data object
Kind: global function
Returns: object - data
| Param | Type | Description |
|---|---|---|
| data | Object | to write |
_recordCount(count, data) ⇒ Object
Helper method to record count and timestamp the event
Kind: global function
Returns: Object - with count and timestamp
| Param | Type |
|---|---|
| count | Number |
| data | Object |
_startEventWithTimerKey(timerKey)
Create and save a time key
Kind: global function
| Param | Type |
|---|---|
| timerKey | String |
_endEventWithTimerKey(timerKey) ⇒ Object
Log event with the timer key
Kind: global function
Returns: Object - with all timestamp details
| Param | Type |
|---|---|
| timerKey | String |
FAQs
Jibestream plugin for using Analytics
We found that @jibestream-dev/jmap-analytics-kit demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 11 open source maintainers collaborating on the project.
Package last updated on 18 Jul 2017
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Related posts
Security News
Create React App Officially Deprecated Amid React 19 Compatibility Issues
Create React App is officially deprecated due to React 19 issues and lack of maintenance—developers should switch to Vite or other modern alternatives.
By Sarah Gooding - Feb 11, 2025
Security News
Oracle Drags Its Feet in the JavaScript Trademark Dispute
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
By Sarah Gooding - Feb 07, 2025