urbanairship-core/com.urbanairship.push/PushMessage

PushMessage

class PushMessage : Parcelable, JsonSerializable(source)

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

Constructors

PushMessage

constructor(pushBundle: Bundle)

Create a new PushMessage

constructor(data: Map<String, String>)

Create a new PushMessage

Types

Companion

object Companion

Properties

actions

val actions: Map<String, ActionValue>

Gets the push message's actions.

alert

val alert: String?

Gets the notification alert

canonicalPushId

val canonicalPushId: String?

Gets the message's canonical push ID

category

val category: String?

Gets the category of the notification.

interactiveActionsPayload

val interactiveActionsPayload: String?

Gets the notification actions payload.

interactiveNotificationType

val interactiveNotificationType: String?

Gets the notification action button type.

isAccengagePush

val isAccengagePush: Boolean

Checks if the push is from Accengage or not.

isAccengageVisiblePush

val isAccengageVisiblePush: Boolean

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

isAirshipPush

val isAirshipPush: Boolean

Checks if the push is from Airship or not.

isExpired

val isExpired: Boolean

Checks if the expiration exists and is expired

isForegroundDisplayable

val isForegroundDisplayable: Boolean

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

isLocalOnly

val isLocalOnly: Boolean

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

isPing

val isPing: Boolean

Checks if the message is ping or not

liveUpdatePayload

val liveUpdatePayload: String?

Gets the Live Update payload, if present.

metadata

val metadata: String?

Gets the push send metadata.

notificationChannel

val notificationChannel: String?

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

notificationTag

val notificationTag: String?

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

priority

val priority: Int

Gets the priority of the notification. Defaults to 0.

publicNotificationPayload

val publicNotificationPayload: String?

Gets the public notification payload.

richPushMessageId

val richPushMessageId: String?

Gets the rich push message ID

sendId

val sendId: String?

Gets the push send ID

stylePayload

val stylePayload: String?

Gets the style payload of the notification.

summary

val summary: String?

Gets the summary of the notification.

title

val title: String?

Gets the title of the notification.

visibility

val visibility: Int

Gets the visibility of the notification for the lockscreen. Defaults to 1 (VISIBILITY_PUBLIC).

wearablePayload

val wearablePayload: String?

Gets the wearable payload.

Functions

containsAirshipKeys

fun containsAirshipKeys(): Boolean

Checks the message for Airship keys.

containsKey

fun containsKey(key: String): Boolean

Checks if the push message contains a key.

describeContents

open override fun describeContents(): Int

equals

open operator override fun equals(other: Any?): Boolean

getExtra

fun getExtra(key: String): String?

fun getExtra(key: String, defaultValue: String): String

Gets an extra from the push bundle.

getIcon

@DrawableRes

fun getIcon(context: Context, defaultIcon: Int): Int

Gets the notification icon image.

getIconColor

fun getIconColor(defaultColor: Int): Int

Gets the notification icon color.

getNotificationChannel

fun getNotificationChannel(defaultChannel: String?): String?

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

getPushBundle

fun getPushBundle(): Bundle

Returns a bundle of all the push extras

getSound

fun ~~getSound~~(context: Context): Uri?

Gets the sound of the notification.

hashCode

open override fun hashCode(): Int

toJsonValue

open override fun toJsonValue(): JsonValue

Returns the objects represented as a JsonValue.

toString

open override fun toString(): String

writeToParcel

open override fun writeToParcel(dest: Parcel, flags: Int)