public abstract class BasePayload extends ValueMap
Modifier and Type | Class and Description |
---|---|
static class |
BasePayload.Builder<P extends BasePayload,B extends BasePayload.Builder> |
static class |
BasePayload.Channel
The channel where the request originated from: server, browser or mobile.
|
static class |
BasePayload.Type |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
anonymousId()
The anonymous ID is an identifier that uniquely (or close enough) identifies the user, but
isn't from your database.
|
AnalyticsContext |
context()
The context is a dictionary of extra information that provides useful context about a message,
for example ip address or locale.
|
ValueMap |
integrations()
A dictionary of integration names that the message should be proxied to.
|
java.lang.String |
messageId()
A randomly generated unique id for this message.
|
BasePayload |
putValue(java.lang.String key,
java.lang.Object value)
Helper method to be able to chain put methods.
|
java.util.Date |
timestamp()
Set a timestamp the event occurred.
|
abstract BasePayload.Builder |
toBuilder() |
BasePayload.Type |
type()
The type of message.
|
java.lang.String |
userId()
The user ID is an identifier that unique identifies the user in your database.
|
clear, containsKey, containsValue, entrySet, equals, get, getBoolean, getChar, getDouble, getEnum, getFloat, getInt, getList, getLong, getString, getValueMap, getValueMap, hashCode, isEmpty, keySet, put, putAll, remove, size, toJsonObject, toString, toStringMap, values
public BasePayload.Type type()
public java.lang.String userId()
public java.lang.String anonymousId()
public java.lang.String messageId()
public java.util.Date timestamp()
This library will automatically create and attach a timestamp to all events.
public ValueMap integrations()
public AnalyticsContext context()
public BasePayload putValue(java.lang.String key, java.lang.Object value)
ValueMap
public abstract BasePayload.Builder toBuilder()