flash.events

# RemoteNotificationEvent - AS3

Package | flash.events
Class | public final class RemoteNotificationEvent
Inheritance | RemoteNotificationEvent Event Object

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.4

Contains events that are dispatched by `flash.notifications.RemoteNotifier` in response to push notification events from APNs.

The event fires, as follows:

- notification: upon receiving a new remote notification
- token: upon receiving a new token from APNs that identifies this app and device.

Related API Elements

flash.notifications.RemoteNotifier

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bubbles : Boolean [read-only] Indicates whether an event is a bubbling event. | Event
|  | cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented. | Event
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener. | Event
|  | data : Object [read-only] Contains a JSON-format notification payload. | RemoteNotificationEvent
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | target : Object [read-only] The event target. | Event
|  | tokenId : String [read-only] Cotains the tokenId received from APNs, used to identify the application. | RemoteNotificationEvent
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | RemoteNotificationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, data:Object = null, tokenId:String = null) Contains events that are dispatched by flash.notifications.RemoteNotifier in response to push notification events from APNs. | RemoteNotificationEvent
|  | clone():Event Duplicates an instance of an Event subclass. | Event
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns a string containing all the properties of the Event object. | Event
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | NOTIFICATION : String = "notification" [static] Defines the value of the type property of a RemoteNotificationEvent event object. | RemoteNotificationEvent
|  | TOKEN : String = "token" [static] Defines the value of the type property of a RemoteNotificationEvent event object. | RemoteNotificationEvent

Property Detail

### data

property

`data:Object` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.4

Contains a JSON-format notification payload.

Implementation
`public function get data():Object`

### tokenId

property

`tokenId:String` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.4

Cotains the tokenId received from APNs, used to identify the application.

Implementation
`public function get tokenId():String`
Constructor Detail

### RemoteNotificationEvent

()
Constructor

`public function RemoteNotificationEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, data:Object = null, tokenId:String = null)`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.4

Contains events that are dispatched by `flash.notifications.RemoteNotifier` in response to push notification events from APNs.

Parameters

| `type:String`
| `bubbles:Boolean` (default = `false`)``
| `cancelable:Boolean` (default = `false`)``
| `data:Object` (default = `null`)``
| `tokenId:String` (default = `null`)``

Constant Detail

### NOTIFICATION

Constant

`public static const NOTIFICATION:String = "notification"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.4

Defines the value of the `type` property of a `RemoteNotificationEvent` event object.

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`data` | The data received in the notification.
`tokenId` | The token id received from APNs that is to be sent to the application's remote notification prvider

### TOKEN

Constant

`public static const TOKEN:String = "token"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 3.4

Defines the value of the `type` property of a `RemoteNotificationEvent` event object.

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`data` | The data received in the notification.
`tokenId` | The token id received from APNs that is to be sent to the application's remote notification provider

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00