com.iterable.iterableapi

Class IterableConfig.Builder

java.lang.Object

com.iterable.iterableapi.IterableConfig.Builder

Enclosing class:

IterableConfig

public static class IterableConfig.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
IterableConfig	build()
IterableConfig.Builder	setAuthHandler(IterableAuthHandler authHandler) Set a custom auth handler that can be used to retrieve a new auth token
IterableConfig.Builder	setAutoPushRegistration(boolean enabled) Enable or disable automatic push token registration If set to `true`, the SDK will automatically register the push token when you call IterableApi.setUserId(String) or IterableApi.setEmail(String) and disable the old device entry when the user logs out
IterableConfig.Builder	setCheckForDeferredDeeplink(boolean checkForDeferredDeeplink) When set to true, it will check for deferred deep links on first time app launch after installation.
IterableConfig.Builder	setCustomActionHandler(IterableCustomActionHandler customActionHandler) Set an action handler for custom actions
IterableConfig.Builder	setExpiringAuthTokenRefreshPeriod(java.lang.Long period) Set a custom period before an auth token expires to automatically retrieve a new token
IterableConfig.Builder	setInAppDisplayInterval(double inAppDisplayInterval) Set the in-app message display interval: the number of seconds to wait before showing the next in-app message, if there are multiple messages in the queue
IterableConfig.Builder	setInAppHandler(IterableInAppHandler inAppHandler) Set a custom in-app handler that can be used to control whether an incoming in-app message should be shown immediately or not
IterableConfig.Builder	setLogLevel(int logLevel) Set the log level for Iterable SDK log messages
IterableConfig.Builder	setPushIntegrationName(java.lang.String pushIntegrationName) Push integration name - used for token registration Make sure the name of this integration matches the one set up in Iterable console If this field is not set, Iterable SDK defaults it to the app's package name
IterableConfig.Builder	setUrlHandler(IterableUrlHandler urlHandler) Set a custom URL handler to override openUrl actions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setPushIntegrationName

@NonNull
public IterableConfig.Builder setPushIntegrationName(@NonNull
                                                              java.lang.String pushIntegrationName)

Push integration name - used for token registration Make sure the name of this integration matches the one set up in Iterable console If this field is not set, Iterable SDK defaults it to the app's package name

Parameters:

pushIntegrationName - Push integration name

setUrlHandler

@NonNull
public IterableConfig.Builder setUrlHandler(@NonNull
                                                     IterableUrlHandler urlHandler)

Set a custom URL handler to override openUrl actions

Parameters:

urlHandler - Custom URL handler provided by the app

setCustomActionHandler

@NonNull
public IterableConfig.Builder setCustomActionHandler(@NonNull
                                                              IterableCustomActionHandler customActionHandler)

Set an action handler for custom actions

Parameters:

customActionHandler - Custom action handler provided by the app

setAutoPushRegistration

@NonNull
public IterableConfig.Builder setAutoPushRegistration(boolean enabled)

Enable or disable automatic push token registration If set to `true`, the SDK will automatically register the push token when you call IterableApi.setUserId(String) or IterableApi.setEmail(String) and disable the old device entry when the user logs out

Parameters:

enabled - Enable automatic push token registration

setCheckForDeferredDeeplink

@NonNull
public IterableConfig.Builder setCheckForDeferredDeeplink(boolean checkForDeferredDeeplink)

When set to true, it will check for deferred deep links on first time app launch after installation.

Parameters:

checkForDeferredDeeplink - Enable deferred deep link checks on first launch

setLogLevel

@NonNull
public IterableConfig.Builder setLogLevel(int logLevel)

Set the log level for Iterable SDK log messages

Parameters:

logLevel - Log level, defaults to Log.ERROR

setInAppHandler

@NonNull
public IterableConfig.Builder setInAppHandler(@NonNull
                                                       IterableInAppHandler inAppHandler)

Set a custom in-app handler that can be used to control whether an incoming in-app message should be shown immediately or not

Parameters:

inAppHandler - In-app handler provided by the app

setInAppDisplayInterval

@NonNull
public IterableConfig.Builder setInAppDisplayInterval(double inAppDisplayInterval)

Set the in-app message display interval: the number of seconds to wait before showing the next in-app message, if there are multiple messages in the queue

Parameters:

inAppDisplayInterval - display interval in seconds

setAuthHandler

@NonNull
public IterableConfig.Builder setAuthHandler(@NonNull
                                                      IterableAuthHandler authHandler)

Set a custom auth handler that can be used to retrieve a new auth token

Parameters:

authHandler - Auth handler provided by the app

setExpiringAuthTokenRefreshPeriod

@NonNull
public IterableConfig.Builder setExpiringAuthTokenRefreshPeriod(@NonNull
                                                                         java.lang.Long period)

Set a custom period before an auth token expires to automatically retrieve a new token

Parameters:

period - in seconds

build

@NonNull
public IterableConfig build()