Class Airbridge

Constructors

constructor

Methods

allowTrackingItem blockTrackingItem clearDeviceAlias clearUser clearUserAlias clearUserAttributes clearUserEmail clearUserID clearUserPhone click createTrackingLink createWebInterfaceScript disableSDK enableSDK fetchAirbridgeGeneratedUUID fetchDeviceUUID handleWebInterfaceCommand impression isInAppPurchaseTrackingEnabled isSDKEnabled isTrackingEnabled isUninstallTrackingNotification registerPushToken removeDeviceAlias removeUserAlias removeUserAttribute setDeviceAlias setOnAttributionReceived setOnDeeplinkReceived setUserAlias setUserAttribute setUserEmail setUserID setUserPhone startInAppPurchaseTracking startTracking stopInAppPurchaseTracking stopTracking trackEvent

Constructors

constructor

Methods

StaticallowTrackingItem

  • allowTrackingItem(item): void

  • Allows tracking for the specified [AirbridgeTrackingBlocklist] item. This function removes the given item from the current TrackingBlocklist applied in the airbridge.json, enabling tracking at runtime.

    Parameters

    Returns void

StaticblockTrackingItem

  • blockTrackingItem(item): void

  • Blocks tracking for the specified [AirbridgeTrackingBlocklist] item. This function adds the given item to the current TrackingBlocklist applied in the airbridge.json, disabling tracking at runtime.

    Parameters

    Returns void

StaticclearDeviceAlias

  • clearDeviceAlias(): void

  • Clears all device aliases.

    Returns void

StaticclearUser

  • clearUser(): void

  • Clears all user information.

    Returns void

StaticclearUserAlias

  • clearUserAlias(): void

  • Clears all user aliases.

    Returns void

StaticclearUserAttributes

  • clearUserAttributes(): void

  • Clears all user attributes.

    Returns void

StaticclearUserEmail

  • clearUserEmail(): void

  • Clear the user email.

    Returns void

StaticclearUserID

  • clearUserID(): void

  • Clear the user ID.

    Returns void

StaticclearUserPhone

  • clearUserPhone(): void

  • Clear the user phone number.

    Returns void

Staticclick

  • click(trackingLink, onSuccess?, onFailure?): Promise<boolean>

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

    Parameters

    • trackingLink: string

      tracking link uri

    • OptionalonSuccess: (() => void)

      Callback to be invoked when tracking link is successfully handled.

        • (): void

        • Returns void

    • OptionalonFailure: ((error: Error) => void)

      Callback to be invoked when any error occurs.

        • (error): void

        • Parameters

          • error: Error

          Returns void

    Returns Promise<boolean>

    true if all of the following conditions are met below, false otherwise.

    • If the SDK is initialized and enabled.
    • If tracking link is successfully handled.

StaticcreateTrackingLink

  • createTrackingLink(channel, option, onSuccess, onFailure?): void

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

    Parameters

    • channel: string

      The channel of tracking-link.

    • option: Record<string, any>

      The option to create tracking-link.

    • onSuccess: ((airbridgeTrackingLink: AirbridgeTrackingLink) => void)

      Created tracking-link is delivered if succeed.

    • OptionalonFailure: ((error: Error) => void)

      Error is delivered if failed.

        • (error): void

        • Parameters

          • error: Error

          Returns void

    Returns void

StaticcreateWebInterfaceScript

  • createWebInterfaceScript(webToken, postMessageScript): Promise<undefined | string>

  • Creates a script that initialize the web interface.

    Parameters

    • webToken: string

      The token to initialize Airbridge Web SDK.

    • postMessageScript: string

      The JavaScript code to post commands from web to app.

    Returns Promise<undefined | string>

    web interface script

StaticdisableSDK

  • disableSDK(): void

  • Disables the SDK.

    Returns void

StaticenableSDK

  • enableSDK(): void

  • Enables the SDK.

    Returns void

StaticfetchAirbridgeGeneratedUUID

  • fetchAirbridgeGeneratedUUID(onSuccess, onFailure?): Promise<boolean>

  • Fetch airbridgeGeneratedUUID of SDK.

    Parameters

    • onSuccess: ((airbridgeGeneratedUUID: string) => void)

      Callback to be invoked when airbridgeGeneratedUUID is successfully handled.

        • (airbridgeGeneratedUUID): void

        • Parameters

          • airbridgeGeneratedUUID: string

          Returns void

    • OptionalonFailure: ((error: Error) => void)

      Callback to be invoked when any error occurs.

        • (error): void

        • Parameters

          • error: Error

          Returns void

    Returns Promise<boolean>

StaticfetchDeviceUUID

  • fetchDeviceUUID(onSuccess, onFailure?): Promise<boolean>

  • Fetch deviceUUID of SDK.

    Parameters

    • onSuccess: ((deviceUUID: string) => void)

      Callback to be invoked when deviceUUID is successfully handled.

        • (deviceUUID): void

        • Parameters

          • deviceUUID: string

          Returns void

    • OptionalonFailure: ((error: Error) => void)

      Callback to be invoked when any error occurs.

        • (error): void

        • Parameters

          • error: Error

          Returns void

    Returns Promise<boolean>

StatichandleWebInterfaceCommand

  • handleWebInterfaceCommand(command): void

  • Handles commands from the web interface.

    Parameters

    • command: string

      The command to handle.

    Returns void

Staticimpression

  • impression(trackingLink, onSuccess?, onFailure?): Promise<boolean>

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

    Parameters

    • trackingLink: string

      tracking link uri

    • OptionalonSuccess: (() => void)

      Callback to be invoked when tracking link is successfully handled.

        • (): void

        • Returns void

    • OptionalonFailure: ((error: Error) => void)

      Callback to be invoked when any error occurs.

        • (error): void

        • Parameters

          • error: Error

          Returns void

    Returns Promise<boolean>

    true if all of the following conditions are met below, false otherwise.

    • If the SDK is initialized and enabled.
    • If tracking link is successfully handled.

StaticisInAppPurchaseTrackingEnabled

  • isInAppPurchaseTrackingEnabled(): Promise<boolean>

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

    Returns Promise<boolean>

    true if the SDK is enabled for in-app-purchase tracking, false otherwise.

StaticisSDKEnabled

  • isSDKEnabled(): Promise<boolean>

  • Checks whether the SDK is currently enabled.

    Returns Promise<boolean>

    true if the SDK is enabled, false otherwise.

StaticisTrackingEnabled

  • isTrackingEnabled(): Promise<boolean>

  • Checks whether the tracking feature of SDK is currently enabled.

    Returns Promise<boolean>

    true if the tracking feature of SDK tracking is enabled,false otherwise.

StaticisUninstallTrackingNotification

  • isUninstallTrackingNotification(notification): boolean

  • Indicates whether notification was sent by Airbridge to track uninstall of app.

    Parameters

    • notification: Record<string, any>

      The notification to check.

    Returns boolean

StaticregisterPushToken

  • registerPushToken(token): void

  • Registers the FCM or APNS registration token to track app uninstalls.

    Parameters

    • token: string

      The FCM or APNS registration token.

    Returns void

StaticremoveDeviceAlias

  • removeDeviceAlias(key): void

  • Removes the device alias with the given key.

    Parameters

    • key: string

      The key that uniquely identifies the device alias.

    Returns void

StaticremoveUserAlias

  • removeUserAlias(key): void

  • Removes the user alias with the given key.

    Parameters

    • key: string

      The key that uniquely identifies the user alias.

    Returns void

StaticremoveUserAttribute

  • removeUserAttribute(key): void

  • Removes the user attribute with the given key.

    Parameters

    • key: string

      The key that uniquely identifies the user attribute.

    Returns void

StaticsetDeviceAlias

  • setDeviceAlias(key, value): void

  • Sets the key, value pair to the device alias.

    Parameters

    • key: string

      The key that uniquely identifies the device alias.

    • value: string

      The value to set for the device alias.

    Returns void

StaticsetOnAttributionReceived

  • setOnAttributionReceived(onReceived): void

  • Sets a listener for receiving attribution of install event.

    Parameters

    • onReceived: ((attribution: Record<string, string>) => void)

      Map of attribution is delivered.

        • (attribution): void

        • Parameters

          • attribution: Record<string, string>

          Returns void

    Returns void

StaticsetOnDeeplinkReceived

  • setOnDeeplinkReceived(onReceived): void

  • Handles deeplink and deferred-deeplink.

    Parameters

    • onReceived: ((deeplink: string) => void)

      URL of deeplink is delivered.

        • (deeplink): void

        • Parameters

          • deeplink: string

          Returns void

    Returns void

StaticsetUserAlias

  • setUserAlias(key, value): void

  • Sets the key, value pair to the user alias.

    Parameters

    • key: string

      The key that uniquely identifies the user alias.

    • value: string

      The value to set for the user alias.

    Returns void

StaticsetUserAttribute

  • setUserAttribute(key, value): void

  • Sets the key, value pair to the user attribute.

    Parameters

    • key: string

      The key that uniquely identifies the user attribute.

    • value: any

      The value to set for the user attribute.

    Returns void

StaticsetUserEmail

  • setUserEmail(email): void

  • Sets the user email.

    Parameters

    • email: string

      The user email.

    Returns void

StaticsetUserID

  • setUserID(id): void

  • Sets the user ID.

    Parameters

    • id: string

      The user ID.

    Returns void

StaticsetUserPhone

  • setUserPhone(phone): void

  • Sets the user phone number.

    Parameters

    • phone: string

      The user phone number.

    Returns void

StaticstartInAppPurchaseTracking

  • startInAppPurchaseTracking(): void

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

    Returns void

StaticstartTracking

  • startTracking(): void

  • Start collecting and transferring events.

    Returns void

StaticstopInAppPurchaseTracking

  • stopInAppPurchaseTracking(): void

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

    Returns void

StaticstopTracking

  • stopTracking(): void

  • Stop collecting and transferring events.

    Returns void

StatictrackEvent

  • trackEvent(category, semanticAttributes?, customAttributes?): void

  • Tracks user behavior through event tracking with attributes.

    Parameters

    • category: string

      Name of event.

    • OptionalsemanticAttributes: Record<string, any>

      Additional attributes of the event that defined by Airbridge.

    • OptionalcustomAttributes: Record<string, any>

      Additional attributes of the event.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods