Package com.mparticle

Class BaseEvent

java.lang.Object

com.mparticle.BaseEvent

Direct Known Subclasses:

CommerceEvent, MPEvent

public class BaseEvent
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	BaseEvent.MessageType
static class	BaseEvent.Type

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseEvent(BaseEvent.MessageType type)

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.String>	getCustomAttributes()	Retrieve the Map of custom attributes of the event.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getCustomFlags()	Retrieve the custom flags set on this event.
com.mparticle.internal.messages.BaseMPMessageBuilder	getMessage()
BaseEvent.MessageType	getType()
boolean	isShouldUploadEvent()
void	setCustomAttributes(java.util.Map<java.lang.String,java.lang.String> customAttributes)
protected void	setCustomFlags(java.util.Map<java.lang.String,java.util.List<java.lang.String>> flags)
protected void	setShouldUploadEvent(boolean shouldUploadEvent)
protected void	setType(BaseEvent.MessageType type)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseEvent

protected BaseEvent(BaseEvent.MessageType type)

Method Detail

getType

@NonNull
public BaseEvent.MessageType getType()

setType

protected void setType(BaseEvent.MessageType type)

isShouldUploadEvent

public boolean isShouldUploadEvent()

setShouldUploadEvent

protected void setShouldUploadEvent(boolean shouldUploadEvent)

getCustomFlags

@Nullable
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getCustomFlags()

Retrieve the custom flags set on this event. Custom Flags are used to send data or trigger behavior to individual 3rd-party services that you have enabled for your app. By default, flags are not forwarded to any providers.

Returns:

returns the map of custom flags, or null if none are set

setCustomFlags

protected void setCustomFlags(@Nullable
                              java.util.Map<java.lang.String,java.util.List<java.lang.String>> flags)

getCustomAttributes

@Nullable
public java.util.Map<java.lang.String,java.lang.String> getCustomAttributes()

Retrieve the Map of custom attributes of the event.

Returns:

returns a Map of custom attributes, or null if no custom attributes are set.

setCustomAttributes

public void setCustomAttributes(@Nullable
                                java.util.Map<java.lang.String,java.lang.String> customAttributes)

getMessage

public com.mparticle.internal.messages.BaseMPMessageBuilder getMessage()