Package com.segment.analytics.messages

Interface Message

All Known Implementing Classes:

AliasMessage, GroupMessage, IdentifyMessage, PageMessage, ScreenMessage, TrackMessage

public interface Message

Encapsulates properties common to all messages. Although not enforced by the compiler, either the anonymousId() or userId() must be provided.

For any functions that accept a map, such as integrations(), context(), TrackMessage.properties(), ScreenMessage.properties(), IdentifyMessage.traits(), or GroupMessage.traits(), we'll make an internal copy of the map provided. If you use Guava, we'll use it's ImmutableMap#copyOf methods instead.

There are a few limitations to be aware of when using Guava — mainly that null keys or values are not permitted and duplicate keys are not permitted. For more details, refer to Guava's Javadocs.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Message.Type

Method Summary

Modifier and Type	Method	Description
String	anonymousId()
Map<String,?>	context()
Map<String,Object>	integrations()
String	messageId()
Date	sentAt()
Date	timestamp()
Message.Type	type()
String	userId()

Method Details

type

@Nonnull
Message.Type type()

messageId

@Nonnull
String messageId()

sentAt

@Nullable
Date sentAt()

timestamp

@Nonnull
Date timestamp()

context

@Nullable
Map<String,?> context()

anonymousId

@Nullable
String anonymousId()

userId

@Nullable
String userId()

integrations

@Nullable
Map<String,Object> integrations()