| Package | com.tuarua.onesignal |
| Class | public class OSNotificationPayload |
| Inheritance | OSNotificationPayload  Object |
| Property | Defined By | ||
|---|---|---|---|
| actionButtons : Vector.<ActionButton> List of action buttons on the notification. | OSNotificationPayload | ||
| additionalData : Object Custom additional data that was sent with the notification. | OSNotificationPayload | ||
| attachments : Object iOS attachments sent as part of the rich notification. | OSNotificationPayload | ||
| badge : uint | OSNotificationPayload | ||
| badgeIncrement : int | OSNotificationPayload | ||
| bigPicture : String Android big picture image set on the notification. | OSNotificationPayload | ||
| body : String Body text of the notification. | OSNotificationPayload | ||
| category : String | OSNotificationPayload | ||
| collapseId : String | OSNotificationPayload | ||
| contentAvailable : uint iOS - Provided key with a value of 1 to indicate that new content is available. | OSNotificationPayload | ||
| fromProjectNumber : String The Google project number the notification was sent under. | OSNotificationPayload | ||
| groupKey : String Notifications with this same key will be grouped together as a single summary notification. | OSNotificationPayload | ||
| groupMessage : String Summary text displayed in the summary notification. | OSNotificationPayload | ||
| largeIcon : String Android large icon set on the notification. | OSNotificationPayload | ||
| launchURL : String URL to open when opening the notification. | OSNotificationPayload | ||
| ledColor : String Devices that have a notification LED will blink in this color. | OSNotificationPayload | ||
| lockScreenVisibility : uint Privacy setting for how the notification should be shown on the lockscreen of Android 5+ devices. | OSNotificationPayload | ||
| mutableContent : Boolean | OSNotificationPayload | ||
| notificationID : String OneSignal notification UUID. | OSNotificationPayload | ||
| priority : uint | OSNotificationPayload | ||
| rawPayload : String Raw JSON payload string received from OneSignal. | OSNotificationPayload | ||
| smallIcon : String Android small icon resource name set on the notification. | OSNotificationPayload | ||
| smallIconAccentColor : String Accent color shown around small notification icon on Android 5+ devices. | OSNotificationPayload | ||
| sound : String Sound resource parameter to play when the notification is shown. | OSNotificationPayload | ||
| subtitle : String iOS subtitle text of the notification. | OSNotificationPayload | ||
| templateID : String | OSNotificationPayload | ||
| templateName : String | OSNotificationPayload | ||
| title : String Title text of the notification. | OSNotificationPayload | ||
| Method | Defined By | ||
|---|---|---|---|
| OSNotificationPayload | |||
| actionButtons | property |
public var actionButtons:Vector.<ActionButton>List of action buttons on the notification.
| additionalData | property |
public var additionalData:ObjectCustom additional data that was sent with the notification. Set on the dashboard under Options > Additional Data or with the 'data' field on the REST API.
| attachments | property |
public var attachments:ObjectiOS attachments sent as part of the rich notification.
| badge | property |
public var badge:uint| badgeIncrement | property |
public var badgeIncrement:int| bigPicture | property |
public var bigPicture:StringAndroid big picture image set on the notification.
| body | property |
public var body:StringBody text of the notification.
| category | property |
public var category:String| collapseId | property |
public var collapseId:String| contentAvailable | property |
public var contentAvailable:uintiOS - Provided key with a value of 1 to indicate that new content is available. Including this key and value means that when your app is launched in the background or resumed application:didReceiveRemoteNotification:fetchCompletionHandler: is called.
| fromProjectNumber | property |
public var fromProjectNumber:StringThe Google project number the notification was sent under.
| groupKey | property |
public var groupKey:StringNotifications with this same key will be grouped together as a single summary notification.
| groupMessage | property |
public var groupMessage:StringSummary text displayed in the summary notification.
| largeIcon | property |
public var largeIcon:StringAndroid large icon set on the notification.
| launchURL | property |
public var launchURL:StringURL to open when opening the notification.
| ledColor | property |
public var ledColor:StringDevices that have a notification LED will blink in this color. ARGB format.
| lockScreenVisibility | property |
public var lockScreenVisibility:uintPrivacy setting for how the notification should be shown on the lockscreen of Android 5+ devices. 1 (Default) - Public (fully visible) 0 - Private (Contents are hidden) -1 - Secret (not shown).
| mutableContent | property |
public var mutableContent:Boolean| notificationID | property |
public var notificationID:StringOneSignal notification UUID.
| priority | property |
public var priority:uint| rawPayload | property |
public var rawPayload:StringRaw JSON payload string received from OneSignal.
| smallIcon | property |
public var smallIcon:StringAndroid small icon resource name set on the notification.
| smallIconAccentColor | property |
public var smallIconAccentColor:StringAccent color shown around small notification icon on Android 5+ devices. ARGB format.
| sound | property |
public var sound:StringSound resource parameter to play when the notification is shown. iOS default set to UILocalNotificationDefaultSoundName.
| subtitle | property |
public var subtitle:StringiOS subtitle text of the notification.
| templateID | property |
public var templateID:String| templateName | property |
public var templateName:String| title | property |
public var title:StringTitle text of the notification.
| OSNotificationPayload | () | Constructor |
public function OSNotificationPayload()