|
| 1 | +package com.mparticle |
| 2 | + |
| 3 | +// RoktEvent interface for handling events from the Rokt SDK. |
| 4 | +sealed interface RoktEvent { |
| 5 | + /** |
| 6 | + * ShowLoadingIndicator event will be triggered before SDK calls Rokt backend |
| 7 | + */ |
| 8 | + data object ShowLoadingIndicator : RoktEvent |
| 9 | + |
| 10 | + /** |
| 11 | + * HideLoadingIndicator event will be triggered when SDK obtains a success or failure from |
| 12 | + * Rokt backend |
| 13 | + */ |
| 14 | + data object HideLoadingIndicator : RoktEvent |
| 15 | + |
| 16 | + /** |
| 17 | + * OfferEngagement event will be triggered if User engaged with the offer |
| 18 | + * @param placementId - identifier for the placement emitting the event |
| 19 | + */ |
| 20 | + data class OfferEngagement(val placementId: String) : RoktEvent |
| 21 | + |
| 22 | + /** |
| 23 | + * PositiveEngagement event will be triggered if User positively engaged with the offer |
| 24 | + * @param placementId - identifier for the placement emitting the event |
| 25 | + */ |
| 26 | + data class PositiveEngagement(val placementId: String) : RoktEvent |
| 27 | + |
| 28 | + /** |
| 29 | + * FirstPositiveEngagement event will be triggered when the user positively engaged with the offer first time |
| 30 | + * @param placementId - identifier for the placement emitting the event |
| 31 | + */ |
| 32 | + data class FirstPositiveEngagement(val placementId: String) : RoktEvent |
| 33 | + |
| 34 | + /** |
| 35 | + * PlacementInteractive event will be triggered when placement has been rendered and is interactable |
| 36 | + * @param placementId - identifier for the placement emitting the event |
| 37 | + */ |
| 38 | + data class PlacementInteractive(val placementId: String) : RoktEvent |
| 39 | + |
| 40 | + /** |
| 41 | + * PlacementReady event will be triggered when placement is ready to display but has not rendered content yet |
| 42 | + * @param placementId - identifier for the placement emitting the event |
| 43 | + */ |
| 44 | + data class PlacementReady(val placementId: String) : RoktEvent |
| 45 | + |
| 46 | + /** |
| 47 | + * PlacementClosed event will be triggered when placement closes by user |
| 48 | + * @param placementId - identifier for the placement emitting the event |
| 49 | + */ |
| 50 | + data class PlacementClosed(val placementId: String) : RoktEvent |
| 51 | + |
| 52 | + /** |
| 53 | + * PlacementCompleted event will be triggered when the offer progression moves to the end and no more |
| 54 | + * offer to display |
| 55 | + * @param placementId - identifier for the placement emitting the event |
| 56 | + */ |
| 57 | + data class PlacementCompleted(val placementId: String) : RoktEvent |
| 58 | + |
| 59 | + /** |
| 60 | + * PlacementFailure event will be triggered when placement could not be displayed due to some failure |
| 61 | + * @param placementId - optional identifier for the placement emitting the event |
| 62 | + */ |
| 63 | + data class PlacementFailure(val placementId: String? = null) : RoktEvent |
| 64 | + |
| 65 | + /** |
| 66 | + * InitComplete event will be triggered when SDK has finished initialization |
| 67 | + * @param success - true if init was successful |
| 68 | + */ |
| 69 | + data class InitComplete(val success: Boolean) : RoktEvent |
| 70 | + |
| 71 | + /** |
| 72 | + * OpenUrl event will be triggered when user clicks on a link and the link target is set to Passthrough |
| 73 | + * @param placementId - identifier for the placement emitting the event |
| 74 | + * @param url - url to open |
| 75 | + */ |
| 76 | + data class OpenUrl(val placementId: String, val url: String) : RoktEvent |
| 77 | + |
| 78 | + /** |
| 79 | + * CartItemInstantPurchase event will be triggered when the catalog item purchase is initiated |
| 80 | + * by the user |
| 81 | + * @property placementId The layout identifier. |
| 82 | + * @property cartItemId The cart item identifier. |
| 83 | + * @property catalogItemId The catalog item identifier. |
| 84 | + * @property currency The currency used for the purchase. |
| 85 | + * @property description The description of the cart item. |
| 86 | + * @property linkedProductId The linked product identifier. |
| 87 | + * @property totalPrice The total price of the cart item. |
| 88 | + * @property quantity The quantity of the cart item. |
| 89 | + * @property unitPrice The unit price of the cart item. |
| 90 | + */ |
| 91 | + data class CartItemInstantPurchase( |
| 92 | + val placementId: String, |
| 93 | + val cartItemId: String, |
| 94 | + val catalogItemId: String, |
| 95 | + val currency: String, |
| 96 | + val description: String, |
| 97 | + val linkedProductId: String, |
| 98 | + val totalPrice: Double, |
| 99 | + val quantity: Int, |
| 100 | + val unitPrice: Double |
| 101 | + ) : RoktEvent |
| 102 | +} |
0 commit comments