com.snowplowanalytics.snowplow.event

Class DeepLinkReceived

java.lang.Object

com.snowplowanalytics.snowplow.event.AbstractEvent

com.snowplowanalytics.snowplow.event.AbstractSelfDescribing

com.snowplowanalytics.snowplow.event.DeepLinkReceived

All Implemented Interfaces:

Event

public class DeepLinkReceived
extends AbstractSelfDescribing

A deep-link received in the app.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_REFERRER
static String	PARAM_URL
String	referrer Referrer URL, source of this deep-link.
static String	SCHEMA
String	url URL in the received deep-link.

Fields inherited from class com.snowplowanalytics.snowplow.event.AbstractEvent

customContexts, trueTimestamp

Constructor Summary

Constructors

Constructor and Description
DeepLinkReceived(String url) Creates a deep-link received event.

Method Summary

Modifier and Type	Method and Description
static DeepLinkReceived	fromIntent(Intent intent) Convenient factory method that generates the event from the Intent received by the Activity.
static DeepLinkReceived	fromReferrerDetails(com.android.installreferrer.api.ReferrerDetails referrerDetails) Convenient factory method that generates the event from the ReferrerDetails generated by the Install Referrer Library.
Map<String,Object>	getDataPayload()
String	getSchema()
DeepLinkReceived	referrer(String referrer) Referrer URL, source of this deep-link.

Methods inherited from class com.snowplowanalytics.snowplow.event.AbstractEvent

beginProcessing, contexts, endProcessing, getContexts, getTrueTimestamp, trueTimestamp

Methods inherited from class java.lang.Object

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

Field Detail

SCHEMA

public static final String SCHEMA

See Also:

Constant Field Values

PARAM_REFERRER

public static final String PARAM_REFERRER

See Also:

Constant Field Values

PARAM_URL

public static final String PARAM_URL

See Also:

Constant Field Values

referrer

@Nullable
public String referrer

Referrer URL, source of this deep-link.

url

@NonNull
public final String url

URL in the received deep-link.

Constructor Detail

DeepLinkReceived

public DeepLinkReceived(@NonNull
                        String url)

Creates a deep-link received event.

Parameters:

url - URL in the received deep-link.

Method Detail

fromIntent

@Nullable
public static DeepLinkReceived fromIntent(@Nullable
                                                    Intent intent)

Convenient factory method that generates the event from the Intent received by the Activity. The Activity can store in the Intent the deep link url and the referrer url (if available).

Parameters:

intent - Intent received by the Activity.

Returns:

a new event.

fromReferrerDetails

@Nullable
public static DeepLinkReceived fromReferrerDetails(@Nullable
                                                             com.android.installreferrer.api.ReferrerDetails referrerDetails)

Convenient factory method that generates the event from the ReferrerDetails generated by the Install Referrer Library.

Parameters:

referrerDetails - Details received by the InstallReferrer.

Returns:

a new event.

referrer

@NonNull
public DeepLinkReceived referrer(@Nullable
                                          String referrer)

Referrer URL, source of this deep-link.

getDataPayload

@NonNull
public Map<String,Object> getDataPayload()

Returns:

the event data payload

getSchema

@NonNull
public String getSchema()

Specified by:

getSchema in class AbstractSelfDescribing

Returns:

The schema of the event.