Package com.adobe.marketing.mobile

Class Analytics

  • All Implemented Interfaces:
    
public class Analytics

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description
      public final static Class<out Extension> EXTENSION

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      static String extensionVersion() Returns the version for the Analytics extension
      static void getTrackingIdentifier(@NonNull() AdobeCallback<String> callback) Retrieves the analytics tracking identifier generated for this app/device instance.
      static void getQueueSize(@NonNull() AdobeCallback<Long> callback) Retrieves the total number of analytics hits currently in the tracking queue.
      static void clearQueue() Clears all unsent analytics hits from the tracking queue.
      static void sendQueuedHits() Forces analytics to send all queued hits regardless of current batch options.
      static void getVisitorIdentifier(@NonNull() AdobeCallback<String> callback) Retrieves the visitor identifier
      static void setVisitorIdentifier(@Nullable() String visitorID) Sets the visitor identifier.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • getTrackingIdentifier

         static void getTrackingIdentifier(@NonNull() AdobeCallback<String> callback)

        Retrieves the analytics tracking identifier generated for this app/device instance.

        Parameters:
        callback - AdobeCallback invoked with the analytics identifier String value; when an AdobeCallbackWithError is provided, an AdobeError can be returned in the eventuality of an unexpected error or if the default timeout (5000ms) is met before the callback is returned with analytics tracking identifier.

      • getQueueSize

         static void getQueueSize(@NonNull() AdobeCallback<Long> callback)

        Retrieves the total number of analytics hits currently in the tracking queue.

        Parameters:
        callback - AdobeCallback invoked with the queue size long value; when an AdobeCallbackWithError is provided, an AdobeError can be returned in the eventuality of an unexpected error or if the default timeout (5000ms) is met before the callback is returned with queue size.

      • clearQueue

         static void clearQueue()

        Clears all unsent analytics hits from the tracking queue.

        NOTE: Use caution when clearing the queue manually. This process cannot be reversed.

      • sendQueuedHits

         static void sendQueuedHits()

        Forces analytics to send all queued hits regardless of current batch options.

      • getVisitorIdentifier

         static void getVisitorIdentifier(@NonNull() AdobeCallback<String> callback)

        Retrieves the visitor identifier

        Parameters:
        callback - AdobeCallback invoked with the visitor identifier String value; when an AdobeCallbackWithError is provided, an AdobeError can be returned in the eventuality of an unexpected error or if the default timeout (5000ms) is met before the callback is returned with visitor identifier.

      • setVisitorIdentifier

         static void setVisitorIdentifier(@Nullable() String visitorID)

        Sets the visitor identifier. Clears the visitor identifier when passed null or an empty string.

        Parameters:
        visitorID - String new value for visitor identifier