com.segment.analytics.internal.AbstractIntegration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of analytics-core Show documentation

The hassle-free way to add analytics to your Android app.

There is a newer version: 3.4.0

package com.segment.analytics.internal;

import android.app.Activity;
import android.os.Bundle;
import com.segment.analytics.Analytics;
import com.segment.analytics.ValueMap;
import com.segment.analytics.internal.model.payloads.AliasPayload;
import com.segment.analytics.internal.model.payloads.GroupPayload;
import com.segment.analytics.internal.model.payloads.IdentifyPayload;
import com.segment.analytics.internal.model.payloads.ScreenPayload;
import com.segment.analytics.internal.model.payloads.TrackPayload;

/**
 * A base class for all bundled integrations.
 *
 * @param  The type of the backing instance. This isn't strictly necessary (since we return an
 * object), but serves as documentation for what type to expect with
 * {@link #getUnderlyingInstance()}.
 */
public abstract class AbstractIntegration {
  public static final String VIEWED_EVENT_FORMAT = "Viewed %s Screen";
  public static final String VIEWED_PRODUCT_CATEGORY = "Viewed Product Category";
  public static final String VIEWED_PRODUCT = "Viewed Product";
  public static final String ADDED_PRODUCT = "Added Product";
  public static final String COMPLETED_ORDER = "Completed Order";

  /**
   * Initialize the integration. Implementations should wrap any errors, including missing settings
   * and permission in {@link IllegalStateException}. If this method call completes without an
   * error, the integration is assumed to be initialized and ready to except events.
   */
  public abstract void initialize(Analytics analytics, ValueMap settings)
      throws IllegalStateException;

  /**
   * The underlying instance for this provider - used for integration specific actions. This will
   * return {@code null} for SDK's that maintain a shared instance (e.g. Amplitude).
   */
  public T getUnderlyingInstance() {
    return null;
  }

  /** A key to identify this integration, matching the one in the Segment Public API. */
  public abstract String key();

  // Application Callbacks, same as Application$ActivityLifecycleCallbacks
  public void onActivityCreated(Activity activity, Bundle savedInstanceState) {

  }

  public void onActivityStarted(Activity activity) {

  }

  public void onActivityResumed(Activity activity) {
  }

  public void onActivityPaused(Activity activity) {
  }

  public void onActivityStopped(Activity activity) {
  }

  public void onActivitySaveInstanceState(Activity activity, Bundle outState) {
  }

  public void onActivityDestroyed(Activity activity) {
  }

  // Analytics Actions
  public void identify(IdentifyPayload identify) {
  }

  public void group(GroupPayload group) {
  }

  public void track(TrackPayload track) {
  }

  public void alias(AliasPayload alias) {
  }

  public void screen(ScreenPayload screen) {
  }

  public void flush() {
  }

  public void reset() {
  }
}