README
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
Object
constructor() ⇒ Init method
Kind: global function
Returns: Object
- AnalyticsKit
Object
sharedInstance() ⇒ 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.
Boolean
_shouldLogOption(option) ⇒ 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 |
object
_makeTimestampForData(data) ⇒ creates timestamp in data object
Kind: global function
Returns: object
- data
Param | Type | Description |
---|---|---|
data | Object |
to write |
Object
_recordCount(count, data) ⇒ 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 |
Object
_endEventWithTimerKey(timerKey) ⇒ 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
Object
constructor() ⇒ Init method
Kind: global function
Returns: Object
- AnalyticsKit
Object
sharedInstance() ⇒ 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.
Boolean
_shouldLogOption(option) ⇒ 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 |
object
_makeTimestampForData(data) ⇒ creates timestamp in data object
Kind: global function
Returns: object
- data
Param | Type | Description |
---|---|---|
data | Object |
to write |
Object
_recordCount(count, data) ⇒ 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 |
Object
_endEventWithTimerKey(timerKey) ⇒ 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
Object
constructor() ⇒ Init method
Kind: global function
Returns: Object
- AnalyticsKit
Object
sharedInstance() ⇒ 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.
Boolean
_shouldLogOption(option) ⇒ 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 |
object
_makeTimestampForData(data) ⇒ creates timestamp in data object
Kind: global function
Returns: object
- data
Param | Type | Description |
---|---|---|
data | Object |
to write |
Object
_recordCount(count, data) ⇒ 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 |
Object
_endEventWithTimerKey(timerKey) ⇒ 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
Object
constructor() ⇒ Init method
Kind: global function
Returns: Object
- AnalyticsKit
Object
sharedInstance() ⇒ 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.
Boolean
_shouldLogOption(option) ⇒ 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 |
object
_makeTimestampForData(data) ⇒ creates timestamp in data object
Kind: global function
Returns: object
- data
Param | Type | Description |
---|---|---|
data | Object |
to write |
Object
_recordCount(count, data) ⇒ 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 |
Object
_endEventWithTimerKey(timerKey) ⇒ 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
Object
constructor() ⇒ Init method
Kind: global function
Returns: Object
- AnalyticsKit
Object
sharedInstance() ⇒ 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.
Boolean
_shouldLogOption(option) ⇒ 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 |
object
_makeTimestampForData(data) ⇒ creates timestamp in data object
Kind: global function
Returns: object
- data
Param | Type | Description |
---|---|---|
data | Object |
to write |
Object
_recordCount(count, data) ⇒ 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 |
Object
_endEventWithTimerKey(timerKey) ⇒ 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
Object
constructor() ⇒ Init method
Kind: global function
Returns: Object
- AnalyticsKit
Object
sharedInstance() ⇒ 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.
Boolean
_shouldLogOption(option) ⇒ 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 |
object
_makeTimestampForData(data) ⇒ creates timestamp in data object
Kind: global function
Returns: object
- data
Param | Type | Description |
---|---|---|
data | Object |
to write |
Object
_recordCount(count, data) ⇒ 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 |
Object
_endEventWithTimerKey(timerKey) ⇒ 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
Object
constructor() ⇒ Init method
Kind: global function
Returns: Object
- AnalyticsKit
Object
sharedInstance() ⇒ 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.
Boolean
_shouldLogOption(option) ⇒ 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 |
object
_makeTimestampForData(data) ⇒ creates timestamp in data object
Kind: global function
Returns: object
- data
Param | Type | Description |
---|---|---|
data | Object |
to write |
Object
_recordCount(count, data) ⇒ 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 |
Object
_endEventWithTimerKey(timerKey) ⇒ 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
Object
constructor() ⇒ Init method
Kind: global function
Returns: Object
- AnalyticsKit
Object
sharedInstance() ⇒ 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.
Boolean
_shouldLogOption(option) ⇒ 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 |
object
_makeTimestampForData(data) ⇒ creates timestamp in data object
Kind: global function
Returns: object
- data
Param | Type | Description |
---|---|---|
data | Object |
to write |
Object
_recordCount(count, data) ⇒ 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 |
Object
_endEventWithTimerKey(timerKey) ⇒ 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
Object
constructor() ⇒ Init method
Kind: global function
Returns: Object
- AnalyticsKit
Object
sharedInstance() ⇒ 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.
Boolean
_shouldLogOption(option) ⇒ 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 |
object
_makeTimestampForData(data) ⇒ creates timestamp in data object
Kind: global function
Returns: object
- data
Param | Type | Description |
---|---|---|
data | Object |
to write |
Object
_recordCount(count, data) ⇒ 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 |
Object
_endEventWithTimerKey(timerKey) ⇒ 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
- Details
- Downloads (weekly)
- Updated
- Created
- License
- None
- Dependencies
- 0
- Collaborators