core/com.permutive.android/PermutiveApi

PermutiveApi

interface PermutiveApi : PermutiveSdk, Closeable

Functions

clearPersistentData

abstract suspend fun clearPersistentData(): Result<Unit>

Clear all persistent data of the current Permutive instance

abstract fun clearPersistentData(onSuccess: () -> Unit, onFailure: (Throwable) -> Unit)

Clear all persistent data of the current Permutive instance. Callbacks will run on the main thread.

abstract override fun close()

createVideoTracker

abstract fun ~~createVideoTracker~~(duration: Long, eventProperties: EventProperties? = null, title: String? = null, url: Uri? = null, referrer: Uri? = null): MediaTracker

Deprecated, please use trackVideoView: trackVideoView( duration: Long, videoProperties: MediaTracker.VideoProperties?, pageProperties: MediaTracker.PageProperties?, eventProperties: EventProperties? ): MediaTracker

currentUserId

abstract fun currentUserId(): String

eventTracker

@CheckResult

abstract fun eventTracker(): EventTracker

Create an EventTracker object. Any number of these may be created.

logger

abstract fun logger(): Logger

recordAppNexusAdImpression

abstract fun recordAppNexusAdImpression(auctionId: String?, buyerMemberId: Int?, creativeId: String?, source: String?, type: String?, height: Int?, tagId: String?, targeting: List<Pair<String, String>>)

recordAppNexusTargeting

abstract fun recordAppNexusTargeting(cohortIdsAttached: List<String>)

recordGamTargeting

abstract fun recordGamTargeting(cohortIdsAttached: List<String>)

sessionId

abstract fun sessionId(): String?

setDeveloperMode

abstract fun setDeveloperMode(enable: Boolean)

Enable/disable developer mode which will log more information to the console.

setIdentity

abstract fun setIdentity(identity: String)

Associate an alias with the current user with lowest priority that never expires. Forces segments and queries to be updated with the associated identity, if there is one on the server.

abstract fun setIdentity(aliases: List<Alias>)

Associate an list of aliases with the current user. Aliases are resolved in the order given. Forces segments and queries to be updated with the associated identity, if there is one on the server.

abstract fun setIdentity(identity: String, priority: Int? = Alias.LOWEST_PRIORITY, expiry: Date? = Alias.NEVER_EXPIRE)

Associate an alias with the current user. Forces segments and queries to be updated with the associated identity, if there is one on the server. Aliases will be deleted when their expiry is in the past.

setReferrer

abstract fun ~~setReferrer~~(referrer: Uri?)

Set the referrer context, used when tracking events.

setTitle

abstract fun ~~setTitle~~(title: String?)

Set the title context, used when tracking events.

setUrl

abstract fun ~~setUrl~~(url: Uri?)

Set the url context, used when tracking events.

trackApiCall

abstract fun <T> trackApiCall(name: ApiFunction, func: () -> T): T

trackPage

@CheckResult

abstract fun trackPage(eventProperties: EventProperties? = null, title: String? = null, url: Uri? = null, referrer: Uri? = null): PageTracker

Create a page tracker object with the given context & properties. A PageTracker object will automatically track a Pageview and PageviewComplete events upon creation and closing of the PageTracker object.

trackVideoAdView