Event

Package: com.salesforce.marketingcloud.sfmcsdk.components.events

Platform: androidJvm

SDK Version: 11.0.0

An abstract base class representing events in the Salesforce Marketing Cloud Unified SDK. This class provides the foundation for tracking and managing events within the SDK.

Known Subclasses:

  • EngagementEvent

Default constructor for creating an Event instance.

Unique identifier for the event.

The Event category name. See Category enum for allowed values.

The Event producer name. See Producer enum for allowed values.

Returns: The event name as a String

Description: The name for the event. This value must match the Event Name used when creating the event in the Marketing Cloud UI.

Returns: A map of attribute key-value pairs

Description: The Event attributes for this event.

Returns: A JSONObject representation of the event

Description: Converts the event to JSON format.

Description: Method to track this Event via EventManager to subscriber EventSubscriber.

List of possible Category values for sending Events.

ConstantDescription
APPLICATIONCategory for application-related events
ENGAGEMENTCategory for engagement-related events
IDENTITYCategory for identity-related events
SYSTEMCategory for system-related events
BILLINGCategory for billing-related events
CUSTOMCategory for custom events
  • entries: EnumEntries<Event.Category> - Returns an immutable list representation of all enum entries in declaration order
  • valueOf(value: String): Event.Category - Returns the enum constant matching the specified name
  • values(): Array<Event.Category> - Returns an array containing all enum constants in declaration order

List of possible Producer values for sending Events.

ConstantDescription
CUSTOMER_APPApplication-level producer
UNIFIED_SDKUnified SDK producer
MCE_MODULEMCE module producer
DC_MODULEDC module producer
MAM_MODULEMAM module producer
PUSH_FEATURE_MODULEPush feature module producer
IAM_FEATURE_MODULEIAM feature module producer
  • entries: EnumEntries<Event.Producer> - Returns an immutable list representation of all enum entries in declaration order
  • valueOf(value: String): Event.Producer - Returns the enum constant matching the specified name
  • values(): Array<Event.Producer> - Returns an array containing all enum constants in declaration order