airbridge/co.ab180.airbridge/AirbridgeOptionBuilder

AirbridgeOptionBuilder

class AirbridgeOptionBuilder(name: String, token: String)

Builder class for creating an AirbridgeOption instance with various configuration options.

Sample usage

Every option's setters are chainable.

AirbridgeOptionBuilder("YOUR_APP_NAME", "YOUR_APP_SDK_TOKEN")
    .setLogLevel(AirbridgeLogLevel.DEBUG)
    .setSDKEnabled(true)
    .build()
Content copied to clipboard

Parameters

name

The app name.

token

The app token.

Constructors

Link copied to clipboard
constructor(name: String, token: String)

Functions

Link copied to clipboard
fun build(): AirbridgeOption

Builds an AirbridgeOption instance with the configured options.

Link copied to clipboard
fun setAutoStartTrackingEnabled(value: Boolean): AirbridgeOptionBuilder

Enables or disables automatic start of event collection and transfer (default value is true).

Link copied to clipboard
fun setClearEventBufferOnInitializeEnabled(value: Boolean): AirbridgeOptionBuilder

Enables or disables emptying the device's internal database of unprocessed events that were not sent to Airbridge (default value is false).

Link copied to clipboard
fun setCollectLocationEnabled(value: Boolean): AirbridgeOptionBuilder

Enables or disables collecting user location information (default value is false).

Link copied to clipboard
fun setCustomDomains(value: List<String>): AirbridgeOptionBuilder

Sets custom domains (default value is emptyList).

Link copied to clipboard
fun setErrorLogCollectionEnabled(value: Boolean): AirbridgeOptionBuilder

Enables or disables sending error logs of the SDK to the Airbridge server to improve the quality of the Airbridge SDK (default value is true).

Link copied to clipboard
fun setEventBufferCountLimit(count: Int): AirbridgeOptionBuilder

Sets the maximum number of events to be stored (default value is Int.MAX_VALUE).

Link copied to clipboard
fun setEventBufferSizeLimit(gibibyte: Double): AirbridgeOptionBuilder

Set the maximum gibibyte size of events to be stored (default value is 1 TiB).

Link copied to clipboard
fun setEventTransmitInterval(second: Long): AirbridgeOptionBuilder

Sets the event transmission interval in seconds (default value is 0).

Link copied to clipboard
fun setHashUserInformationEnabled(value: Boolean): AirbridgeOptionBuilder

Enables or disables hashing of user information for privacy (default value is true).

Link copied to clipboard
fun setLifecycleIntegration(value: AirbridgeLifecycleIntegration): AirbridgeOptionBuilder

Use this method to fetch the correct deep links in exceptional circumstances.

Link copied to clipboard
fun setLogLevel(value: AirbridgeLogLevel): AirbridgeOptionBuilder

Sets the log level (default value is AirbridgeLogLevel.WARNING).

Link copied to clipboard
fun setMetaInstallReferrer(metaAppID: String): AirbridgeOptionBuilder

Sets the Meta(Facebook) ID to collect Meta on-device attribution information (default value is null).

Link copied to clipboard
fun setOnAttributionReceived(value: OnAttributionResultReceiveListener): AirbridgeOptionBuilder

Sets a listener for receiving attribution result data (default value is null).

Link copied to clipboard
fun setPauseEventTransmitOnBackgroundEnabled(value: Boolean): AirbridgeOptionBuilder

Enables or disables the pausing of event transmission when the app is in the background (default value is false).

Link copied to clipboard
fun setSDKAttributes(attributes: Map<String, String>): AirbridgeOptionBuilder

Indicates additional SDK attributes of Airbridge.

Link copied to clipboard
fun setSDKDevelopmentPlatform(value: String): AirbridgeOptionBuilder

Sets the development platform (default value is "native").

Link copied to clipboard
fun setSDKEnabled(value: Boolean): AirbridgeOptionBuilder

Enables or disables Airbridge SDK (default value is true).

Link copied to clipboard
fun setSDKSignature(secretId: String, secretKey: String): AirbridgeOptionBuilder

Sets the SDK signature using the provided secret id and secret key (default value is null).

Link copied to clipboard
fun setSDKWrapperOption(option: Map<String, Any>): AirbridgeOptionBuilder

Indicates additional SDK wrapper option of Airbridge.

Link copied to clipboard
fun setSessionTimeout(second: Long): AirbridgeOptionBuilder

Sets the session timeout in seconds (default value is 300).

Link copied to clipboard
fun setTrackAirbridgeDeeplinkOnlyEnabled(value: Boolean): AirbridgeOptionBuilder

Enables or disables receiving deep link events for Airbridge deep links only (default value is false).

Link copied to clipboard
fun setTrackInSessionLifeCycleEventEnabled(value: Boolean): AirbridgeOptionBuilder

Enables or disables the collection of lifecycle events ORGANIC_REOPEN, FOREGROUND within the session timeframe (default value is false).

Link copied to clipboard
fun setTrackMetaDeferredAppLinkEnabled(value: Boolean): AirbridgeOptionBuilder

Enables or disables the Airbridge SDK to utilize Meta(Facebook)'s deferred app link information (default value is false).