Flagship

The Flagship class represents the SDK. It facilitates the initialization process and creation of new visitors.

start

Initialize and start the flagship SDK, using your credential with a custom configuration implementation.

Signature

suspend fun start(application: Application, envId: String, apiKey: String, config: FlagshipConfig<*>)

Parameters

📘

Environment ID and API Key

You can find your Environment Id and your API Key on your Flagship account, in Parameters > Environment & Security.

Example

class MyActivity : Activity() {
  
    override fun onCreate(savedInstanceState: Bundle?) {
      
        super.onCreate(savedInstanceState)
        
        Flagship.start(getApplication(),"_ENV_ID_", "_API_KEY_", FlagshipConfig.DecisionApi()
    }
}

newVisitor

Return a Visitor Builder class that wiill help to create a new visitor instance.

Signature

fun newVisitor(visitorId: String, consent: Boolean, instanceType: Visitor.Instance = Visitor.Instance.SINGLE_INSTANCE): Visitor.Builder

Parameters

Example

 val visitor = Flagship.newVisitor("visitor_uuid", true)
                .context(hashMapOf("isVIP" to true))
                .build()

getConfig

Return the current used configuration.

Signature

fun getConfig(): FlagshipConfig<*>

Example

val currentConfiguration = Flagship.getConfig()

getVisitor

This method will return any previous created visitor instance initialized with the SINGLE_INSTANCE (Set by default) option.

Signature

fun getVisitor() : Visitor?

Example

 val visitor = Flagship.getVisitor()

getStatus

Return the current SDK status. See Flagship.Status for more information.

Signature

fun getStatus(): Status

Example

 val flagshipStatus = Flagship.getStatus()

stop

Stop the Flagship SDK. Any data and background job will be cleared or stopped.

Signature

suspend fun stop()

Example

Flagship.stop()

Flagship.DecisionMode

This enum class used by the implementation of FlagshipConfig will makes the Flagship SDK run in two different modes.

Values

Flagship.FlagshipStatus

This enum class defines the current SDK Status. All possible status are:

Values

FlagshipConfig

This class aims to help you to configure the SDK via the following two available config implementations: DecisionApi and Bucketing. SeeDecision Mode section.

withLogManager

The withLogManager function of the FlagshipConfig class, set a custom implementation of LogManager in order to receive logs from the SDK.

Signature

fun withLogManager(customLogManager: LogManager): T

Parameters

Example

Flagship.start(
    getApplication(),
    "_ENV_ID_", 
  	"_API_KEY_"
    FlagshipConfig.DecisionApi()
      .withLogManager(object : LogManager() {
        override fun onLog(level: Level, tag: String, message: String) {
          // Intercept SDK logs.
        }
      })
)

Flagship.start(
    getApplication(),
    "_ENV_ID_", 
  	"_API_KEY_"
    FlagshipConfig.Bucketing()
      .withLogManager(object : LogManager() {
        override fun onLog(level: Level, tag: String, message: String) {
          // Intercept SDK logs.
        }
      })
)

withLogLevel

The withLogLevel function of the FlagshipConfig class can be used to filter logs emitted by the SDK.

Signature

fun withLogLevel(level: LogManager.Level): T

Parameters

Example

Flagship.start(
    getApplication(),
    "_ENV_ID_", 
  	"_API_KEY_"
    FlagshipConfig.DecisionApi()
    	.withLogLevel(LogManager.Level.ERROR)
)

Flagship.start(
    getApplication(),
    "_ENV_ID_", 
  	"_API_KEY_"
    FlagshipConfig.Bucketing()
    	.withLogLevel(LogManager.Level.ERROR)
)

withTimeout

The withTimeout function of the FlagshipConfig class can be used to set http request timeouts in milliseconds for api requests.

Signature

withTimeout(timeout: Int): T

Parameters

Example

Flagship.start(
    getApplication(),
    "_ENV_ID_", 
  	"_API_KEY_"
     FlagshipConfig.DecisionApi()
    	.withLogLevel(LogManager.Level.ERROR)
)

Flagship.start(
    getApplication(),
    "_ENV_ID_", 
  	"_API_KEY_"
    FlagshipConfig.Bucketing()
    	.withLogLevel(LogManager.Level.ERROR)
)

withFlagshipStatusListener

The withStatusListener function of the FlagshipConfig class can be used to define a new listener in order to get callback when the SDK status has changed.

Signature

fun withFlagshipStatusListener(listener: ((Flagship.Status) -> Unit)): T

Parameters

Example

Flagship.start(
    getApplication(),
    "_ENV_ID_", 
  	"_API_KEY_"
  	FlagshipConfig.DecisionApi()
    	.withStatusListener { newStatus ->
        println("NEW STATUS = " + newStatus)
      }
)

Flagship.start(
    getApplication(),
    "_ENV_ID_", 
  	"_API_KEY_"
  	FlagshipConfig.Bucketing()
     .withStatusListener { newStatus ->
        println("NEW STATUS = " + newStatus)
      }
)

withOnVisitorExposed

The withOnVisitorExposed function of the FlagshipConfig class can be used to invoke a lambda when a visitor has been exposed to a campaign Flag. It is useful to centralize Flag exposition before sending them to third party tools.

Signature

fun withOnVisitorExposed(onVisitorExposed: ((VisitorExposed, ExposedFlag<*>) -> (Unit))): T

Parameters

Example

Flagship.start(
    getApplication(),
    "_ENV_ID_", 
  	"_API_KEY_"
    FlagshipConfig.DecisionApi()
      .withOnVisitorExposed { visitorExposed, exposedFlag ->
        // Send data to third party tool
      }
)

Flagship.start(
    getApplication(),
    "_ENV_ID_", 
  	"_API_KEY_"
  	FlagshipConfig.Bucketing()
      .withOnVisitorExposed { visitorExposed, exposedFlag ->
        // Send data to third party tool
      }
)

withCacheManager

The withCacheManager function of the FlagshipConfig class can be used to provide a custom cache manager. Implement the IVisitorCacheImplementation interface to cache Visitor data or/and IHitCacheImplementation to cache Hits data. See CacheManager.

Signature

fun withCacheManager(customCacheManager: CacheManager?): T

Parameters

Example

Flagship.start(
    getApplication(),
    "_ENV_ID_", 
  	"_API_KEY_"
     FlagshipConfig.DecisionApi()
      .withCacheManager(object : CacheManager(), IVisitorCacheImplementation, IHitCacheImplementation {
          override fun cacheHits(hits: HashMap<String, JSONObject>) {
            // Cache hits in your own database.
          }

          override fun lookupHits(): HashMap<String, JSONObject> {
            // Load hits from your own database.
          }

          override fun flushHits(hitIds: ArrayList<String>) {
            // Delete hits from your own database.
          }

          override fun flushAllHits() {
            // Delete all hits in your own database.
          }

          override fun cacheVisitor(visitorId: String, data: JSONObject) {
             // Cache visitor data in your own database.
          }

          override fun lookupVisitor(visitorId: String): JSONObject {
            // Load visitor data from  your own database.
          }

          override fun flushVisitor(visitorId: String) {
              // Delete visitor data from  your own database.
          }
        })
)

Flagship.start(
    getApplication(),
    "_ENV_ID_", 
  	"_API_KEY_"
     FlagshipConfig.Bucketing()
      .withCacheManager(object : CacheManager(), IVisitorCacheImplementation, IHitCacheImplementation {
          override fun cacheHits(hits: HashMap<String, JSONObject>) {
            // Cache hits in your own database.
          }

          override fun lookupHits(): HashMap<String, JSONObject> {
            // Load hits from your own database.
          }

          override fun flushHits(hitIds: ArrayList<String>) {
            // Delete hits from your own database.
          }

          override fun flushAllHits() {
            // Delete all hits in your own database.
          }

          override fun cacheVisitor(visitorId: String, data: JSONObject) {
             // Cache visitor data in your own database.
          }

          override fun lookupVisitor(visitorId: String): JSONObject {
            // Load visitor data from  your own database.
          }

          override fun flushVisitor(visitorId: String) {
              // Delete visitor data from  your own database.
          }
        })
)

withTrackingManagerConfig

The withTrackingManagerConfig function of the FlagshipConfig class can be used to Specify a custom tracking manager configuration. See TrackingManagerConfig.

Signature

fun withTrackingManagerConfig(trackingManagerConfig: TrackingManagerConfig): T

Parameters

Example

Flagship.start(
    getApplication(),
    "_ENV_ID_", 
  	"_API_KEY_"
    FlagshipConfig.DecisionApi()
    .withTrackingManagerConfig(TrackingManagerConfig(
      cachingStrategy = CacheStrategy.PERIODIC_CACHING,
      closingStrategy = ClosingStrategy.CACHE_PENDING_HITS,
      batchTimeInterval = 20000,
      maxPoolSize = 20
    ))
)

Flagship.start(
    getApplication(),
    "_ENV_ID_", 
  	"_API_KEY_"
    FlagshipConfig.Bucketing()
    .withTrackingManagerConfig(TrackingManagerConfig(
      cachingStrategy = CacheStrategy.PERIODIC_CACHING,
      closingStrategy = ClosingStrategy.CACHE_PENDING_HITS,
      batchTimeInterval = 20000,
      maxPoolSize = 20
    ))
)

Visitor

The Visitor class represents a unique user within your application. It is useful to manage visitor's data and fetching the corresponding flags from the Flagship platform .

A new visitor instance can be created using the newVisitor method from the Flagship class which returns a Visitor Builder class.

setConsent

Specify if the visitor has consented for personal data usage. When false some features will be deactivated, cache will be deactivated and cleared.

Signature

fun setConsent(hasConsented: Boolean)

Parameters

Example

visitor.setConsent(false)

hasConsented

Return true if the visitor has given his consent for private data usage, false otherwise.

Signature

fun hasConsented(): Boolean

Example

val hasConsented = visitor.hasConsented()

updateContext

Update the visitor context values, matching the given keys, used for targeting. A new context value associated with this key will be created if there is no previous matching value. Context keys must be String, and values types must be one of the following : Number, Boolean, String.

📘

Refresh Flags

When Visitor's context is changed, it may target different campaigns so assigned flags should be refreshed by calling the fetchFlags() function afterward.

Signature

fun <T> updateContext(key: String, value: T)

Parameters

Example

visitor.updateContext("returning_visitor", true)

Signature

fun updateContext(context: HashMap<String, Any>)

Parameters

Example

visitor.updateContext(hashMapOf("returning_visitor" to true, "visitor_landing_page" to "https://www.mydomain.com"))

Signature

fun <T> updateContext(flagshipContext: FlagshipContext<T>, value: T)

Parameters

Example

   visitor.updateContext(FlagshipContext.CARRIER_NAME, "free")

clearContext

Clear all the visitor context values used for targeting.

📘

Refresh Flags

When Visitor's context is changed, it may target different campaigns so assigned flags should be refreshed by calling the fetchFlags() function afterward.

Signature

fun clearContext()

Example

visitor.clearContext()

fetchFlags

This function will fetch campaigns flags from campaigns that target visitor's context.

Signature

fun fetchFlags(): Deferred<IVisitor>

Example

runBlocking {
	visitor.fetchFlags().await()
}

getFlag

This function will return a flag object containing the current value returned by Flagship and the associated campaign information. If the key is not found an empty Flag object with the default value will be returned. See Flag for more information.

Signature

fun getFlag(key: String)

Parameters

Example

val displayNewFeatureFlag = visitor.getFlag("isNewFeatureEnabled")

getFlags

This function will return a FlagCollection containing the all the current flags returned by Flagship and the associated campaign information. See FlagCollection for more information.

Signature

fun getFlags(): FlagCollection

Example

val allFlags = visitor.getFlags()

sendHit

This function will send a Hit to Flagship collect to feed campaign reporting.

Signature

fun <T> sendHit(hit: Hit<T>)

Parameters

Example

visitor.sendHit(Event(Event.EventCategory.ACTION_TRACKING, "click_on_basket"))

authenticate

Tag the current visitor as authenticated, This will insure to keep the same experience once the visitor is logged.

📘

Refresh Flags

When authentication status is changed, it may target different campaigns so assigned flags should be refreshed by calling the fetchFlags() function afterward.

Signature

fun authenticate(visitorId: String)

Parameters

Example

visitor.authenticate("logged_visitor_id")

unAuthenticate

Tag the current visitor as authenticated, This will insure to keep the same experience once the visitor is disconnected.

📘

Refresh Flags

When authentication status is changed, it may target different campaigns so assigned flags should be refreshed by calling the fetchFlags() function afterward.

Signature

fun unauthenticate()

Example

visitor.unAuthenticate()

collectEmotionsAIEvents

Start collecting events for the EmotionAI Feature if it is enabled on platform side. Returns a Job with a boolean result meaning EmotionsAI collect has ended successfully or not. This feature requires a feature activation plan on the platform side, contact us to know more about. When full plan is enabled the EmotionsAI scoring will be automatically added to your visitor context and in local cache.

📘

Notes

This method needs the SDK to be initialized successfully and to have the visitor's consent, and that there is no previous score already present in the cache to run.

Signature

fun collectEmotionsAIEvents(activity: Activity? = null): Deferred<Boolean>

Parameters

Example

visitor.collectEmotionsAIEvents(this@MainActivity)

Visitor.Builder

This class is an helper for Visitor instance creation.

isAuthenticated

Specify if the visitor is authenticated or anonymous for experience continuity.

Signature

fun isAuthenticated(isAuthenticated: Boolean): Builder

Parameters

Example

val visitor = Flagship.newVisitor("visitor_uuid", true)
  .isAuthenticated(true)
  .build()

context

Specify visitor initial context key / values used for tar campaign targeting. Context keys must be String, and values types must be one of the following : Number, Boolean, String.

Signature

fun context(context: HashMap<String, Any>): Builder

Parameters

Example

 val visitor = Flagship.newVisitor("visitor_uuid", true)
  	.context(hashMapOf("isVIP" to true))
  	.build()

onFlagStatusChanged

Set a FlagStatusChanged callback to be notified when Flags are out of date and need to be fetched or when flags have been successfully fetched. More info on OnFlagStatusChanged.

Signature

fun onFlagStatusChanged(onFlagStatusChanged: OnFlagStatusChanged): Builder

Parameters

Example

 val visitor = Flagship.newVisitor("visitor_abcd", true)
  .onFlagStatusChanged(object : OnFlagStatusChanged {
    override fun onFlagStatusChanged(newStatus: FlagStatus) {
      //todo
    }

    override fun onFlagStatusFetchRequired(reason: FetchFlagsRequiredStatusReason) {
      //todo
    }

    override fun onFlagStatusFetched() {
      //todo
    }
  })
  .build()

build

Build the visitor instance.

Signature

fun build(): Visitor

Example

 val visitor = Flagship.newVisitor("visitor_uuid", true)
  	.isAuthenticated(true)
  	.context(hashMapOf("isVIP" to true))
  	.build()

Visitor.Instance

This enum class allows to define how Flagship SDK should handle the newly create visitor instance.

Values

Flag

This class represents a flag in the Flagship SDK. It helps you retrieve the flag value, access its metadata, expose the flag, verify the flag's existence, and get the flag status with the following API.

A Flag instance will be returned when the function [getFlag](doc:android-reference#getflag) from the Visitor class is called.

value

Return and consume the current value for this flag or return default value when the flag doesn't exist or when the current flag value type and default value type mismatch. Consuming the value will allow flag activation.

Signature

inline fun <reified T: Any?> value(defaultValue: T?, visitorExposed: Boolean = true): T?

Parameters

Example

val isNewFeatureEnabledFlag = visitor.getFlag("isNewFeatureEnabled", false)
val displayNewFeature = isNewFeatureEnabledFlag.value()

when (displayNewFeature) {
  true -> {
    //Display the feature
  }
  else -> {
    //Hide the feature
  }
}

metadata

Return the campaign information metadata or an Empty flag metadata object if the flag doesn't exist.

Signature

fun metadata(): FlagMetadata

Example

val isNewFeatureEnabledMetadata = visitor.getFlag("isNewFeatureEnabled", false)
  .metadata()

visitorExposed

Tells Flagship the user have been exposed and have seen this flag. This will increment the visits for the current variation on your campaign reporting. Only Flags whose value was consumed with value() beforehand will be exposed.

Signature

fun visitorExposed()

Example

val homeScreenLabelFlag = visitor.getFlag("homeScreenLabel", false)
val displayNewFeature = homeScreenLabelFlag.value(false)
//display new label
homeScreenLabelFlag.visitorExposed())

exists

Check and return true if the current flag exists in Flagship SDK, false otherwise.

Signature

fun exists(): Boolean

Example

val doesFlagExist = visitor.getFlag("homeScreenLabel", false).exists()

status

Return the status for this Flag. See FlagStatus.

Signature

fun status(): FlagStatus

Example

val myFlagStatus visitor.getFlag("myFlag", "default").status()

Flag collection

This class holds a collection of Flag and helpers to manipulate them.

keys

Return all the Flag keys contained in the collection.

Signature

fun keys(): MutableSet<String>

Example

visitor.getFlags().keys()

get

Return a Flag from the collection.

Signature

operator fun get(key: String): Flag

Example

val flagCollection = visitor.getFlags()
val flag = flagCollection["my_flag"]
val flag2 = flagCollection.get("my_flag_2")

exposeAll

Expose all the flags in the collection. Only the ones whose value has been consumed will be exposed.

Signature

fun exposeAll()

Example

visitor.getFlags().exposeAll()

filter

Return a new FlagCollection matching the given predicate.

Signature

fun filter(predicate: (Map.Entry<String, Flag>) -> Boolean): FlagCollection

Parameters

Example

val appCampaignFlags = visitor.getFlags().filter { (k, f) -> flag.metadata().campaignName == "app" }

metadata

Return a map of Flag FlagMetadata from the collection.

Signature

fun metadata(): Map<String, FlagMetadata>

Example

val flagCollection = visitor.getFlags()
val flagCollectionMetadata = flagCollection.metadata()

toJSON

Return the collection Flags metadata as JSONObject.

Signature

fun toJSON(): JSONObject

Example

val flagCollection = visitor.getFlags()
val jsonFlagCollection = flagCollection.toJSON()

iterator

Return a FlagCollection iterator.

Signature

operator fun iterator(): Iterator<Pair<String, Flag>>

Example

val flagCollection = visitor.getFlags()
for ((k, v) in flagCollection) {
  //
}

size

Return the collection size.

Signature

fun size(): Int

Example

val flagCollectionSize = visitor.getFlags().size()

FlagMetadata

This class holds all flag campaign information. FlagMetadata object can be returned by calling the [metadata](doc:android-reference#metadata)() function from a Flag instance.

Properties

'exists'

Check and return true if the current flag exists and has metadatas in Flagship SDK, false otherwise.

Signature

fun exists(): Boolean

Example

val doesFlagMetadataExist = visitor.getFlag("homeScreenLabel", false).metadata().exists()

'toJSON'

Transform the current FlagMetadata instance into a json object containing all the properties.

Signature

fun toJSON(): JSONObject

Example

val flagMetadataJSON = visitor.getFlag("homeScreenLabel", false).metadata().toJSON()

Hit

This super class helps you track your users in your application and learn how to build hits in order to feed campaign goals. For more information about our measurement protocol, read our Universal Collect documentation.

There are five different types of Hits available: Page, Screen, Event, Transaction, Item and all have common options.

withIp

Set the current user public ip.

Signature

fun withIp(ip: String): T

Parameters

Example

 visitor.sendHit(
   Event(Event.EventCategory.ACTION_TRACKING, "click_on_basket")
     .withId("8.8.8.8")
 )

withResolution

Set the current device screen resolution.

Signature

fun withResolution(width: Int, height: Int): T

Parameters

Example

visitor.sendHit(
  Event(Event.EventCategory.ACTION_TRACKING, "click_on_basket")
    .withResolution(1920, 1080)
)

withSessionNumber

Set the current visitor session number.

Signature

fun withSessionNumber(number: Int): T

Parameters

Example

visitor.sendHit(
  Event(Event.EventCategory.ACTION_TRACKING, "click_on_basket")
    .withSessionNumber(3)
)

withLocale

Set the current user device locale.

Signature

fun withLocale(locale: String): T

Parameters

Example

visitor.sendHit(
  Event(Event.EventCategory.ACTION_TRACKING, "click_on_basket")
    .withLocale("fra")
)

Page

Hit to send when a user sees a web page.

Parameters

Example

import com.abtasty.flagship.hits.Page

visitor.sendHit(
  Page("www.domain.com")
)

Screen

Hit to send when a user sees an interface.

Parameters

Example

import com.abtasty.flagship.hits.Screen

visitor.sendHit(
  Screen("PaymentActivity")
)

Event

Hit which represents an event. Can be a anything you want : for example a click or a newsletter subscription.

Parameters

Example

import com.abtasty.flagship.hits.Event

visitor.sendHit(
  Event(Event.EventCategory.ACTION_TRACKING, "click_on_basket")
)

withEventLabel

Set a label for this event.

Signature

fun withEventLabel(label: String): Event

Parameters

Example

import com.abtasty.flagship.hits.Event

visitor.sendHit(
  Event(Event.EventCategory.ACTION_TRACKING, "click_on_basket")
    .withEventLabel("Go to basket")
)

withEventValue

Set a value for this event. Must be non-negative Int.

Signature

fun withEventValue(value: Int): Event

Parameters

Example

import com.abtasty.flagship.hits.Event

visitor.sendHit(
  Event(Event.EventCategory.ACTION_TRACKING, "click_on_basket")
    .withEventValue(3)
)

Transaction

Hit to send when a user complete a transaction.

Parameters

withTotalRevenue

Set the total revenue associated with the transaction. This value should include any shipping or tax costs.

Signature

fun withTotalRevenue(revenue: Float): Transaction

Parameters

Example

import com.abtasty.flagship.hits.Transaction

visitor.sendHit(
  Transaction("942B42042CC", "affiliation")
    .withTotalRevenue(99.9f)
)

withShippingCosts

Set the total shipping cost of the transaction.

Signature

fun withShippingCosts(shipping: Float): Transaction

Parameters

Example

visitor.sendHit(
  Transaction("942B42042CC", "affiliation")
    .withShippingCosts(4.99f)
)

withShippingMethod

Set the shipping method.

Signature

fun withShippingMethod(shippingMethod: String): Transaction

Parameters

Example

visitor.sendHit(
  Transaction("942B42042CC", "affiliation")
    .withShippingMethod("Chrono 48")
)

withTaxes

Set the total taxes of the transaction.

Signature

fun withTaxes(taxes: Float): Transaction

Parameters

Example

visitor.sendHit(
  Transaction("942B42042CC", "affiliation")
    .withTaxes(9.99f)
)

withCurrency

Set the currency used for all transaction currency values. Value should be a valid ISO 4217 currency code.

Signature

fun withCurrency(currency: String): Transaction

Parameters

Example

visitor.sendHit(
  Transaction("942B42042CC", "affiliation")
    .withCurrency("EUR")
)

withPaymentMethod

Set the payment method for the transaction.

Signature

fun withPaymentMethod(paymentMethod: String): Transaction

Parameters

Example

visitor.sendHit(
  Transaction("942B42042CC", "affiliation")
    .withPaymentMethod("credit_card")
)

withItemCount

Set the number of items for the transaction.

Signature

fun withItemCount(itemCount: Int): Transaction

Parameters

Example

visitor.sendHit(
  Transaction("942B42042CC", "affiliation")
    .withItemCount(2)
)

withCouponCode

Set the coupon code used by the customer for the transaction.

Signature

fun withCouponCode(coupon: String): Transaction

Parameters

Example

visitor.sendHit(
  Transaction("942B42042CC", "affiliation")
    .withCouponCode("COUPON10")
)

Item

Hit to send to associated items to a transaction. Items must be sent after the corresponding transaction.

Parameters

Example

import com.abtasty.flagship.hits.Item

visitor.sendHit(
  Item("942B42042CC", "Item", "U20398")
)

withItemPrice

Set the item price.

Signature

fun withItemPrice(price: Float): Item

Parameters

Example

visitor.sendHit(
  Item("942B42042CC", "Item", "U20398")
    .withItemPrice(39.99f)
)

withItemQuantity

Set the number of item purchased.

Signature

fun withItemCategory(category: String): Item

Parameters

Example

visitor.sendHit(
  Item("942B42042CC", "Item", "U20398")
    .withItemQuantity(2)
)

withItemCategory

Set the item category.

Signature

fun withItemCategory(category: String): Item

Parameters

Example

visitor.sendHit(
  Item("942B42042CC", "Item", "U20398")
    .withItemCategory("Furniture")
)

CacheManager

By default the SDK implements a DefaultCacheManager which uses a local SQLiteDatabase. The CacheManager is an abstract class to implement in order to use your own caching solution. Implement IVisitorCacheImplementation and/or IHitCacheImplementation interfaces to provide a custom cache implementation for visitor's data and hits emitted by visitors.

The purpose of implementing cache is to prevent re-allocation in bucketing mode and prevent any data loss when the SDK is running offline. See more details in Managing cache.

Parameters

IVisitorCacheImplementation

This interface specifies the methods to implement in order to cache visitors data.

Visitor cache is used for: retrieving campaign flags while offline, preventing re-allocation in bucketing mode and is used by some feature to work.

cacheVisitor

This method is called when the SDK need to upsert (insert or update) current visitor information into the database.

Signature

fun cacheVisitor(visitorId : String, data : JSONObject)

Parameters

lookupVisitor

This method is called when the SDK need to load visitor information from the database.

Signature

fun lookupVisitor(visitorId: String) : JSONObject

Parameters

flushVisitor

This method is called when visitor information should be cleared from the database.

Signature

fun flushVisitor(visitorId: String)

Parameters

Example

Flagship.start(
  getApplication(), _ENV_ID_, _API_KEY_, FlagshipConfig.Bucketing()
    .withCacheManager(object : CacheManager(), IVisitorCacheImplementation {
      
      override fun cacheVisitor(visitorId: String, data: JSONObject) {
        // Cache visitor information in your own database.
      }

      override fun lookupVisitor(visitorId: String): JSONObject {
        // Load visitor information from your own database.
      }

      override fun flushVisitor(visitorId: String) {
        // Flush visitor information from your own database.
      }

    })
)

IHitCacheImplementation

This interface defines the methods to implement in order to cache hits for flagship SDK. Saving hits prevent any data loss while running offline.

cacheHits

This method is called when the SDK need to save hits into the database.

Signature

fun cacheHits(hits: HashMap<String, JSONObject>)

Parameters

lookupHits

This method is called when the SDK need to load hits from the database to sent them again.

Warning : Hits must be deleted from the database before being returned so your database remains clean and so hits can be inserted again if they fail to be sent a second time.

Signature

fun lookupHits(): HashMap<String, JSONObject>

flushHits

This method is called when hits need to be removed from the database.

Signature

fun flushHits(hitIds: ArrayList<String>)

Parameters

flushAllHits

This method is called when the Flagship SDK needs to flush all the hits from cache.

Signature

fun flushAllHits()

Example

 Flagship.start(
   getApplication(), _ENV_ID_, _API_KEY_, FlagshipConfig.Bucketing()
   	.withCacheManager(object : CacheManager(), IHitCacheImplementation {
   
       	override fun cacheHits(hits: HashMap<String, JSONObject>) {
       		// Cache hits in your own database.
     		}

    		override fun lookupHits(): HashMap<String, JSONObject> {
      		// Remove and return hits from your own database
    		}

    		override fun flushHits(hitIds: ArrayList<String>) {
      		// remove hits from your own database.
    		}

    		override fun flushAllHits() {
      		// remove all hits from your own database.
    		}
		})
)

TrackingManagerConfig

This class configure the Flagship SDK Tracking Manager which gathers all visitors emitted hits in a pool and fire them in batch requests at regular time intervals withing a dedicated thread.

Parameters

CachingStrategy

This class specifies the hits caching strategy to adopt into the TrackingManager and relies on the IHitCacheImplementation class that must be implemented in the CacheManager. Depending on the strategy the TrackingManager will request the CacheManager to CACHE, LOOK-UP or FLUSH hits from the linked database.

Value

ClosingStrategy

This class specifies the hits closing strategy to adopt when the SDK is closing.

Value

Appendix

Predefined context keys

The Flagship SDK contains predefined user context keys.

The keys marked as Yes in the Auto-set by SDK column will be automatically set, while the ones marked as No need to be set by the client.

📘

Check values

Check the values sent by the SDK by enabling the logs.

You can overwrite these keys at any time. The key-value pairs will be sent to the server in the user context and can be edited in the Persona section of the Flagship platform.

📘

Override values

To overwrite the keys, use the updateContext method

FlagStatus

Enum class that represents a Flag Status.

Values

OnFlagStatusChanged

This interface represents a callback which could be used to be notified by the SDK when Visitor FetchStatus have changed or when Flags

onFlagStatusChanged

This function will be called each time the FlagStatus has changed.

Signature

fun onFlagStatusChanged(newStatus: FlagStatus)

Parameters

onFlagStatusFetchRequired

This function will be called each time Flags are out of date and have to be updated by calling fetchFlags().

Signature

fun onFlagStatusChanged(newStatus: FlagStatus)

Parameters

onFlagStatusFetched

This function will be called each time Flags have been fetched and updated successfully.

Signature

fun onFlagStatusChanged(newStatus: FlagStatus)

Parameters