Properties
The transport types allowed for Push.
The flag indicating whether the application will use analytics.
The app store URI for the rate-app action. If not set, the action will generate it using the app's current package name.
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.
The auto pause In-App Automation on launch.
The background reporting interval in milliseconds.
The flag indicating whether channel capture feature is enabled or not.
The Airship channel create option
The flag indicating whether channel creation delay is enabled or not.
Used to set a custom push provider for push registration.
The flag indicating whether data collection needs to be opted in with Airship.setDataCollectionEnabled.
The application's development app key.
The application's development app secret.
The logger level when the application is in debug mode.
The development log privacy level.
The default enabled SDK features. See PrivacyManager for more info.
The flag indicating whether extended broadcasts are enabled or disabled.
The Firebase app name that is used for FCM. If set, the app name must exist in order for Airship to get registration token. The app should be initialized with Firebase before takeOff, or during onAirshipReady callback.
The Airship URL used to pull the initial config. This should only be set if you are using custom domains that forward to Airship.
The flag indicating whether the application is in production or development.
When enabled sets com.urbanairship.push.PushManager.setUserNotificationsEnabled if the SDK should prompt for permission on Android 13+ devices. Enabled by default.
The default logger level.
The default notification accent color. See com.urbanairship.push.notifications.AirshipNotificationProvider.setDefaultAccentColor.
The default notification channel. See com.urbanairship.push.notifications.NotificationProvider.onCreateNotificationArguments
The default notification Icon. See com.urbanairship.push.notifications.AirshipNotificationProvider.setSmallIcon.
The large notification Icon. See com.urbanairship.push.notifications.AirshipNotificationProvider.setLargeIcon.
The application's production app key.
The application's production app secret.
The logger level when the application is in production mode.
The production log privacy level.
The flag to require initial remote-config for device URLs.
The reset enabled features option.
The Airship cloud site for data locality.
The additional URLs that will be added to the allow list for both UrlAllowList.SCOPE_OPEN_URL and UrlAllowList.SCOPE_JAVASCRIPT_INTERFACE scopes. See UrlAllowList.addEntry for valid URL patterns.
The additional URLs that will be added to the allow list for scope UrlAllowList.SCOPE_JAVASCRIPT_INTERFACE. See UrlAllowList.addEntry for valid URL patterns.
The additional URLs that will be added to the allow list for scope UrlAllowList.SCOPE_OPEN_URL. See UrlAllowList.addEntry for valid URL patterns.
Overrides the input validation used by Preference Center and Scenes.
Functions
Apply options from a xml resource file. The XML file must contain the element AirshipConfigOptions and any public AirshipConfigOptions fields should be set as attributes on the element. Example:
Apply the options from the default properties file airshipconfig.properties.
Applies properties from a given Properties object.
Apply the options from a given properties file. The properties file should be available in the assets directory. The properties file can define any of the public AirshipConfigOptions fields. Example:
Builds the config options.
Automatically determine the provisioning mode of the application.
Set the Airship channel create option
Set the transport types allowed for Push.
Set the flag indicating whether the application will use analytics.
Set the default app key.
Set the default app secret.
Sets the app store URI for the rate-app action. If not set, the action will generate it using the app's current package name.
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.
Set the auto pause In-App Automation on launch.
Set the background reporting interval.
Set the flag indicating whether channel capture feature is enabled or not.
Set the flag indicating whether channel creation delay is enabled or not.
Set the flag indicating whether data collection needs to be opted in with Airship.setDataCollectionEnabled.
Set the application's development app key.
Set the application's development app secret.
Set the logger level when the application is in debug mode.
Sets the default enabled SDK features. See PrivacyManager for more info.
Set the flag indicating whether extended broadcasts are enabled or disabled.
Sets the Firebase app name that is used for FCM. If set, the app name must exist in order for Airship to get registration token. The app should be initialized with Firebase before takeOff, or during onAirshipReady callback.
The Airship URL used to pull the initial config. This should only be set if you are using custom domains that forward to Airship.
Set the flag indicating whether the application is in production or development.
Overrides the input validation used by Preference Center and Scenes.
Sets if when enabling com.urbanairship.push.PushManager.setUserNotificationsEnabled if the SDK should prompt for permission on Android 13+ devices. Enabled by default.
Set the default logger level.
Sets the default notification accent color.
Sets the default notification channel.
Sets the default notification Icon.
Sets the large notification Icon.
Set the application's production app key.
Set the application's production app secret.
Set the logger level when the application is in production mode.
Sets the flag to require initial remote-config for device URLs.
Set the reset enabled features option.
Sets the Airship cloud site for data locality.
Sets the additional URLs that will be added to the allow list for both UrlAllowList.SCOPE_OPEN_URL and UrlAllowList.SCOPE_JAVASCRIPT_INTERFACE scopes. See UrlAllowList.addEntry for valid URL patterns.
Sets the additional URLs that will be added to the allow list for scope UrlAllowList.SCOPE_JAVASCRIPT_INTERFACE. See UrlAllowList.addEntry for valid URL patterns.
Sets the additional URLs that will be added to the allow list for scope UrlAllowList.SCOPE_OPEN_URL. See UrlAllowList.addEntry for valid URL patterns.
The same as .applyConfig, but throws an exception instead of logging an error.
Same as applyDefaultProperties, but throws an exception instead of logging an error.
The same as applyProperties, but throws an exception instead of logging an error.
Same as applyProperties, but throws an exception instead of logging an error.