java.lang.Object | |
↳ | com.urbanairship.push.PushMessage |
A push message, usually created from handling a message intent from either GCM, or another push notification service
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | EXTRA_ACTIONS | The actions extra key holds the payload of actions to be performed with the push. | |||||||||
String | EXTRA_ALERT | The alert extra holds the string sent in the "alert" field of an Urban Airship Push Notification. | |||||||||
String | EXTRA_CATEGORY | The extra key for the category of the notification. | |||||||||
String | EXTRA_EXPIRATION | The EXPIRATION extra is a time expressed in seconds since the Epoch after which, if specified, the notification should not be delivered. | |||||||||
String | EXTRA_INTERACTIVE_ACTIONS | The extra key for the payload of Urban Airship actions to be run when an interactive notification action button is opened. | |||||||||
String | EXTRA_INTERACTIVE_TYPE | The extra key for the interactive notification group that will be displayed with a push. | |||||||||
String | EXTRA_IN_APP_MESSAGE | The extra key for the InAppMessage payload. |
|||||||||
String | EXTRA_LOCAL_ONLY | The extra key indicates if the notification should only be displayed on the device. | |||||||||
String | EXTRA_PRIORITY | The extra key for the priority of the notification. | |||||||||
String | EXTRA_PUBLIC_NOTIFICATION | The extra key for the public notification payload. | |||||||||
String | EXTRA_PUSH_ID | The push ID extra is the ID assigned to a push at the time it is sent. | |||||||||
String | EXTRA_SEND_ID | The push ID extra holds the unique push ID sent in an Urban Airship Push Notification. | |||||||||
String | EXTRA_STYLE | The extra key for the style of the notification. | |||||||||
String | EXTRA_SUMMARY | The extra key for the summary of the notification. | |||||||||
String | EXTRA_TITLE | The extra key for the title of the notification. | |||||||||
String | EXTRA_VISIBILITY | The extra key for the notification's visibility in the lockscreen. | |||||||||
String | EXTRA_WEARABLE | The extra key for the wearable payload. |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
public static final Creator<PushMessage> | CREATOR | Parcel Creator for push messages. |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
PushMessage(Bundle pushBundle)
Create a new PushMessage
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
int | describeContents() | ||||||||||
Map<String, ActionValue> |
getActions()
Gets the push message's actions.
| ||||||||||
String |
getActionsPayload()
This method is deprecated.
Marked to be remove in 7.0.0. Use
getActions() instead.
| ||||||||||
String |
getAlert()
Gets the notification alert
| ||||||||||
String |
getCanonicalPushId()
Gets the message's canonical push ID
| ||||||||||
String |
getCategory()
Gets the category of the notification.
| ||||||||||
InAppMessage |
getInAppMessage()
Gets the
InAppMessage from the push bundle. | ||||||||||
String |
getInteractiveActionsPayload()
Gets the notification actions payload.
| ||||||||||
String |
getInteractiveNotificationType()
Gets the notification action button type.
| ||||||||||
int |
getPriority()
Gets the priority of the notification.
| ||||||||||
String |
getPublicNotificationPayload()
Gets the public notification payload.
| ||||||||||
Bundle |
getPushBundle()
Returns a bundle of all the push extras
| ||||||||||
String |
getRichPushMessageId()
Gets the rich push message ID
| ||||||||||
String |
getSendId()
Gets the push send ID
| ||||||||||
String |
getStylePayload()
Gets the style payload of the notification.
| ||||||||||
String |
getSummary()
Gets the summary of the notification.
| ||||||||||
String |
getTitle()
Gets the title of the notification.
| ||||||||||
int |
getVisibility()
Gets the visibility of the notification for the lockscreen.
| ||||||||||
String |
getWearablePayload()
Gets the wearable payload.
| ||||||||||
boolean |
isLocalOnly()
Checks if the notification should only be displayed on the device.
| ||||||||||
String | toString() | ||||||||||
void | writeToParcel(Parcel dest, int flags) |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
The actions extra key holds the payload of actions to be performed with the push.
The alert extra holds the string sent in the "alert" field of an Urban Airship Push Notification.
The extra key for the category of the notification.
The EXPIRATION extra is a time expressed in seconds since the Epoch after which, if specified, the notification should not be delivered. It is removed from the notification before delivery to the client. If not present, notifications may be delivered arbitrarily late.
The extra key for the payload of Urban Airship actions to be run when an interactive notification action button is opened.
The extra key for the interactive notification group that will be displayed with a push.
The extra key for the InAppMessage
payload.
The extra key indicates if the notification should only be displayed on the device.
The extra key for the priority of the notification. Acceptable values range from PRIORITY_MIN (-2) to PRIORITY_MAX (2).
Defaults to 0.The extra key for the public notification payload.
The push ID extra is the ID assigned to a push at the time it is sent. Each API call will result in a unique push ID, so all notifications that are part of a multicast push will have the same push ID.
The push ID extra holds the unique push ID sent in an Urban Airship Push Notification. This is most commonly referred to as the "Send ID" at Urban Airship.
The extra key for the style of the notification.
The extra key for the summary of the notification.
The extra key for the title of the notification.
The extra key for the notification's visibility in the lockscreen. Acceptable values are: VISIBILITY_PUBLIC (1), VISIBILITY_PRIVATE (0) or VISIBILITY_SECRET (-1).
The extra key for the wearable payload.
Create a new PushMessage
pushBundle | The intent extras for the push |
---|
Gets the push message's actions.
This method is deprecated.
Marked to be remove in 7.0.0. Use getActions()
instead.
Gets the actions payload that runs when the message is received or opened.
Gets the message's canonical push ID
Gets the category of the notification.
Gets the InAppMessage
from the push bundle.
Gets the notification actions payload.
Gets the notification action button type.
Gets the priority of the notification.
Defaults to 0.Gets the public notification payload.
Returns a bundle of all the push extras
Gets the rich push message ID
Gets the style payload of the notification.
Gets the summary of the notification.
Gets the title of the notification.
Gets the visibility of the notification for the lockscreen.
Defaults to 1 (VISIBILITY_PUBLIC).Checks if the notification should only be displayed on the device.
true
if the notification should only be displayed on the device,
otherwise false
Defaults to false.