AirshipConfigOptions

This class holds the set of options necessary to properly initialize com.urbanairship.Airship.

Types

Link copied to clipboard
class Builder

Airship config builder.

Link copied to clipboard
object Companion
Link copied to clipboard
class ConfigException(message: String, throwable: Throwable?) : Exception

Config exceptions when trying to load properties from a resource.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Properties

Link copied to clipboard

The transport types allowed for Push.

Link copied to clipboard

Flag indicating whether the application will use analytics.

Link copied to clipboard

Airship app key.

Link copied to clipboard

Airship app secret.

Link copied to clipboard

Optional app store link when using the rate app action. If not set, the action will generate it using hte app's current package name.

Link copied to clipboard

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

Flag indicating whether or not the SDK will automatically pause In-App Automation during app launch. Defaults to false.

Link copied to clipboard

Minimum delta in milliseconds between analytics uploads when adding location events while in the background.

Link copied to clipboard

Flag indicating whether channel capture feature is enabled or not.

Link copied to clipboard

Defines the procedure for creating a new channel. Implement the interface carefully to avoid potential issues such as having multiple devices with the same channel id or unpredicted Airship setup time.. When the method is set to com.urbanairship.channel.ChannelGenerationMethod.Restore, the user must provide a unique channel ID.

Link copied to clipboard

Flag indicating whether channel creation delay is enabled or not.

Link copied to clipboard

Flag indicating if the data collection opt-in is enabled.

Link copied to clipboard

Default enabled Airship features for the app. For more details, see PrivacyManager. Defaults to PrivacyManager.Feature.ALL.

Link copied to clipboard

Flag indicating whether or not to perform extended broadcasts.

Link copied to clipboard

The Firebase app name to use for FCM instead of the default app.

Link copied to clipboard

The initial config URL.

Link copied to clipboard

Flag indicating whether the application is in production.

Link copied to clipboard
Link copied to clipboard

Flag indicating whether or not the SDK will automatically prompt for notification permission when enabling notifications with com.urbanairship.push.PushManager.setUserNotificationsEnabled.

Link copied to clipboard

Logger level when the application is in debug mode. Defaults to DEBUG

Link copied to clipboard

Notification accent color.

Link copied to clipboard

The default notification channel.

Link copied to clipboard

Notification icon.

Link copied to clipboard

Large notification icon.

Link copied to clipboard

Flag indicating whether the SDK will wait for an initial remote config instead of falling back on default API URLs.

Link copied to clipboard

Allows resetting enabled features to match the runtime config defaults on each takeOff Defaults to false.

Link copied to clipboard

Additional URLs that will be added to the allow list for both UrlAllowList.SCOPE_OPEN_URL and UrlAllowList.SCOPE_JAVASCRIPT_INTERFACE scopes.

Link copied to clipboard

Additional URLs that will be added to the allow list for scope UrlAllowList.SCOPE_JAVASCRIPT_INTERFACE.

Link copied to clipboard

Additional URLs that will be added to the allow list for scope UrlAllowList.SCOPE_OPEN_URL. See UrlAllowList.addEntry for valid URL patterns.

Link copied to clipboard

Overrides the input validation used by Preference Center and Scenes.

Functions

Link copied to clipboard
fun validate()

Validates the config.