QuickViewCatalogEvent

Overview 

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

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

Platform: androidJvm

SDK Version: SFMC SDK v3.1.0 (API 11.0.0)

Class Declaration 

1class QuickViewCatalogEvent : CatalogEvent

Inheritance Hierarchy 

1Event (abstract)
2  └─ EngagementEvent (sealed)
3      └─ CatalogEvent (sealed)
4          └─ QuickViewCatalogEvent (class)

Description 

QuickViewCatalogEvent is a concrete implementation of CatalogEvent used to track when a user performs a quick view action on a catalog object within your application. This event is part of the Salesforce Marketing Cloud SDK’s engagement tracking system for catalog-related user interactions.

Inherited Properties 

From CatalogEvent:

catalogObject 

1val catalogObject: CatalogObject

Represents the catalog object associated with this event.

From EngagementEvent:

category 

1open override var category: Event.Category

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

priority 

1open override val priority: Priority

Defines the priority level for the engagement event.

Inherited Methods 

From EngagementEvent:

name() 

1open override fun name(): String

The name for the event. This value must match the Event Name used when creating the event in the Marketing Cloud UI for any action to result from tracking this event.

Returns: The event name as a String.

attributes() 

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

The Event attributes for this event.

Returns: A map containing attribute key-value pairs for the event.

Related Types 

CatalogObject 

The CatalogObject class represents various items that can be tracked (e.g., a product, a blog post).

Constructor:

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

Parameters:

  • 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 (optional, defaults to empty map)
  • relatedCatalogObjects: Map<String, List> - A map of related catalog objects (optional, defaults to empty map)

Sibling Event Types 

Other CatalogEvent implementations include:

  • ViewCatalogEvent - Captures when a user views a catalog object
  • ViewCatalogDetailEvent - Captures when a user views catalog object details
  • ShareCatalogEvent - Captures when a user shares a catalog object
  • ReviewCatalogEvent - Captures when a user reviews a catalog object
  • CommentCatalogEvent - Captures when a user comments on a catalog object
  • FavoriteCatalogEvent - Captures when a user favorites a catalog object

Notes 

  • As a subclass of the sealed CatalogEvent class, QuickViewCatalogEvent provides type-safe event tracking
  • The event name returned by name() must match the Event Name configured in the Marketing Cloud UI for proper event handling

See Also