EngageBySailthru

Separates logic between the core Marigold SDK functionality and that of the Sailthru only apps

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
interface TrackHandler

Functions

Link copied to clipboard

Clear the custom events from the device data.

Link copied to clipboard

Clear device events data.

Link copied to clipboard

Clear device events data.

Link copied to clipboard

Retrieve the profile vars set on the server.

Link copied to clipboard

Retrieve the profile vars set on the server.

Link copied to clipboard

Retrieve the profile vars set on the server.

Link copied to clipboard

If you're using Marigold email with universal links, your application will open with an encoded Marigold link url. This method will decode the link URL and return its canonical location (ie https://link.sailthru.com/blahblah will redirect to https://www.sailthru.com/careers/list/, the link's canonical location), as well as making sure that the clickthrough metrics for this link are correctly attributed in the Marigold platform. This method should be called from your receiving activity's onStart() method, and handle the starting intent's link data

Link copied to clipboard

If you're using Marigold email with universal links, your application will open with an encoded Marigold link url. This method will decode the link URL and return its canonical location (ie https://link.sailthru.com/blahblah will redirect to https://www.sailthru.com/careers/list/, the link's canonical location), as well as making sure that the clickthrough metrics for this link are correctly attributed in the Marigold platform. This method should be called from your receiving activity's onStart() method, and handle the starting intent's link data

Link copied to clipboard

If you're using Marigold email with universal links, your application will open with an encoded Marigold link url. This method will decode the link URL and return its canonical location (ie https://link.sailthru.com/blahblah will redirect to https://www.sailthru.com/careers/list/, the link's canonical location), as well as making sure that the clickthrough metrics for this link are correctly attributed in the Marigold platform. This method should be called from your receiving activity's onStart() method, and handle the starting intent's link data

Link copied to clipboard

Logs a cart abandonment with the Marigold platform. Use this to initiate cart abandoned flows.

Link copied to clipboard

Logs a cart abandonment with the Marigold platform. Use this to initiate cart abandoned flows.

Link copied to clipboard

Logs a cart abandonment with the Marigold platform. Use this to initiate cart abandoned flows.

Link copied to clipboard
fun logEvent(source: EventSource, value: String)

Log an event from a third party source. If value is null or an empty string, no event will be generated.

fun logEvent(value: String, vars: JSONObject? = null)

Log a Marigold Mobile event with associated vars. If value is null or an empty string, no event will be generated.

Link copied to clipboard

Logs a purchase with the Marigold platform. This can be used for mobile purchase attribution.

Link copied to clipboard
suspend fun EngageBySailthru.logPurchase(purchase: Purchase)

Logs a purchase with the Marigold platform. This can be used for mobile purchase attribution.

Link copied to clipboard

Logs a purchase with the Marigold platform. This can be used for mobile purchase attribution.

Link copied to clipboard

Set the profile vars through the SDK.

Link copied to clipboard

Set the profile vars through the SDK.

Link copied to clipboard

Set the profile vars through the SDK.

Link copied to clipboard
fun setUserEmail(userEmail: String?, handler: Marigold.MarigoldHandler<Void?>?)

Set the User's Email.

Link copied to clipboard
suspend fun EngageBySailthru.setUserEmail(userEmail: String?)

Set the User's Email.

Link copied to clipboard

Set the User's Email.

Link copied to clipboard
fun setUserId(userId: String?, handler: Marigold.MarigoldHandler<Void?>?)

Set an arbitrary external User ID.

Link copied to clipboard
suspend fun EngageBySailthru.setUserId(userId: String?)

Set an arbitrary external User ID.

Link copied to clipboard

Set an arbitrary external User ID.

Link copied to clipboard
fun trackClick(sectionId: String, url: URI, handler: EngageBySailthru.TrackHandler?)

Asynchronously registers with Marigold SPM that a section has been clicked/tapped on, transitioning the user to a detail view

Link copied to clipboard
suspend fun EngageBySailthru.trackClick(sectionId: String, url: URI)

Asynchronously registers with Marigold SPM that a section has been clicked/tapped on, transitioning the user to a detail view

Link copied to clipboard
suspend fun EngageBySailthru.trackClickResult(sectionId: String, url: URI): Result<Unit>

Asynchronously registers with Marigold SPM that a section has been clicked/tapped on, transitioning the user to a detail view

Link copied to clipboard
fun trackImpression(sectionId: String, urls: List<URI>?, handler: EngageBySailthru.TrackHandler?)

Asynchronously registers an impression - a reasonable expectation that a user has seen a piece of content - with Marigold SPM. Can be used in conjunction with RecyclerView.Adapter#onViewAttachedToWindow or similar to know when a particular content item has entered the user's viewport.

Link copied to clipboard
suspend fun EngageBySailthru.trackImpression(sectionId: String, urls: List<URI>?)

Asynchronously registers an impression - a reasonable expectation that a user has seen a piece of content - with Marigold SPM. Can be used in conjunction with RecyclerView.Adapter#onViewAttachedToWindow or similar to know when a particular content item has entered the user's viewport.

Link copied to clipboard
suspend fun EngageBySailthru.trackImpressionResult(sectionId: String, urls: List<URI>?): Result<Unit>

Asynchronously registers an impression - a reasonable expectation that a user has seen a piece of content - with Marigold SPM. Can be used in conjunction with RecyclerView.Adapter#onViewAttachedToWindow or similar to know when a particular content item has entered the user's viewport.

Link copied to clipboard

Asynchronously registers that the given "page" has been viewed with Marigold SPM. Note that a Content View here directly corresponds to a page view in SPM.

Link copied to clipboard
suspend fun EngageBySailthru.trackPageview(url: URI, tags: List<String?>?)

Asynchronously registers that the given "page" has been viewed with Marigold SPM. Note that a Content View here directly corresponds to a page view in SPM.

Link copied to clipboard

Asynchronously registers that the given "page" has been viewed with Marigold SPM. Note that a Content View here directly corresponds to a page view in SPM.