Companion

Properties

Link copied to clipboard

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

Link copied to clipboard
const val EXTRA_ALERT: String

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

Link copied to clipboard
const val EXTRA_APID: String

The extra key for the channel ID.

Link copied to clipboard

The extra key for the category of the notification.

Link copied to clipboard

The extra key for the delivery priority.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
const val EXTRA_ICON: String

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

Link copied to clipboard

The extra key indicates the icon color.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The Live Update payload.

Link copied to clipboard

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

Link copied to clipboard

The push metadata extra holds the encrypted push identifiers sent in an Airship Push Notification. Possible data includes send, push, and group IDs.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
const val EXTRA_PING: String

The ping extra indicates a push meant to test whether the application is active

Link copied to clipboard

The extra key for the priority of the notification. Acceptable values range from PRIORITY_MIN (-2) to PRIORITY_MAX (2).

Link copied to clipboard

The extra key for the public notification payload.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The push ID extra holds the unique push ID sent in an Airship Push Notification. This is most commonly referred to as the "Send ID" at Airship.

Link copied to clipboard
const val EXTRA_SOUND: String

The extra key for the sound of the notification.

Link copied to clipboard
const val EXTRA_STYLE: String

The extra key for the style of the notification.

Link copied to clipboard

The extra key for the summary of the notification.

Link copied to clipboard
const val EXTRA_TITLE: String

The extra key for the title of the notification.

Link copied to clipboard

The extra key for the notification's visibility in the lockscreen. Acceptable values are: VISIBILITY_PUBLIC (1), VISIBILITY_PRIVATE (0) or VISIBILITY_SECRET (-1).

Link copied to clipboard

The extra key for the wearable payload.

Link copied to clipboard
const val MAX_PRIORITY: Int = 2

The maximum priority value for the notification.

Link copied to clipboard
const val MAX_VISIBILITY: Int = 1

The maximum visibility value for the notification in the lockscreen.

Link copied to clipboard
const val MIN_PRIORITY: Int

The minimum priority value for the notification.

Link copied to clipboard
const val MIN_VISIBILITY: Int

The minimum visibility value for the notification in the lockscreen.

Link copied to clipboard

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

Link copied to clipboard
const val VISIBILITY_PUBLIC: Int = 1

Shows the notification's full content in the lockscreen. This is the default visibility.

Functions

Link copied to clipboard

Creates a push message from a json value.