com.snowplowanalytics.snowplow.event

Class ScreenView

java.lang.Object

com.snowplowanalytics.snowplow.event.AbstractEvent

com.snowplowanalytics.snowplow.event.AbstractSelfDescribing

com.snowplowanalytics.snowplow.event.ScreenView

All Implemented Interfaces:

Event

public class ScreenView
extends AbstractSelfDescribing

A ScreenView event.

Field Summary

Fields

Modifier and Type	Field and Description
String	activityClassName Name of the Activity subclass.
String	activityTag Tag of the Activity subclass.
String	fragmentClassName Name of the Fragment subclass.
String	fragmentTag Tag of the Fragment subclass.
String	id Identifier of the screen.
String	name Name of the screen.
String	previousId Identifier of the previous screen.
String	previousName Name of the previous screen.
String	previousType Type of the previous screen.
String	transitionType Type of transition between previous and current screen.
String	type Type of screen.

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

customContexts, trueTimestamp

Constructor Summary

Constructors

Constructor and Description
ScreenView(String name) Creates a ScreenView event.
ScreenView(String name, UUID screenId) Creates a ScreenView event.

Method Summary

Modifier and Type	Method and Description
ScreenView	activityClassName(String activityClassName) Name of the Activity subclass.
ScreenView	activityTag(String activityTag) Tag of the Activity subclass.
static ScreenView	buildWithActivity(Activity activity) Creates a ScreenView event using the data of an Activity class.
static ScreenView	buildWithFragment(Fragment fragment) Creates a ScreenView event using the data of an Fragment class.
ScreenView	fragmentClassName(String fragmentClassName) Name of the Fragment subclass.
ScreenView	fragmentTag(String fragmentTag) Tag of the Fragment subclass.
Map<String,Object>	getDataPayload()
String	getSchema()
ScreenView	previousId(String previousId) Identifier of the previous screen.
ScreenView	previousName(String previousName) Name of the previous screen.
ScreenView	previousType(String previousType) Type of the previous screen.
ScreenView	transitionType(String transitionType) Type of transition between previous and current screen.
ScreenView	type(String type) Type of screen.

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

name

@NonNull
public final String name

Name of the screen.

id

@NonNull
public final String id

Identifier of the screen.

type

@Nullable
public String type

Type of screen.

previousName

@Nullable
public String previousName

Name of the previous screen.

previousId

@Nullable
public String previousId

Identifier of the previous screen.

previousType

@Nullable
public String previousType

Type of the previous screen.

transitionType

@Nullable
public String transitionType

Type of transition between previous and current screen.

fragmentClassName

@Nullable
public String fragmentClassName

Name of the Fragment subclass.

fragmentTag

@Nullable
public String fragmentTag

Tag of the Fragment subclass.

activityClassName

@Nullable
public String activityClassName

Name of the Activity subclass.

activityTag

@Nullable
public String activityTag

Tag of the Activity subclass.

Constructor Detail

ScreenView

public ScreenView(@NonNull
                  String name)

Creates a ScreenView event.

Parameters:

name - Name of the screen.

ScreenView

public ScreenView(@NonNull
                  String name,
                  @Nullable
                  UUID screenId)

Creates a ScreenView event.

Parameters:

name - Name of the screen.

screenId - Identifier of the screen.

Method Detail

buildWithActivity

@NonNull
public static ScreenView buildWithActivity(@NonNull
                                                    Activity activity)

Creates a ScreenView event using the data of an Activity class.

buildWithFragment

@NonNull
public static ScreenView buildWithFragment(@NonNull
                                                    Fragment fragment)

Creates a ScreenView event using the data of an Fragment class.

type

@NonNull
public ScreenView type(@Nullable
                                String type)

Type of screen.

previousName

@NonNull
public ScreenView previousName(@Nullable
                                        String previousName)

Name of the previous screen.

previousId

@NonNull
public ScreenView previousId(@Nullable
                                      String previousId)

Identifier of the previous screen.

previousType

@NonNull
public ScreenView previousType(@Nullable
                                        String previousType)

Type of the previous screen.

transitionType

@NonNull
public ScreenView transitionType(@Nullable
                                          String transitionType)

Type of transition between previous and current screen.

fragmentClassName

@NonNull
public ScreenView fragmentClassName(@Nullable
                                             String fragmentClassName)

Name of the Fragment subclass.

fragmentTag

@NonNull
public ScreenView fragmentTag(@Nullable
                                       String fragmentTag)

Tag of the Fragment subclass.

activityClassName

@NonNull
public ScreenView activityClassName(@Nullable
                                             String activityClassName)

Name of the Activity subclass.

activityTag

@NonNull
public ScreenView activityTag(@Nullable
                                       String activityTag)

Tag of the Activity subclass.

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.