ReviewCatalogEvent

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

SDK Version: 11.0.0 (SFMC SDK v3.1.0)

Platform: androidJvm

1class ReviewCatalogEvent : CatalogEvent

An event class used to capture when a user reviews a catalog object within the Salesforce Marketing Cloud ecosystem.

1Event (interface)
2    ↳ EngagementEvent (sealed class)
3        ↳ CatalogEvent (sealed class)
4            ↳ ReviewCatalogEvent (class)

ReviewCatalogEvent extends CatalogEvent and is specifically designed to track user review interactions with catalog objects. This event is part of the SFMC SDK’s comprehensive event tracking system for catalog-related user actions.

1val catalogObject: CatalogObject

Represents the catalog object associated with this event.

1open override val category: Event.Category

The Event category Name. Category contains list of allowed values.

1open override val priority: Priority

Read-only property indicating the priority of the event.

1fun attributes(): Map<String, Any>

Returns the Event attributes for this event.

Returns: Map<String, Any> - A map containing event attributes

1fun name(): String

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

Returns: String - The event name

1class CatalogObject @JvmOverloads constructor(
2    type: String,
3    id: String,
4    attributes: Map<String, Any> = mapOf(),
5    relatedCatalogObjects: Map<String, List<String>> = mapOf()
6)

Represents various items that can be tracked (e.g., a product, a blog post).

Properties:

• type (String) - A type name representing the catalog object
• id (String) - A unique id representing the catalog object
• attributes (Map<String, Any>) - A map of user-supplied values (default: empty map)
• relatedCatalogObjects (Map<String, List<String>>) - A map of related catalog objects (default: empty map)

The SDK provides several other catalog event types:

• ViewCatalogEvent - Capture when a user views a catalog object
• ViewCatalogDetailEvent - Capture when a user views the details of a catalog object
• QuickViewCatalogEvent - Capture when a user performs a quick view
• ShareCatalogEvent - Capture when a user shares a catalog object
• CommentCatalogEvent - Capture when a user comments on a catalog object
• FavoriteCatalogEvent - Capture when a user marks a catalog object as a favorite

Events are managed through the EventManager, which is initialized when SFMCSdk.configure is called. The EventManager handles event creation for each module.

• This class is part of the sealed CatalogEvent hierarchy, providing type safety for catalog-related events
• All catalog events require a CatalogObject instance to track the item being interacted with
• Event names should match those configured in the Marketing Cloud UI for proper tracking and analytics