Package 

Interface AnalyticsManager


  • 
    public interface AnalyticsManager
    
                        

    Defines the contract for an analytics manager responsible for logging screen view events. Implementations of this interface will typically dispatch events to one or more AnalyticsProviders.

    • Method Summary

      Modifier and Type Method Description
      abstract Unit logScreenView(String screenName, String screenClass, Map<String, Object> parameters) Logs a screen view event.
      abstract Unit logEvent(String eventName, Map<String, Object> parameters, Boolean includeGlobalParameters) Logs a custom event.
      abstract Unit release() Releases any resources held by the analytics manager.
      abstract Unit setGlobalParameters(Map<String, Object> parameters) Sets global parameters that will be included with all subsequent analytics events.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • logScreenView

         abstract Unit logScreenView(String screenName, String screenClass, Map<String, Object> parameters)

        Logs a screen view event.

        Parameters:
        screenName - The name of the screen being viewed (e.g., "Home Screen", "Product Detail").
        screenClass - The class name associated with the screen (e.g., "MainActivity", "ProductFragment").
        parameters - An optional map of additional key-value pairs to be sent with the event.
      • logEvent

         abstract Unit logEvent(String eventName, Map<String, Object> parameters, Boolean includeGlobalParameters)

        Logs a custom event.

        Parameters:
        eventName - The name of the event to log.
        parameters - A map of key-value pairs representing the event parameters.
      • release

         abstract Unit release()

        Releases any resources held by the analytics manager. This should be called when the application is no longer needing analytics, e.g., on application shutdown.

      • setGlobalParameters

         abstract Unit setGlobalParameters(Map<String, Object> parameters)

        Sets global parameters that will be included with all subsequent analytics events. These parameters are merged with event-specific parameters, with event-specific parameters taking precedence in case of key conflicts.

        Parameters:
        parameters - A map of key-value pairs representing the global parameters.