com.segment.analytics.internal

Class AbstractIntegration<T>

java.lang.Object

com.segment.analytics.internal.AbstractIntegration<T>

Type Parameters:

T - 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 getUnderlyingInstance().

public abstract class AbstractIntegration<T>
extends java.lang.Object

A base class for all bundled integrations.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADDED_PRODUCT
static java.lang.String	COMPLETED_ORDER
static java.lang.String	VIEWED_EVENT_FORMAT
static java.lang.String	VIEWED_PRODUCT
static java.lang.String	VIEWED_PRODUCT_CATEGORY

Constructor Summary

Constructors

Constructor and Description
AbstractIntegration()

Method Summary

Modifier and Type	Method and Description
void	alias(AliasPayload alias)
void	flush()
T	getUnderlyingInstance() The underlying instance for this provider - used for integration specific actions.
void	group(GroupPayload group)
void	identify(IdentifyPayload identify)
abstract void	initialize(Analytics analytics, ValueMap settings) Initialize the integration.
abstract java.lang.String	key() A key to identify this integration, matching the one in the Segment Public API.
void	onActivityCreated(android.app.Activity activity, android.os.Bundle savedInstanceState)
void	onActivityDestroyed(android.app.Activity activity)
void	onActivityPaused(android.app.Activity activity)
void	onActivityResumed(android.app.Activity activity)
void	onActivitySaveInstanceState(android.app.Activity activity, android.os.Bundle outState)
void	onActivityStarted(android.app.Activity activity)
void	onActivityStopped(android.app.Activity activity)
void	reset()
void	screen(ScreenPayload screen)
void	track(TrackPayload track)

Methods inherited from class java.lang.Object

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

Field Detail

VIEWED_EVENT_FORMAT

public static final java.lang.String VIEWED_EVENT_FORMAT

See Also:

Constant Field Values

VIEWED_PRODUCT_CATEGORY

public static final java.lang.String VIEWED_PRODUCT_CATEGORY

See Also:

Constant Field Values

VIEWED_PRODUCT

public static final java.lang.String VIEWED_PRODUCT

See Also:

Constant Field Values

ADDED_PRODUCT

public static final java.lang.String ADDED_PRODUCT

See Also:

Constant Field Values

COMPLETED_ORDER

public static final java.lang.String COMPLETED_ORDER

See Also:

Constant Field Values

Constructor Detail

AbstractIntegration

public AbstractIntegration()

Method Detail

initialize

public abstract void initialize(Analytics analytics,
                                ValueMap settings)
                         throws java.lang.IllegalStateException

Initialize the integration. Implementations should wrap any errors, including missing settings and permission in IllegalStateException. If this method call completes without an error, the integration is assumed to be initialized and ready to except events.

Throws:

java.lang.IllegalStateException

getUnderlyingInstance

public T getUnderlyingInstance()

The underlying instance for this provider - used for integration specific actions. This will return null for SDK's that maintain a shared instance (e.g. Amplitude).

key

public abstract java.lang.String key()

A key to identify this integration, matching the one in the Segment Public API.

onActivityCreated

public void onActivityCreated(android.app.Activity activity,
                              android.os.Bundle savedInstanceState)

onActivityStarted

public void onActivityStarted(android.app.Activity activity)

onActivityResumed

public void onActivityResumed(android.app.Activity activity)

onActivityPaused

public void onActivityPaused(android.app.Activity activity)

onActivityStopped

public void onActivityStopped(android.app.Activity activity)

onActivitySaveInstanceState

public void onActivitySaveInstanceState(android.app.Activity activity,
                                        android.os.Bundle outState)

onActivityDestroyed

public void onActivityDestroyed(android.app.Activity activity)

identify

public void identify(IdentifyPayload identify)

group

public void group(GroupPayload group)

track

public void track(TrackPayload track)

alias

public void alias(AliasPayload alias)

screen

public void screen(ScreenPayload screen)

flush

public void flush()

reset

public void reset()