android-sdk-base/com.braze.events

Package-level declarations

Types

data class BannerDismissedEvent(val placementId: String)

Published on the external event messenger when a banner is dismissed. com.braze.ui.banners.BannerView instances subscribe to this event and dismiss themselves when placementId matches their own placement.

BannersUpdatedEvent

class BannersUpdatedEvent(val banners: List<Banner>)

BrazeNetworkFailureEvent

data class BrazeNetworkFailureEvent(val brazeRequest: ERROR CLASS: Symbol not found for IBrazeRequest, val httpConnectorResult: ERROR CLASS: Symbol not found for IHttpConnector.HttpConnectorResult)

A transparent and strictly informational look into the network stack used by the SDK. Since the SDK uses its own request retry strategies, it is not advised to retry a given request after an failure here unless advised by Braze support.

BrazePushEvent

data class BrazePushEvent(val eventType: BrazePushEventType, val notificationPayload: BrazeNotificationPayload)

Event dispatched when a push notification is received, opened, or deleted.

BrazeSdkAuthenticationErrorEvent

data class BrazeSdkAuthenticationErrorEvent(val sdkAuthError: ERROR CLASS: Symbol not found for SdkAuthError)

Event dispatched when SDK authentication fails.

BrazeUserChangeEvent

data class BrazeUserChangeEvent(val currentUserId: String)

Event fired when the current user has changed or the SDK has just been initialized.

ContentCardsUpdatedEvent

class ContentCardsUpdatedEvent(val contentCards: List<Card>, val userId: String?, val timestampSeconds: Long, val isFromOfflineStorage: Boolean)

FeatureFlagsUpdatedEvent

class FeatureFlagsUpdatedEvent(val featureFlags: List<FeatureFlag>)

IEventSubscriber

fun interface IEventSubscriber<T>

Callback interface for receiving Braze SDK events of type T.

IFireOnceEventSubscriber

fun interface IFireOnceEventSubscriber<T> : IEventSubscriber<T>

An IEventSubscriber subscriber where updates are guaranteed to fire only once and afterwards this subscriber will be removed, similarly to calling com.braze.IBraze.removeSingleSubscription directly after being invoked.

InAppMessageEvent

data class InAppMessageEvent(val triggerEvent: ERROR CLASS: Symbol not found for ITriggerEvent, val triggerAction: ERROR CLASS: Symbol not found for ITriggeredAction, val inAppMessage: IInAppMessage, val userId: String?)

When Braze receives a new in-app message in a server response, this event is fired. The message itself is provided along with the id of the user that the message is for (or null if no user id was set).

IValueCallback

fun interface IValueCallback<T>

Callback interface for asynchronous operations that return a value of type T.

NoMatchingTriggerEvent

data class NoMatchingTriggerEvent(val sourceEventType: String)

Fired when no In-App Message was triggered by an event.

SdkDataWipeEvent

class SdkDataWipeEvent

Event fired when SDK data has been wiped and external caches of messages (such as Content Cards, In-App Messages, etc.) should be cleared.

SessionStateChangedEvent

data class SessionStateChangedEvent(val sessionId: String, val eventType: SessionStateChangedEvent.ChangeType)

SimpleValueCallback

open class SimpleValueCallback<T> : IValueCallback<T>

A convenience class to extend when you only want to listen for a subset of all the value callback methods. This implements all methods in IValueCallback but does nothing for all applicable methods.