urbanairship-core/com.urbanairship.push/PushMessage

PushMessage

open class PushMessage : Parcelable, JsonSerializable

A push message, usually created from handling a message intent from either GCM, or another push notification service

Constructors

PushMessage

constructor(@NonNull pushBundle: Bundle)

Create a new PushMessage

constructor(@NonNull data: Map<String, String>)

Create a new PushMessage

Properties

EXTRA_ACTIONS

@NonNull

val EXTRA_ACTIONS: String = "com.urbanairship.actions"

The actions extra key holds the payload of actions to be performed with the push.

EXTRA_ALERT

@NonNull

val EXTRA_ALERT: String = "com.urbanairship.push.ALERT"

The alert extra holds the string sent in the "alert" field of an Airship Push Notification.

EXTRA_CATEGORY

@NonNull

val EXTRA_CATEGORY: String = "com.urbanairship.category"

The extra key for the category of the notification.

EXTRA_DELIVERY_PRIORITY

@NonNull

val EXTRA_DELIVERY_PRIORITY: String = "com.urbanairship.priority"

The extra key for the delivery priority.

EXTRA_EXPIRATION

@NonNull

val EXTRA_EXPIRATION: String = "com.urbanairship.push.EXPIRATION"

The EXPIRATION extra is a time expressed in seconds since the Epoch after which, if specified, the notification should not be delivered.

EXTRA_FOREGROUND_DISPLAY

@NonNull

val EXTRA_FOREGROUND_DISPLAY: String = "com.urbanairship.foreground_display"

The extra key to control the notification display in the foreground.

EXTRA_ICON

@NonNull

val EXTRA_ICON: String = "com.urbanairship.icon"

The extra key indicates the name of an icon to use from an app's drawable resources.

EXTRA_ICON_COLOR

@NonNull

val EXTRA_ICON_COLOR: String = "com.urbanairship.icon_color"

The extra key indicates the icon color.

EXTRA_IN_APP_MESSAGE

@NonNull

val EXTRA_IN_APP_MESSAGE: String = "com.urbanairship.in_app"

The extra key for the the legacy in-app message payload.

EXTRA_INTERACTIVE_ACTIONS

@NonNull

val EXTRA_INTERACTIVE_ACTIONS: String = "com.urbanairship.interactive_actions"

The extra key for the payload of Airship actions to be run when an interactive notification action button is opened.

EXTRA_INTERACTIVE_TYPE

@NonNull

val EXTRA_INTERACTIVE_TYPE: String = "com.urbanairship.interactive_type"

The extra key for the interactive notification group that will be displayed with a push.

EXTRA_LIVE_UPDATE

@NonNull

val EXTRA_LIVE_UPDATE: String = "com.urbanairship.live_update"

The Live Update payload.

EXTRA_LOCAL_ONLY

@NonNull

val EXTRA_LOCAL_ONLY: String = "com.urbanairship.local_only"

The extra key indicates if the notification should only be displayed on the device.

EXTRA_METADATA

@NonNull

val EXTRA_METADATA: String = "com.urbanairship.metadata"

The push metadata extra holds the encrypted push identifiers sent in an Airship Push Notification.

EXTRA_NOTIFICATION_CHANNEL

@NonNull

val EXTRA_NOTIFICATION_CHANNEL: String = "com.urbanairship.notification_channel"

The extra key for the channel to be used when posting a notification.

EXTRA_NOTIFICATION_TAG

@NonNull

val EXTRA_NOTIFICATION_TAG: String = "com.urbanairship.notification_tag"

The extra key for the tag to be used when posting a notification.

EXTRA_PRIORITY

@NonNull

val EXTRA_PRIORITY: String = "com.urbanairship.priority"

The extra key for the priority of the notification.

EXTRA_PUBLIC_NOTIFICATION

@NonNull

val EXTRA_PUBLIC_NOTIFICATION: String = "com.urbanairship.public_notification"

The extra key for the public notification payload.

EXTRA_PUSH_ID

@NonNull

val EXTRA_PUSH_ID: String = "com.urbanairship.push.CANONICAL_PUSH_ID"

The push ID extra is the ID assigned to a push at the time it is sent.

EXTRA_RICH_PUSH_ID

@NonNull

val EXTRA_RICH_PUSH_ID: String = "_uamid"

The rich push extra that contains the rich push message ID.

EXTRA_SEND_ID

@NonNull

val EXTRA_SEND_ID: String = "com.urbanairship.push.PUSH_ID"

The push ID extra holds the unique push ID sent in an Airship Push Notification.

EXTRA_SOUND

@NonNull

val ~~EXTRA_SOUND~~: String = "com.urbanairship.sound"

The extra key for the sound of the notification.

EXTRA_STYLE

@NonNull

val EXTRA_STYLE: String = "com.urbanairship.style"

The extra key for the style of the notification.

EXTRA_SUMMARY

@NonNull

val EXTRA_SUMMARY: String = "com.urbanairship.summary"

The extra key for the summary of the notification.

EXTRA_TITLE

@NonNull

val EXTRA_TITLE: String = "com.urbanairship.title"

The extra key for the title of the notification.

EXTRA_VISIBILITY

@NonNull

val EXTRA_VISIBILITY: String = "com.urbanairship.visibility"

The extra key for the notification's visibility in the lockscreen.

EXTRA_WEARABLE

@NonNull

val EXTRA_WEARABLE: String = "com.urbanairship.wearable"

The extra key for the wearable payload.

PRIORITY_HIGH

@NonNull

val PRIORITY_HIGH: String = "high"

Constant for the extra EXTRA_DELIVERY_PRIORITY that indicates the push is high priority.

pushBundle

@get:NonNull

open val pushBundle: Bundle

Inherited properties

CONTENTS_FILE_DESCRIPTOR

val CONTENTS_FILE_DESCRIPTOR: Int = 1

PARCELABLE_WRITE_RETURN_VALUE

val PARCELABLE_WRITE_RETURN_VALUE: Int = 1

Functions

containsAirshipKeys

open fun containsAirshipKeys(): Boolean

Checks the message for Airship keys.

containsKey

open fun containsKey(@NonNull key: String): Boolean

Checks if the push message contains a key.

describeContents

open fun describeContents(): Int

equals

open fun equals(@Nullable o: Any): Boolean

fromJsonValue

@NonNull

open fun fromJsonValue(@NonNull jsonValue: JsonValue): PushMessage

Creates a push message from a json value.

getActions

@NonNull

open fun getActions(): Map<String, ActionValue>

Gets the push message's actions.

getAlert

@Nullable

open fun getAlert(): String

Gets the notification alert

getCanonicalPushId

@Nullable

open fun getCanonicalPushId(): String

Gets the message's canonical push ID

getCategory

@Nullable

open fun getCategory(): String

Gets the category of the notification.

getExtra

@Nullable

open fun getExtra(@NonNull key: String): String

@NonNull

open fun getExtra(@NonNull key: String, @NonNull defaultValue: String): String

Gets an extra from the push bundle.

getIcon

@DrawableRes

open fun getIcon(@NonNull context: Context, defaultIcon: Int): Int

Gets the notification icon image.

getIconColor

open fun getIconColor(defaultColor: Int): Int

Gets the notification icon color.

getInteractiveActionsPayload

@Nullable

open fun getInteractiveActionsPayload(): String

Gets the notification actions payload.

getInteractiveNotificationType

@Nullable

open fun getInteractiveNotificationType(): String

Gets the notification action button type.

getLiveUpdatePayload

@Nullable

open fun getLiveUpdatePayload(): String

Gets the Live Update payload, if present.

getMetadata

@Nullable

open fun getMetadata(): String

Gets the push send metadata.

getNotificationChannel

@Nullable

open fun getNotificationChannel(): String

Returns the notification channel that should be used when posting the notification.

@Nullable

open fun getNotificationChannel(@Nullable defaultChannel: String): String

Returns the notification channel that should be used when posting the notification or the default channel if its not defined.

getNotificationTag

@Nullable

open fun getNotificationTag(): String

Returns the notification tag that should be used when posting the notification.

getPriority

open fun getPriority(): Int

Gets the priority of the notification.

getPublicNotificationPayload

@Nullable

open fun getPublicNotificationPayload(): String

Gets the public notification payload.

getRichPushMessageId

@Nullable

open fun getRichPushMessageId(): String

Gets the rich push message ID

getSendId

@Nullable

open fun getSendId(): String

Gets the push send ID

getSound

@Nullable

open fun ~~getSound~~(@NonNull context: Context): Uri

Gets the sound of the notification.

getStylePayload

@Nullable

open fun getStylePayload(): String

Gets the style payload of the notification.

getSummary

@Nullable

open fun getSummary(): String

Gets the summary of the notification.

getTitle

@Nullable

open fun getTitle(): String

Gets the title of the notification.

getVisibility

open fun getVisibility(): Int

Gets the visibility of the notification for the lockscreen.

getWearablePayload

@Nullable

open fun getWearablePayload(): String

Gets the wearable payload.

hashCode

open fun hashCode(): Int

isAccengagePush

open fun isAccengagePush(): Boolean

Checks if the push is from Accengage or not.

isAccengageVisiblePush

open fun isAccengageVisiblePush(): Boolean

Checks if the push is from Accengage and has content or not.

isAirshipPush

open fun isAirshipPush(): Boolean

Checks if the push is from Airship or not.

isForegroundDisplayable

@Nullable

open fun isForegroundDisplayable(): Boolean

Returns if the notification should be displayed or suppressed in the foreground.

isLocalOnly

open fun isLocalOnly(): Boolean

Checks if the notification should only be displayed on the device.

isRemoteDataUpdate

@RestrictTo(value = RestrictTo.Scope.LIBRARY_GROUP)

open fun isRemoteDataUpdate(): Boolean

Checks if the message is to update remote-data or not.

toJsonValue

@NonNull

open fun toJsonValue(): JsonValue

Returns the objects represented as a JsonValue.

toString

@NonNull

open fun toString(): String

writeToParcel

open fun writeToParcel(@NonNull dest: Parcel, flags: Int)