
public final class PianoAnalytics

Singleton class used as a facade to the Piano Analytics

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`PianoAnalytics.EventProcessorCallback`
`public class`	`PianoAnalytics.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`visitorId`
`private String`	`customVisitorId`
`private final List<EventProcessor>`	`customEventProcessors`
`private PianoAnalytics.EventProcessorCallback`	`eventProcessorCallback`
`private final PrivacyModesStorage`	`privacyModesStorage`
`private final ContextPropertiesStorage`	`contextPropertiesStorage`
`private final UserStorage`	`userStorage`

Method Summary

Modifier and Type	Method	Description
`final String`	`getVisitorId()`	Current visitor id, depends on Configuration.visitorIDType
`final String`	`getCustomVisitorId()`	Custom visitor id, will be used if Configuration.visitorIDType is set to VisitorIDType.
`final Unit`	`setCustomVisitorId(String customVisitorId)`	Custom visitor id, will be used if Configuration.visitorIDType is set to VisitorIDType.
`final List<EventProcessor>`	`getCustomEventProcessors()`	List of custom event processors, which can change sending events.
`final PianoAnalytics.EventProcessorCallback`	`getEventProcessorCallback()`	Callback, which will be called after all events' processors and before sending event.
`final Unit`	`setEventProcessorCallback(PianoAnalytics.EventProcessorCallback eventProcessorCallback)`	Callback, which will be called after all events' processors and before sending event.
`final PrivacyModesStorage`	`getPrivacyModesStorage()`
`final ContextPropertiesStorage`	`getContextPropertiesStorage()`
`final UserStorage`	`getUserStorage()`
`final Unit`	`screenName(String name)`	Sets current screen name.
`final MediaHelper`	`mediaHelper(String contentId, String mediaSessionId)`	Returns a MediaHelper for sending AV Insights event
`final MediaHelper`	`mediaHelper(String contentId)`	Returns a MediaHelper for sending AV Insights event
`final Unit`	`sendEvents(Event events)`	Send events data
`final Unit`	`sendOfflineData()`	Send offline data stored on device
`final Unit`	`deleteOfflineStorage(Integer remaining)`	Delete offline data stored on device and keep only remaining days

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getVisitorId
```
 final String getVisitorId()
```
    Current visitor id, depends on Configuration.visitorIDType
  - getCustomVisitorId
```
 final String getCustomVisitorId()
```
    Custom visitor id, will be used if Configuration.visitorIDType is set to VisitorIDType.CUSTOM
  - setCustomVisitorId
```
 final Unit setCustomVisitorId(String customVisitorId)
```
    Custom visitor id, will be used if Configuration.visitorIDType is set to VisitorIDType.CUSTOM
  - getCustomEventProcessors
```
 final List<EventProcessor> getCustomEventProcessors()
```
    List of custom event processors, which can change sending events. Privacy rules will be applied after these event processors
  - getEventProcessorCallback
```
 final PianoAnalytics.EventProcessorCallback getEventProcessorCallback()
```
    Callback, which will be called after all events' processors and before sending event.
  - setEventProcessorCallback
```
 final Unit setEventProcessorCallback(PianoAnalytics.EventProcessorCallback eventProcessorCallback)
```
    Callback, which will be called after all events' processors and before sending event.
  - getPrivacyModesStorage
```
 final PrivacyModesStorage getPrivacyModesStorage()
```
  - getContextPropertiesStorage
```
 final ContextPropertiesStorage getContextPropertiesStorage()
```
  - getUserStorage
```
 final UserStorage getUserStorage()
```
  - screenName
```
 final Unit screenName(String name)
```
    Sets current screen name. It will be automatically added as property for event Event.PAGE_DISPLAY
    
    Parameters:
    
    name - screen name
  - mediaHelper
```
@JvmOverloads() final MediaHelper mediaHelper(String contentId, String mediaSessionId)
```
    Returns a MediaHelper for sending AV Insights event
    
    Parameters:
    
    contentId - Content id for AV Insights events.
    
    mediaSessionId - Session id for AV Insights events.
  - mediaHelper
```
@JvmOverloads() final MediaHelper mediaHelper(String contentId)
```
    Returns a MediaHelper for sending AV Insights event
    
    Parameters:
    
    contentId - Content id for AV Insights events.
  - sendEvents
```
 final Unit sendEvents(Event events)
```
    Send events data
    
    Parameters:
    
    events - a custom event list
  - sendOfflineData
```
 final Unit sendOfflineData()
```
    Send offline data stored on device
  - deleteOfflineStorage
```
 final Unit deleteOfflineStorage(Integer remaining)
```
    Delete offline data stored on device and keep only remaining days
    
    Parameters:
    
    remaining - age of data which have to be kept (in days)

Class PianoAnalytics

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getVisitorId

getCustomVisitorId

setCustomVisitorId

getCustomEventProcessors

getEventProcessorCallback

setEventProcessorCallback

getPrivacyModesStorage

getContextPropertiesStorage

getUserStorage

screenName

mediaHelper

mediaHelper

sendEvents

sendOfflineData

deleteOfflineStorage