com.appboy.enums

Enum DeviceKey

java.lang.Object

java.lang.Enum<DeviceKey>

com.appboy.enums.DeviceKey

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DeviceKey>

public enum DeviceKey
extends java.lang.Enum<DeviceKey>

Enum for the keys the server is expecting for the device object.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AD_TRACKING_ENABLED Google Advertising ID's limit ad-tracking field.
ANDROID_VERSION The current reported android version.
CARRIER The mobile carrier.
GOOGLE_ADVERTISING_ID The Google Advertising ID.
IS_BACKGROUND_RESTRICTED Whether background restrictions exist on the app.
LOCALE The default locale of the device.
MODEL The specific hardware of the device.
NOTIFICATIONS_ENABLED Whether this app has notifications enabled.
RESOLUTION Device resolution as "x".
TIMEZONE The device time zone.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKey()
static DeviceKey	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DeviceKey[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ANDROID_VERSION

public static final DeviceKey ANDROID_VERSION

The current reported android version.

CARRIER

public static final DeviceKey CARRIER

The mobile carrier.

MODEL

public static final DeviceKey MODEL

The specific hardware of the device.

RESOLUTION

public static final DeviceKey RESOLUTION

Device resolution as "x".

LOCALE

public static final DeviceKey LOCALE

The default locale of the device. The format of this key is "en_US" or "language_COUNTRY".

TIMEZONE

public static final DeviceKey TIMEZONE

The device time zone.

NOTIFICATIONS_ENABLED

public static final DeviceKey NOTIFICATIONS_ENABLED

Whether this app has notifications enabled.

IS_BACKGROUND_RESTRICTED

public static final DeviceKey IS_BACKGROUND_RESTRICTED

Whether background restrictions exist on the app. This should correspond to ActivityManager.isBackgroundRestricted()

GOOGLE_ADVERTISING_ID

public static final DeviceKey GOOGLE_ADVERTISING_ID

The Google Advertising ID. Note that this is not collected automatically by the SDK and must be passed in via IAppboy.setGoogleAdvertisingId(String, boolean)

AD_TRACKING_ENABLED

public static final DeviceKey AD_TRACKING_ENABLED

Google Advertising ID's limit ad-tracking field. Note that when "limit ad tracking" is enabled on the Google Advertising ID, it means that ad tracking should be disabled.

Method Detail

values

public static DeviceKey[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DeviceKey c : DeviceKey.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DeviceKey valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getKey

public java.lang.String getKey()