airbridge/co.ab180.airbridge/AirbridgeInterface

AirbridgeInterface

open class AirbridgeInterface : AirbridgeFunctions

Contains every features of SDK.

Note A Class extending AirbridgeInterface becomes isolated SDK instance. It can be used to install multiple Airbridge app.

object AirbridgeGrape: AirbridgeInterface()
object AirbridgeBanana: AirbridgeInterface()

// Each class works independently.
AirbridgeGrape.initializeSDK(...)
AirbridgeBanana.initializeSDK(...)

Constructors

AirbridgeInterface

constructor()

Functions

allowTrackingItem

override fun allowTrackingItem(item: AirbridgeTrackingBlocklist)

Allows tracking for the specified AirbridgeTrackingBlocklist item.

blockTrackingItem

override fun blockTrackingItem(item: AirbridgeTrackingBlocklist)

Blocks tracking for the specified AirbridgeTrackingBlocklist item.

clearDeviceAlias

override fun clearDeviceAlias()

Clears all device aliases.

clearUser

override fun clearUser()

Clears all user information.

clearUserAlias

override fun clearUserAlias()

Clears all user aliases.

clearUserAttributes

override fun clearUserAttributes()

Clears all user attributes.

clearUserEmail

override fun clearUserEmail()

Clear the user email.

clearUserID

override fun clearUserID()

Clear the user ID.

clearUserPhone

override fun clearUserPhone()

Clear the user phone number.

click

override fun click(trackingLink: Uri): Boolean

override fun click(trackingLink: Uri, onSuccess: OnSuccess<Unit>?): Boolean

override fun click(trackingLink: Uri, onSuccess: OnSuccess<Unit>?, onFailure: OnFailure?): Boolean

Notifies that an in-app area within an app has been clicked on by the user.

createTrackingLink

override fun createTrackingLink(channel: String, option: Map<String, Any>, onSuccess: OnSuccess<AirbridgeTrackingLink>)

override fun createTrackingLink(channel: String, option: Map<String, Any>, onSuccess: OnSuccess<AirbridgeTrackingLink>, onFailure: OnFailure?)

Creates a tracking-link using airbridge-server that move user to specific page of app and track click-event.

createWebInterfaceScript

override fun createWebInterfaceScript(webToken: String, postMessageScript: String): String

Creates script that initialize web interface to implement web interface manually.

disableSDK

override fun disableSDK()

Disables the SDK.

enableSDK

override fun enableSDK()

Enables the SDK.

fetchAirbridgeGeneratedUUID

override fun fetchAirbridgeGeneratedUUID(onSuccess: OnSuccess<String>): Boolean

override fun fetchAirbridgeGeneratedUUID(onSuccess: OnSuccess<String>, onFailure: OnFailure?): Boolean

Fetches the Airbridge Generated UUID using the provided callbacks for success and failure.

fetchAmazonAdvertisingIdInfo

override fun fetchAmazonAdvertisingIdInfo(onSuccess: OnSuccess<AdvertisingIdInfo>): Boolean

override fun fetchAmazonAdvertisingIdInfo(onSuccess: OnSuccess<AdvertisingIdInfo>, onFailure: OnFailure?): Boolean

fetch Amazon Advertising ID info

fetchDeviceUUID

override fun fetchDeviceUUID(onSuccess: OnSuccess<String>): Boolean

override fun fetchDeviceUUID(onSuccess: OnSuccess<String>, onFailure: OnFailure?): Boolean

Fetches the Device UUID using the provided callbacks for success and failure.

fetchGalaxyStoreInstallReferrerDetails

override fun fetchGalaxyStoreInstallReferrerDetails(onSuccess: OnSuccess<ReferrerDetails?>): Boolean

override fun fetchGalaxyStoreInstallReferrerDetails(onSuccess: OnSuccess<ReferrerDetails?>, onFailure: OnFailure?): Boolean

fetch Galaxy store install referrer

fetchGoogleAdvertisingIdInfo

override fun fetchGoogleAdvertisingIdInfo(onSuccess: OnSuccess<AdvertisingIdInfo>): Boolean

override fun fetchGoogleAdvertisingIdInfo(onSuccess: OnSuccess<AdvertisingIdInfo>, onFailure: OnFailure?): Boolean

fetch Google Advertising ID info

fetchGoogleInstallReferrerDetails

override fun fetchGoogleInstallReferrerDetails(onSuccess: OnSuccess<ReferrerDetails?>): Boolean

override fun fetchGoogleInstallReferrerDetails(onSuccess: OnSuccess<ReferrerDetails?>, onFailure: OnFailure?): Boolean

fetch Google install referrer

fetchHuaweiAdvertisingIdInfo

override fun fetchHuaweiAdvertisingIdInfo(onSuccess: OnSuccess<AdvertisingIdInfo>): Boolean

override fun fetchHuaweiAdvertisingIdInfo(onSuccess: OnSuccess<AdvertisingIdInfo>, onFailure: OnFailure?): Boolean

fetch Huawei Advertising ID info

fetchHuaweiInstallReferrerDetails

override fun fetchHuaweiInstallReferrerDetails(onSuccess: OnSuccess<ReferrerDetails?>): Boolean

override fun fetchHuaweiInstallReferrerDetails(onSuccess: OnSuccess<ReferrerDetails?>, onFailure: OnFailure?): Boolean

fetch Huawei install referrer

fetchMetaInstallReferrerDetails

override fun fetchMetaInstallReferrerDetails(onSuccess: OnSuccess<ReferrerDetails?>): Boolean

override fun fetchMetaInstallReferrerDetails(onSuccess: OnSuccess<ReferrerDetails?>, onFailure: OnFailure?): Boolean

fetch Meta install referrer

handleDeeplink

override fun handleDeeplink(intent: Intent, onSuccess: OnSuccess<Uri>): Boolean

override fun handleDeeplink(intent: Intent, onSuccess: OnSuccess<Uri>, onFailure: OnFailure?): Boolean

Handle Airbridge's deep link from the provided intent and invoke a callback based on the result.

handleDeferredDeeplink

override fun handleDeferredDeeplink(onSuccess: OnSuccess<Uri?>): Boolean

override fun handleDeferredDeeplink(onSuccess: OnSuccess<Uri?>, onFailure: OnFailure?): Boolean

Handle deferred deep link and invoke a callback based on the result.

handleWebInterfaceCommand

override fun handleWebInterfaceCommand(command: String)

Handles command from web interface to implement web interface manually.

impression

override fun impression(trackingLink: Uri): Boolean

override fun impression(trackingLink: Uri, onSuccess: OnSuccess<Unit>?): Boolean

override fun impression(trackingLink: Uri, onSuccess: OnSuccess<Unit>?, onFailure: OnFailure?): Boolean

Notifies that an in-app area within an app has been exposed on by the user.

initializeSDK

override fun initializeSDK(app: Application, option: AirbridgeOption)

Initializes the SDK with the provided app and option.

isInAppPurchaseTrackingEnabled

override fun isInAppPurchaseTrackingEnabled(): Boolean

Indicates that SDK can track event automatically for each user purchases product through in-app-purchase.

isSDKEnabled

override fun isSDKEnabled(): Boolean

Checks whether the SDK is currently enabled.

isTrackingEnabled

override fun isTrackingEnabled(): Boolean

Checks whether the SDK is currently enabled for tracking.

isUninstallTrackingNotification

override fun isUninstallTrackingNotification(remoteMessage: RemoteMessage): Boolean

check if a push message is uninstall tracking notification

registerPushToken

override fun registerPushToken(token: String)

Registers the FCM registration token to track app uninstalls.

removeDeviceAlias

override fun removeDeviceAlias(key: String)

Removes the device alias with the given key.

removeUserAlias

override fun removeUserAlias(key: String)

Removes the user alias with the given key.

removeUserAttribute

override fun removeUserAttribute(key: String)

Removes the user attribute with the given key.

setDeviceAlias

override fun setDeviceAlias(key: String, value: String)

Sets the key, value pair to the device alias.

setUserAlias

override fun setUserAlias(key: String, value: String)

Sets the key, value pair to the user alias.

setUserAttribute

override fun setUserAttribute(key: String, value: Boolean)

override fun setUserAttribute(key: String, value: Double)

override fun setUserAttribute(key: String, value: Float)

override fun setUserAttribute(key: String, value: Int)

override fun setUserAttribute(key: String, value: Long)

override fun setUserAttribute(key: String, value: String)

Sets the key, value pair to the user attribute.

setUserEmail

override fun setUserEmail(email: String)

Sets the user email.

setUserID

override fun setUserID(id: String)

Sets the user ID.

setUserPhone

override fun setUserPhone(phone: String)

Sets the user phone number.

setWebInterface

override fun setWebInterface(webView: WebView, webToken: String)

Enables the Android SDK to automatically pull all events from the web SDK that is installed on the website of the WebView environment.

startInAppPurchaseTracking

override fun startInAppPurchaseTracking()

Starts tracking event automatically for each user purchases product through in-app-purchase.

startTracking

override fun startTracking()

Start collecting and transferring events.

stopInAppPurchaseTracking

override fun stopInAppPurchaseTracking()

Stops tracking event automatically for each user purchases product through in-app-purchase.

stopTracking

override fun stopTracking()

Stop collecting and transferring events.

trackEvent

override fun trackEvent(category: String)

Tracks user behavior through event tracking.

override fun trackEvent(category: String, semanticAttributes: Map<String, Any?>?)

override fun trackEvent(category: String, semanticAttributes: Map<String, Any?>?, customAttributes: Map<String, Any?>?)

Tracks user behavior through event tracking with attributes.