airbridge/co.ab180.airbridge/Airbridge

Airbridge

object Airbridge

Functions

clearDeviceAlias

@JvmStatic

fun clearDeviceAlias()

Clears all device aliases.

clearUser

@JvmStatic

fun clearUser()

Clears all user information.

clearUserAlias

@JvmStatic

fun clearUserAlias()

Clears all user aliases.

clearUserAttributes

@JvmStatic

fun clearUserAttributes()

Clears all user attributes.

clearUserEmail

@JvmStatic

fun clearUserEmail()

Clear the user email.

clearUserID

@JvmStatic

fun clearUserID()

Clear the user ID.

clearUserPhone

@JvmStatic

fun clearUserPhone()

Clear the user phone number.

click

@JvmStatic

@JvmOverloads

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

Notifies that the in-app area within the app has been exposed to the user.

@JvmStatic

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

@JvmStatic

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

@JvmStatic

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

@JvmStatic

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

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

disableSDK

@JvmStatic

fun disableSDK()

Disables the SDK.

enableSDK

@JvmStatic

fun enableSDK()

Enables the SDK.

fetchAirbridgeGeneratedUUID

@JvmStatic

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

@JvmStatic

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

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

fetchDeviceUUID

@JvmStatic

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

@JvmStatic

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

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

fetchGalaxyStoreInstallReferrerDetails

@JvmStatic

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

@JvmStatic

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

fetch Galaxy store install referrer

fetchGoogleAdvertisingIdInfo

@JvmStatic

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

@JvmStatic

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

fetch Google Advertising ID info

fetchGoogleInstallReferrerDetails

@JvmStatic

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

@JvmStatic

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

fetch Google install referrer

fetchHuaweiAdvertisingIdInfo

@JvmStatic

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

@JvmStatic

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

fetch Huawei Advertising ID info

fetchHuaweiInstallReferrerDetails

@JvmStatic

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

@JvmStatic

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

fetch Huawei install referrer

fetchMetaInstallReferrerDetails

@JvmStatic

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

@JvmStatic

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

fetch Meta install referrer

handleDeeplink

@JvmStatic

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

@JvmStatic

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

@JvmStatic

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

@JvmStatic

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

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

handleWebInterfaceCommand

@JvmStatic

fun handleWebInterfaceCommand(command: String)

Handles command from web interface to implement web interface manually.

impression

@JvmStatic

@JvmOverloads

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

Notifies that the in-app area within the app has been exposed to the user.

@JvmStatic

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

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

initializeSDK

@JvmStatic

fun initializeSDK(app: Application, option: AirbridgeOption)

Initializes the SDK with the provided app and option.

isSDKEnabled

@JvmStatic

fun isSDKEnabled(): Boolean

Checks whether the SDK is currently enabled.

isTrackingEnabled

@JvmStatic

fun isTrackingEnabled(): Boolean

Checks whether the SDK is currently enabled for tracking.

isUninstallTrackingNotification

@JvmStatic

fun isUninstallTrackingNotification(remoteMessage: RemoteMessage): Boolean

check if a push message is uninstall tracking notification

registerPushToken

@JvmStatic

fun registerPushToken(token: String)

Registers the FCM registration token to track app uninstalls.

removeDeviceAlias

@JvmStatic

fun removeDeviceAlias(key: String)

Removes the device alias with the given key.

removeUserAlias

@JvmStatic

fun removeUserAlias(key: String)

Removes the user alias with the given key.

removeUserAttribute

@JvmStatic

fun removeUserAttribute(key: String)

Removes the user attribute with the given key.

setDeviceAlias

@JvmStatic

fun setDeviceAlias(key: String, value: String)

Sets the key, value pair to the device alias.

setUserAlias

@JvmStatic

fun setUserAlias(key: String, value: String)

Sets the key, value pair to the user alias.

setUserAttribute

@JvmStatic

fun setUserAttribute(key: String, value: Boolean)

@JvmStatic

fun setUserAttribute(key: String, value: Double)

@JvmStatic

fun setUserAttribute(key: String, value: Float)

@JvmStatic

fun setUserAttribute(key: String, value: Int)

@JvmStatic

fun setUserAttribute(key: String, value: Long)

@JvmStatic

fun setUserAttribute(key: String, value: String)

Sets the key, value pair to the user attribute.

setUserEmail

@JvmStatic

fun setUserEmail(email: String)

Sets the user email.

setUserID

@JvmStatic

fun setUserID(id: String)

Sets the user ID.

setUserPhone

@JvmStatic

fun setUserPhone(phone: String)

Sets the user phone number.

setWebInterface

@JvmStatic

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.

startTracking

@JvmStatic

fun startTracking()

Start collecting and transferring events.

stopTracking

@JvmStatic

fun stopTracking()

Stop collecting and transferring events.

trackEvent

@JvmStatic

@JvmOverloads

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

Track events.