Marigold Mobile Android SDK - 22.0.0/com.marigold.sdk/Marigold

Marigold

Keeps track of necessary environment variables provided by the developer or google. Also provides the entry point into Marigold for the developer to retrieve device information.

Constructors

Marigold

constructor()

Types

Companion

object Companion

MarigoldHandler

interface MarigoldHandler<T>

Generic handler for async calls to the Marigold SDK.

Properties

notificationActionTappedFlow

val Marigold.notificationActionTappedFlow: SharedFlow<Triple<Context, Bundle, ActionTapped>>

Notification Action Tapped Flow - subscribe to this to handle events when notification actions are tapped by the user.

notificationReceivedFlow

val Marigold.notificationReceivedFlow: SharedFlow<Pair<Context, Bundle>>

Notification Received Flow - subscribe to this to handle events when notifications are received on the device.

notificationTappedFlow

val Marigold.notificationTappedFlow: SharedFlow<Pair<Context, Bundle>>

Notification Tapped Flow - subscribe to this to handle events when notifications are tapped by the user.

Functions

addNotificationActionTappedListener

fun addNotificationActionTappedListener(listener: NotificationActionTappedListener)

Adds listener to be called when a notification action is tapped. This method should be called after startEngine

addNotificationReceivedListener

fun addNotificationReceivedListener(listener: NotificationReceivedListener)

Adds listener to be called when a notification is received. This method should be called after startEngine

addNotificationTappedListener

fun addNotificationTappedListener(listener: NotificationTappedListener)

Adds listener to be called when a notification is tapped. This method should be called after startEngine

getDeviceId

fun getDeviceId(handler: Marigold.MarigoldHandler<String?>?)

Gets this devices ID on the Marigold Mobile Platform.

getDeviceId

suspend fun Marigold.getDeviceId(): String?

Gets this device's ID on the Marigold Platform. Marigold

getDeviceIdResult

suspend fun Marigold.getDeviceIdResult(): Result<String?>

Gets this device's ID on the Marigold Platform.

handleNotification

fun handleNotification(remoteMessage: RemoteMessage)

Pass received notification to Marigold Mobile SDK. NOTE: This method should only be called if the app implements its own FirebaseMessagingService instance, in which case it must be called in order to provide FCM notifications to the Marigold Mobile SDK for processing. Otherwise this will be handled automatically by the Marigold Mobile SDK.

logRegistrationEvent

fun logRegistrationEvent(userId: String?)

Log a registration event with Marigold. This is used to log users signing in and out of the app. Pass the ID you wish to use for the sign-in or null for a sign-out.

requestNotificationPermission

@JvmOverloads

fun requestNotificationPermission(activity: Activity, isRationaleActivity: Boolean = false, requestCode: Int = DEFAULT_NOTIFICATION_PERMISSION_REQUEST_CODE): NotificationPermissionRequestResult

Handles the flow for requesting the android.Manifest.permission.POST_NOTIFICATIONS permission required for push notifications from Android 13(T)+. This is a no-op on earlier Android versions and will return NotificationPermissionRequestResult.PERMISSION_NOT_REQUIRED.

setDeviceToken

fun setDeviceToken(token: String?)

Pass the FCM token into the Marigold Mobile SDK. NOTE: This method should only be called if the app implements its own FirebaseMessagingService instance, in which case it must be called in order to provide the FCM token to the Marigold Mobile Platform. Otherwise this will be handled automatically by the Marigold Mobile SDK.

setGeoIpTrackingDefault

fun setGeoIpTrackingDefault(enabledGeoIp: Boolean)

Set whether location tracking based on IP Address will be enabled or disabled by default when a device is created. This method must be called before startEngine.

setGeoIPTrackingEnabled

suspend fun Marigold.setGeoIPTrackingEnabled(enabledGeoIp: Boolean)

Enabled location tracking based on IP Address. Tracking location tracking is enabled by default. Use this method for users who may not want to have their location tracked at all.

setGeoIpTrackingEnabled

@JvmOverloads

fun setGeoIpTrackingEnabled(enabledGeoIp: Boolean, handler: Marigold.MarigoldHandler<Void?>? = null)

Enabled location tracking based on IP Address. Tracking location tracking is enabled by default. Use this method for users who may not want to have their location tracked at all.

setGeoIPTrackingEnabledResult

suspend fun Marigold.setGeoIPTrackingEnabledResult(enabledGeoIp: Boolean): Result<Unit>

Enabled location tracking based on IP Address. Tracking location tracking is enabled by default. Use this method for users who may not want to have their location tracked at all.

setInAppNotificationsEnabled

fun setInAppNotificationsEnabled(enabled: Boolean)

Enables or disables the display of In-App Notifications. Must be called before startEngine. In-App Notifications are enabled by default.

setLogger

fun setLogger(logger: Logger)

All logging within Marigold Mobile is routed through this Logger.

setNotificationConfig

fun setNotificationConfig(notificationConfig: NotificationConfig)

Sets the configuration of notifications built by Marigold.

startEngine

fun startEngine(context: Context, appKey: String)

Initialises The Marigold Mobile SDK. See documentation Connecting to Marigold Mobile for usage.

syncNotificationSettings

fun syncNotificationSettings()

Checks the notifications enabled setting for the app and updates the device on the Marigold Mobile platform if required. From Android 13(T)+ it is recommended that this be called in when the result of the android.Manifest.permission.POST_NOTIFICATIONS permission is received to ensure the platform has the correct setting.

updateLocation

fun updateLocation(location: Location)

Updates Marigold with this device's location.