com.amazonaws.mobileconnectors.pinpoint.targeting.notification

Enum NotificationClient.PushResult

java.lang.Object

java.lang.Enum<NotificationClient.PushResult>

com.amazonaws.mobileconnectors.pinpoint.targeting.notification.NotificationClient.PushResult

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NotificationClient.PushResult>

Enclosing class:

NotificationClient

public static enum NotificationClient.PushResult
extends java.lang.Enum<NotificationClient.PushResult>

Result values of handling a Pinpoint push message.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APP_IN_FOREGROUND The SDK handled the message, but no notification was posted, since the app was in the foreground.
NOT_HANDLED The message wasn't for pinpoint.
NOTIFICATION_OPENED The SDK handled the message that indicated the local campaign notification was opened.
OPTED_OUT The SDK handled the message, but no notification was posted, since the app was opted out.
POSTED_NOTIFICATION The SDK handled the message and posted a local notification.
SILENT The SDK handled the message that indicated the local campaign notification was opened.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT_HANDLED

public static final NotificationClient.PushResult NOT_HANDLED

The message wasn't for pinpoint.

POSTED_NOTIFICATION

public static final NotificationClient.PushResult POSTED_NOTIFICATION

The SDK handled the message and posted a local notification.

APP_IN_FOREGROUND

public static final NotificationClient.PushResult APP_IN_FOREGROUND

The SDK handled the message, but no notification was posted, since the app was in the foreground.

OPTED_OUT

public static final NotificationClient.PushResult OPTED_OUT

The SDK handled the message, but no notification was posted, since the app was opted out.

NOTIFICATION_OPENED

public static final NotificationClient.PushResult NOTIFICATION_OPENED

The SDK handled the message that indicated the local campaign notification was opened.

SILENT

public static final NotificationClient.PushResult SILENT

The SDK handled the message that indicated the local campaign notification was opened.

Method Detail

values

public static NotificationClient.PushResult[] 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 (NotificationClient.PushResult c : NotificationClient.PushResult.values())
    System.out.println(c);

Returns:

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

valueOf

public static NotificationClient.PushResult 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