SFMC SDK/com.salesforce.marketingcloud.sfmcsdk.components.events

Package-level declarations

Types

AddToCartEvent

class AddToCartEvent : CartEvent

An E-commerce event for when a user adds a item to their shopping cart.

CancelOrderEvent

class CancelOrderEvent : OrderEvent

An E-commerce event for when a user cancels an order.

CartEvent

sealed class CartEvent : EngagementEvent

CatalogEvent

sealed class CatalogEvent : EngagementEvent

CatalogObject

class CatalogObject @JvmOverloads constructor(val type: String, val id: String, val attributes: Map<String, Any> = mapOf(), val relatedCatalogObjects: Map<String, List<String>> = mapOf())

A catalog object that represents various items that can be tracked. For example, a product, a blog post, and so on.

CommentCatalogEvent

class CommentCatalogEvent : CatalogEvent

An event to capture when a user comments on a catalog object.

DeliverOrderEvent

class DeliverOrderEvent : OrderEvent

An E-commerce event to manage details of an order delivery.

EngagementEvent

sealed class EngagementEvent : Event

Event

abstract class Event

EventManager

class EventManager

Class which helps in creating a EventManager for each module . This is initialised when SFMCSdk.configure is called

ExchangeOrderEvent

class ExchangeOrderEvent : OrderEvent

An E-commerce event to manage details of exchanging an order.

FavoriteCatalogEvent

class FavoriteCatalogEvent : CatalogEvent

An event to capture when a user marks a catalog object as a favorite.

LineItem

data class LineItem @JvmOverloads constructor(val catalogObjectType: String, val catalogObjectId: String, val quantity: Int, var price: Double? = null, var currency: String? = null, var attributes: Map<String, Any> = mapOf())

Line items are intended to describe purchasable items for Cart & Order events.

Order

data class Order @JvmOverloads constructor(val id: String, val lineItems: List<LineItem> = listOf(), val totalValue: Double? = null, val currency: String? = null, val attributes: Map<String, Any> = mapOf())

OrderEvent

sealed class OrderEvent : EngagementEvent

PreorderEvent

class PreorderEvent : OrderEvent

An E-commerce event for when a user places a preorder.

PurchaseOrderEvent

class PurchaseOrderEvent : OrderEvent

An E-commerce event for when a user makes a purchase.

QuickViewCatalogEvent

class QuickViewCatalogEvent : CatalogEvent

An event to capture when a user performs a quick view of a catalog object.

RemoveFromCartEvent