ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
flash.events 

RemoteNotificationEvent  - AS3

Packageflash.events
Classpublic final class RemoteNotificationEvent
InheritanceRemoteNotificationEvent Inheritance Event Inheritance 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



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : 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
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
 Inheritedtarget : Object
[read-only] The event target.
Event
      tokenId : String
[read-only] Cotains the tokenId received from APNs, used to identify the application.
RemoteNotificationEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined 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
 Inherited
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined 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:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
dataThe data received in the notification.
tokenIdThe 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:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
dataThe data received in the notification.
tokenIdThe token id received from APNs that is to be sent to the application's remote notification provider