urbanairship-core/com.urbanairship/AirshipConfigOptions/Builder

Builder

class Builder

Airship config builder.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
@NonNull
open fun applyConfig(@NonNull context: Context, @XmlRes xmlResourceId: Int): AirshipConfigOptions.Builder
Apply options from a xml resource file.
Link copied to clipboard
@NonNull
open fun applyDefaultProperties(@NonNull context: Context): AirshipConfigOptions.Builder
Apply the options from the default properties file airshipconfig.properties.
Link copied to clipboard
@NonNull
open fun applyProperties(@NonNull context: Context, @NonNull propertiesFile: String): AirshipConfigOptions.Builder
Apply the options from a given properties file.
@NonNull
open fun applyProperties(@NonNull context: Context, @NonNull properties: Properties): AirshipConfigOptions.Builder
Applies properties from a given Properties object.
Link copied to clipboard
@NonNull
open fun build(): AirshipConfigOptions
Builds the config options.
Link copied to clipboard
@NonNull
open fun detectProvisioningMode(@NonNull context: Context): AirshipConfigOptions.Builder
Automatically determine the provisioning mode of the application.
Link copied to clipboard
@NonNull
open fun setAllowedTransports(@Nullable allowedTransports: Array<String>): AirshipConfigOptions.Builder
Set the transport types allowed for Push.
Link copied to clipboard
@NonNull
open fun setAnalyticsEnabled(analyticsEnabled: Boolean): AirshipConfigOptions.Builder
Set the flag indicating whether the application will use analytics.
Link copied to clipboard
@NonNull
open fun setAppKey(@Nullable appKey: String): AirshipConfigOptions.Builder
Set the default app key.
Link copied to clipboard
@NonNull
open fun setAppSecret(@Nullable appSecret: String): AirshipConfigOptions.Builder
Set the default app secret.
Link copied to clipboard
@NonNull
open fun setAppStoreUri(@Nullable appStoreUri: Uri): AirshipConfigOptions.Builder
Sets the app store URI for the rate-app action.
Link copied to clipboard
@NonNull
open fun setAutoLaunchApplication(autoLaunchApplication: Boolean): AirshipConfigOptions.Builder
Set the flag indicating whether or not to launch the launcher activity when a push notification or push notification button is opened and the application intent receiver did not launch an activity.
Link copied to clipboard
@NonNull
open fun setAutoPauseInAppAutomationOnLaunch(autoPauseInAppAutomationOnLaunch: Boolean): AirshipConfigOptions.Builder
Set the auto pause In-App Automation on launch.
Link copied to clipboard
@NonNull
open fun setBackgroundReportingIntervalMS(backgroundReportingIntervalMS: Long): AirshipConfigOptions.Builder
Set the background reporting interval.
Link copied to clipboard
@NonNull
open fun setChannelCaptureEnabled(channelCaptureEnabled: Boolean): AirshipConfigOptions.Builder
Set the flag indicating whether channel capture feature is enabled or not.
Link copied to clipboard
@NonNull
open fun setChannelCreationDelayEnabled(channelCreationDelayEnabled: Boolean): AirshipConfigOptions.Builder
Set the flag indicating whether channel creation delay is enabled or not.
Link copied to clipboard
@NonNull
open fun setDataCollectionOptInEnabled(dataCollectionOptInEnabled: Boolean): AirshipConfigOptions.Builder
Set the flag indicating whether data collection needs to be opted in with setDataCollectionEnabled.
Link copied to clipboard
@NonNull
open fun setDevelopmentAppKey(@Nullable developmentAppKey: String): AirshipConfigOptions.Builder
Set the application's development app key.
Link copied to clipboard
@NonNull
open fun setDevelopmentAppSecret(@Nullable developmentAppSecret: String): AirshipConfigOptions.Builder
Set the application's development app secret.
Link copied to clipboard
@NonNull
open fun setDevelopmentLogLevel(developmentLogLevel: Int): AirshipConfigOptions.Builder
Set the logger level when the application is in debug mode.
Link copied to clipboard
@NonNull
open fun setEnabledFeatures(enabledFeatures: Array<PrivacyManager.Feature>): AirshipConfigOptions.Builder
Sets the default enabled SDK features.
Link copied to clipboard
@NonNull
open fun setExtendedBroadcastsEnabled(extendedBroadcastsEnabled: Boolean): AirshipConfigOptions.Builder
Set the flag indicating whether extended broadcasts are enabled or disabled.
Link copied to clipboard
@NonNull
open fun setFcmFirebaseAppName(@Nullable fcmFirebaseAppName: String): AirshipConfigOptions.Builder
Sets the Firebase app name that is used for FCM.
Link copied to clipboard
@NonNull
open fun setInitialConfigUrl(@Nullable initialConfigUrl: String): AirshipConfigOptions.Builder
The Airship URL used to pull the initial config.
Link copied to clipboard
@NonNull
open fun setInProduction(inProduction: Boolean): AirshipConfigOptions.Builder
Set the flag indicating whether the application is in production or development.
@NonNull
open fun setIsPromptForPermissionOnUserNotificationsEnabled(enabled: Boolean): AirshipConfigOptions.Builder
Sets if when enabling setUserNotificationsEnabled if the SDK should prompt for permission on Android 13+ devices.
Link copied to clipboard
@NonNull
open fun setLogLevel(logLevel: Int): AirshipConfigOptions.Builder
Set the default logger level.
Link copied to clipboard
@NonNull
open fun setNotificationAccentColor(@ColorInt notificationAccentColor: Int): AirshipConfigOptions.Builder
Sets the default notification accent color.
Link copied to clipboard
@NonNull
open fun setNotificationChannel(@Nullable channel: String): AirshipConfigOptions.Builder
Sets the default notification channel.
Link copied to clipboard
@NonNull
open fun setNotificationIcon(@DrawableRes notificationIcon: Int): AirshipConfigOptions.Builder
Sets the default notification Icon.
Link copied to clipboard
@NonNull
open fun setNotificationLargeIcon(@DrawableRes notificationLargeIcon: Int): AirshipConfigOptions.Builder
Sets the large notification Icon.
Link copied to clipboard
@NonNull
open fun setProductionAppKey(@Nullable productionAppKey: String): AirshipConfigOptions.Builder
Set the application's production app key.
Link copied to clipboard
@NonNull
open fun setProductionAppSecret(@Nullable productionAppSecret: String): AirshipConfigOptions.Builder
Set the application's production app secret.
Link copied to clipboard
@NonNull
open fun setProductionLogLevel(productionLogLevel: Int): AirshipConfigOptions.Builder
Set the logger level when the application is in production mode.
Link copied to clipboard
@NonNull
open fun setRequireInitialRemoteConfigEnabled(requireInitialRemoteConfigEnabled: Boolean): AirshipConfigOptions.Builder
Sets the flag to require initial remote-config for device URLs.
Link copied to clipboard
@NonNull
open fun setResetEnabledFeatures(resetEnabledFeatures: Boolean): AirshipConfigOptions.Builder
Set the reset enabled features option.
Link copied to clipboard
@NonNull
open fun setSite(@NonNull site: String): AirshipConfigOptions.Builder
Sets the Airship cloud site for data locality.
Link copied to clipboard
@NonNull
open fun setUrlAllowList(@Nullable urlAllowList: Array<String>): AirshipConfigOptions.Builder
Sets the additional URLs that will be added to the allow list for both SCOPE_OPEN_URL and SCOPE_JAVASCRIPT_INTERFACE scopes.
Link copied to clipboard
@NonNull
open fun setUrlAllowListScopeJavaScriptInterface(@Nullable urlAllowListScopeJavaScriptInterface: Array<String>): AirshipConfigOptions.Builder
Sets the additional URLs that will be added to the allow list for scope SCOPE_JAVASCRIPT_INTERFACE.
Link copied to clipboard
@NonNull
open fun setUrlAllowListScopeOpenUrl(@Nullable urlAllowListScopeOpenUrl: Array<String>): AirshipConfigOptions.Builder
Sets the additional URLs that will be added to the allow list for scope SCOPE_OPEN_URL.
Link copied to clipboard
@NonNull
open fun tryApplyConfig(@NonNull context: Context, @XmlRes xmlResourceId: Int): AirshipConfigOptions.Builder
The same as applyConfig, but throws an exception instead of logging an error.
Link copied to clipboard
@NonNull
open fun tryApplyDefaultProperties(@NonNull context: Context): AirshipConfigOptions.Builder
Same as applyDefaultProperties, but throws an exception instead of logging an error.
Link copied to clipboard
@NonNull
open fun tryApplyProperties(@NonNull context: Context, @NonNull propertiesFile: String): AirshipConfigOptions.Builder
Same as applyProperties, but throws an exception instead of logging an error.
@NonNull
open fun tryApplyProperties(@NonNull context: Context, @NonNull properties: Properties): AirshipConfigOptions.Builder
The same as applyProperties, but throws an exception instead of logging an error.