Airship Android SDK

urbanairship-core/com.urbanairship.analytics/RetailEventTemplate

RetailEventTemplate

open class RetailEventTemplate

A class that represents a custom retail event template for the application.

Properties

ADDED_TO_CART_EVENT

val ADDED_TO_CART_EVENT: String = "added_to_cart"

The added_to_cart event name.

BROWSED_PRODUCT_EVENT

val BROWSED_PRODUCT_EVENT: String = "browsed"

The browsed event name.

PURCHASED_EVENT

val PURCHASED_EVENT: String = "purchased"

The purchased event name.

RETAIL_EVENT_TEMPLATE

val RETAIL_EVENT_TEMPLATE: String = "retail"

The retail event template type.

SHARED_PRODUCT_EVENT

val SHARED_PRODUCT_EVENT: String = "shared_product"

The shared_product event name.

STARRED_PRODUCT_EVENT

val STARRED_PRODUCT_EVENT: String = "starred_product"

The starred_product event name.

val WISHLIST_EVENT: String = "wishlist"

The wishlist event name.

Functions

open fun createEvent(): CustomEvent

Creates the custom retail event.

newAddedToCartTemplate

open fun newAddedToCartTemplate(): RetailEventTemplate

Creates an added to cart event template.

newBrowsedTemplate

open fun newBrowsedTemplate(): RetailEventTemplate

Creates a browsed event template.

newPurchasedTemplate

open fun newPurchasedTemplate(): RetailEventTemplate

Creates a purchased event template.

newSharedProductTemplate

open fun newSharedProductTemplate(): RetailEventTemplate

open fun newSharedProductTemplate(@Nullable source: String, @Nullable medium: String): RetailEventTemplate

Creates a shared product event template.

newStarredProductTemplate

open fun newStarredProductTemplate(): RetailEventTemplate

Creates a starred product event template.

newWishlistTemplate

open fun newWishlistTemplate(): RetailEventTemplate

open fun newWishlistTemplate(@Nullable name: String, @Nullable id: String): RetailEventTemplate

Creates a wishlist event template.

open fun setBrand(@Nullable brand: String): RetailEventTemplate

Set the brand.

open fun setCategory(@Nullable category: String): RetailEventTemplate

Set the category.

open fun setCurrency(@Nullable currency: String): RetailEventTemplate

Set the currency.

open fun setDescription(@Nullable description: String): RetailEventTemplate

Set the description.

open fun setId(@Nullable id: String): RetailEventTemplate

Set the ID.

open fun setNewItem(newItem: Boolean): RetailEventTemplate

Set the newItem value.

setTransactionId

open fun setTransactionId(@Nullable transactionId: String): RetailEventTemplate

Set the transaction ID.

open fun setValue(value: Double): RetailEventTemplate

open fun setValue(value: Int): RetailEventTemplate

open fun setValue(@Nullable value: String): RetailEventTemplate

open fun setValue(@Nullable value: BigDecimal): RetailEventTemplate

Sets the event value.