public class

AirshipConfigOptions

extends Object
java.lang.Object
   ↳ com.urbanairship.AirshipConfigOptions

Class Overview

This class holds the set of options necessary to properly initialize UAirship.

Summary

Nested Classes
class AirshipConfigOptions.Builder Airship config builder. 
Constants
String ADM_TRANSPORT The ADM transport type for Push.
String FCM_TRANSPORT The FCM transport type for Push.
String GCM_TRANSPORT The GCM transport type for Push.
Fields
public final String[] allowedTransports The transport types allowed for Push.
public final boolean analyticsEnabled Flag indicating whether the application will use analytics.
public final String analyticsServer The Analytics Server.
public final Uri appStoreUri Optional app store link when using the rate app action.
public final boolean autoLaunchApplication 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.
public final long backgroundReportingIntervalMS Minimum delta in milliseconds between analytics uploads when adding location events while in the background.
public final boolean channelCaptureEnabled Flag indicating whether channel capture feature is enabled or not.
public final boolean channelCreationDelayEnabled Flag indicating whether channel creation delay is enabled or not.
public final boolean clearNamedUser Flag indicating whether to clear an existing named user during a re-install.
public final String developmentAppKey The application's development app key.
public final String developmentAppSecret The application's development app secret.
public final String developmentFcmSenderId The FCM sender ID used for push registration in development mode.
public final int developmentLogLevel Logger level when the application is in debug mode.
public boolean enableUrlWhitelisting Enables/disables whitelist checks for SCOPE_OPEN_URL.
public final String fcmSenderId The FCM sender ID for push registration.
public final String gcmSender This field is deprecated. Use FCM sender ID instead. To be removed in SDK 10.0.
public final String hostURL The Urban Airship URL.
public final boolean inProduction Flag indicating whether the application is in production or development.
public final String landingPageContentURL The landing page content URL.
public final int notificationAccentColor Notification accent color.
public final String notificationChannel The default notification channel.
public final int notificationIcon Notification icon.
public final String productionAppKey The application's production app key.
public final String productionAppSecret The application's production app secret.
public final String productionFcmSenderId The FCM sender ID used for push registration in production mode.
public final int productionLogLevel Logger level when the application is in production mode.
public final String remoteDataURL The remote data server URL.
public final String walletUrl The Wallet URL.
public final String[] whitelist List of URLs that are allowed to be used for various features, including: Urban Airship JS interface, open external URL action, wallet action, HTML in-app messages, and landing pages.
Public Methods
String getAppKey()
Returns the appropriate development or production app key
String getAppSecret()
Returns the appropriate development or production app secret
String getFcmSenderId()
Returns the development or production FCM sender ID.
int getLoggerLevel()
Returns the appropriate development or production log level.
boolean isTransportAllowed(String transport)
Check to see if the specified transport type is allowed.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String ADM_TRANSPORT

The ADM transport type for Push.

Constant Value: "ADM"

public static final String FCM_TRANSPORT

The FCM transport type for Push.

Constant Value: "FCM"

public static final String GCM_TRANSPORT

The GCM transport type for Push.

Constant Value: "GCM"

Fields

public final String[] allowedTransports

The transport types allowed for Push.

Defaults to ADM, GCM, FCM.

public final boolean analyticsEnabled

Flag indicating whether the application will use analytics.

The flag defaults to true.

public final String analyticsServer

The Analytics Server. This will always be set to https://combine.urbanairship.com/

public final Uri appStoreUri

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.

Example: "market://details?id=com.example.android"

public final boolean autoLaunchApplication

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.

Defaults to true.

public final long backgroundReportingIntervalMS

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

Defaults to 15 minutes.

public final boolean channelCaptureEnabled

Flag indicating whether channel capture feature is enabled or not.

The flag defaults to true.

public final boolean channelCreationDelayEnabled

Flag indicating whether channel creation delay is enabled or not.

The flag defaults to false.

public final boolean clearNamedUser

Flag indicating whether to clear an existing named user during a re-install.

Defaults to false.

public final String developmentAppKey

The application's development app key.

This string is generated automatically when you create an app in the Urban Airship dashboard, which you can manually copy into your app configuration.

public final String developmentAppSecret

The application's development app secret.

This string is generated automatically when you create an app in the Urban Airship dashboard, which you can manually copy into your app configuration.

public final String developmentFcmSenderId

The FCM sender ID used for push registration in development mode. This is your Google API project number.

Optional if you are using `urbanairship-fcm` package and want Urban Airship to use the main Firebase application's sender ID.

public final int developmentLogLevel

Logger level when the application is in debug mode. Possible values are:

  • ASSERT
  • NONE
  • DEBUG
  • ERROR
  • INFO
  • VERBOSE
  • WARN

Defaults to DEBUG

public boolean enableUrlWhitelisting

Enables/disables whitelist checks for SCOPE_OPEN_URL. If disabled, any URL checks with scope SCOPE_OPEN_URL will be allowed even if the URL is not in the whitelist.

Defaults to false.

public final String fcmSenderId

The FCM sender ID for push registration. Used as a fallback if the production or development FCM sender ID is not set. This is your Google API project number.

Optional if you are using `urbanairship-fcm` package and want Urban Airship to use the main Firebase application's sender ID.

public final String gcmSender

This field is deprecated.
Use FCM sender ID instead. To be removed in SDK 10.0.

The GCM/FCM sender ID used for push registration. This is your Google API project number.

Will be used in getFcmSenderId() if the fcmSenderId is not set.

public final String hostURL

The Urban Airship URL. This will always be set to http://device-api.urbanairship.com/

public final boolean inProduction

Flag indicating whether the application is in production or development.

Defaults to false.

public final String landingPageContentURL

The landing page content URL. This will always be set to https://dl.urbanairship.com/aaa/

public final int notificationAccentColor

Notification accent color.

public final String notificationChannel

The default notification channel.

public final int notificationIcon

Notification icon.

public final String productionAppKey

The application's production app key.

This string is generated automatically when you create an app in the Urban Airship dashboard, which you can manually copy into your app configuration.

public final String productionAppSecret

The application's production app secret.

This string is generated automatically when you create an app in the Urban Airship dashboard, which you can manually copy into your app configuration.

public final String productionFcmSenderId

The FCM sender ID used for push registration in production mode. This is your Google API project number.

Optional if you are using `urbanairship-fcm` package and want Urban Airship to use the main Firebase application's sender ID.

public final int productionLogLevel

Logger level when the application is in production mode. Possible values are:

  • ASSERT
  • NONE
  • DEBUG
  • ERROR
  • INFO
  • VERBOSE
  • WARN

Defaults to ERROR

public final String remoteDataURL

The remote data server URL.

public final String walletUrl

The Wallet URL. This will always be set to https://wallet-api.urbanairship.com

public final String[] whitelist

List of URLs that are allowed to be used for various features, including: Urban Airship JS interface, open external URL action, wallet action, HTML in-app messages, and landing pages. Urban Airship https URLs are included by default.

See addEntry(String) for valid url patterns.

Defaults null.

Public Methods

public String getAppKey ()

Returns the appropriate development or production app key

Returns
  • The application key

public String getAppSecret ()

Returns the appropriate development or production app secret

Returns
  • The application secret

public String getFcmSenderId ()

Returns the development or production FCM sender ID.

Returns
  • The FCM sender ID.

public int getLoggerLevel ()

Returns the appropriate development or production log level.

Returns
  • The log level

public boolean isTransportAllowed (String transport)

Check to see if the specified transport type is allowed.

Parameters
transport The transport type.
Returns
  • true if the transport type is allowed, otherwise false.