java.lang.Object | |
↳ | com.urbanairship.AirshipConfigOptions |
This class holds the set of options necessary to properly initialize
UAirship
.
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | ADM_TRANSPORT | The ADM transport type for Push. | |||||||||
String | GCM_TRANSPORT | The GCM transport type for Push. |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
public String[] | additionalGCMSenderIds |
This field is deprecated.
Marked to be removed in 7.0.0. Register additional sender IDs directly with GCM using
InstanceID.getInstance(context).getToken(senderId, GoogleCloudMessaging.INSTANCE_ID_SCOPE, null) .
|
|||||||||
public String[] | allowedTransports | The transport types allowed for Push. | |||||||||
public boolean | analyticsEnabled | Flag indicating whether the application will use analytics. | |||||||||
public String | analyticsServer | The Analytics Server. | |||||||||
public 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 long | backgroundReportingIntervalMS | Minimum delta in milliseconds between analytics uploads when adding location events while in the background. | |||||||||
public boolean | channelCaptureEnabled | Flag indicating whether channel capture feature is enabled or not. | |||||||||
public boolean | channelCreationDelayEnabled | Flag indicating whether channel creation delay is enabled or not. | |||||||||
public boolean | clearNamedUser | Flag indicating whether to clear an existing named user during a re-install. | |||||||||
public String | developmentAppKey | The application's development app key. | |||||||||
public String | developmentAppSecret | The application's development app secret. | |||||||||
public int | developmentLogLevel | Logger level when the application is in debug mode. | |||||||||
public String | gcmSender | The sender ID used to send GCM pushes. | |||||||||
public String | hostURL | The Urban Airship URL. | |||||||||
public boolean | inProduction | Flag indicating whether the application is in production or development. | |||||||||
public String | landingPageContentURL | The landing page content URL. | |||||||||
public int | minSdkVersion | This field is deprecated. Will be removed in 7.0.0. No longer used. | |||||||||
public String | productionAppKey | The application's production app key. | |||||||||
public String | productionAppSecret | The application's production app secret. | |||||||||
public int | productionLogLevel | Logger level when the application is in production mode. | |||||||||
public String[] | whitelist | List of additional url patterns that will be allowed access to the Urban Airship Javascript Interface (Urban Airship https URLs are included by default). |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
AirshipConfigOptions() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String |
getAppKey()
Returns the appropriate development or production app key
| ||||||||||
String |
getAppSecret()
Returns the appropriate development or production app secret
| ||||||||||
Set<String> |
getGCMSenderIds()
This method is deprecated.
Marked to be removed in 7.0.0.
| ||||||||||
int |
getLoggerLevel()
Returns the appropriate development or production log level.
| ||||||||||
boolean |
isTransportAllowed(String transport)
Check to see if the specified transport type is allowed.
| ||||||||||
boolean | isValid() | ||||||||||
static AirshipConfigOptions |
loadDefaultOptions(Context ctx)
Convenience method for loading the default options from a properties
file
| ||||||||||
void |
loadFromProperties(Context ctx, String propertiesFile)
Load the options from a given properties file
| ||||||||||
void |
loadFromProperties(Context ctx)
Load the options from the default properties file
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
This field is deprecated.
Marked to be removed in 7.0.0. Register additional sender IDs directly with GCM using
InstanceID.getInstance(context).getToken(senderId, GoogleCloudMessaging.INSTANCE_ID_SCOPE, null)
.
Additional sender IDs to register with GCM. Only messages sent from the sender gcmSender
will
be handled by Urban Airship.
Flag indicating whether the application will use analytics.
The flag defaults to true.The Analytics Server. This will always be set to https://combine.urbanairship.com/
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.Minimum delta in milliseconds between analytics uploads when adding location events while in the background.
Defaults to 15 minutes.Flag indicating whether channel capture feature is enabled or not.
The flag defaults to true.Flag indicating whether channel creation delay is enabled or not.
The flag defaults to false.Flag indicating whether to clear an existing named user during a re-install.
Defaults tofalse
.
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.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.Logger level when the application is in debug mode. Possible values are:
DEBUG
The sender ID used to send GCM pushes. This is your Google API project number.
The Urban Airship URL. This will always be set to http://device-api.urbanairship.com/
Flag indicating whether the application is in production or development.
Defaults tofalse
.
The landing page content URL. This will always be set to https://dl.urbanairship.com/aaa/
This field is deprecated.
Will be removed in 7.0.0. No longer used.
The minSdkVersion is the minimum Android API Level required for the application to run.
Defaults to 4 (DONUT)
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.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.Logger level when the application is in production mode. Possible values are:
ERROR
List of additional url patterns that will be allowed access to the Urban Airship Javascript
Interface (Urban Airship https URLs are included by default). See addEntry(String)
for valid url patterns.
Returns the appropriate development or production app key
Returns the appropriate development or production app secret
This method is deprecated.
Marked to be removed in 7.0.0.
Helper method to get the set of GCM sender IDs.
Returns the appropriate development or production log level.
Check to see if the specified transport type is allowed.
transport | The transport type. |
---|
true
if the transport type is allowed, otherwise false
.
Convenience method for loading the default options from a properties file
ctx | The application context |
---|
Load the options from a given properties file
ctx | The application context |
---|---|
propertiesFile | The properties file |
Load the options from the default properties file
ctx | The application context |
---|