flash.notifications.RemoteNotifier (ActionScript 3.0)

	Property	Defined by
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		supportedNotificationStyles : Vector.<String> [static][read-only] A vector list of all supported notification styles.	RemoteNotifier

Public Methods

	Method		Defined by
		RemoteNotifier() Creates a new RemoteNotifier object.	RemoteNotifier
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		subscribe(options:RemoteNotifierSubscribeOptions = null):void Subscribes/registers the application to receive remote notifications from APNs.	RemoteNotifier
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		unsubscribe():void Unsubscribes the application from receiving remote notifications via APNs.	RemoteNotifier
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Summary	Defined by
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
notification	Dispatched in response to a new notification received by the application.	RemoteNotifier
status	Dispatched if an error is encountered during the subscription process.	RemoteNotifier
token	Dispatched when a notification token is available from the iOS upon successful subscription for remote notifications.	RemoteNotifier

Property detail

supportedNotificationStyles

property

supportedNotificationStyles:Vector.<String> [read-only]

Language version:

ActionScript 3.0

Runtime version:

AIR 3.4

A vector list of all supported notification styles.

Implementation
public static function get supportedNotificationStyles():Vector.<String>

See also

flash.notifications.NotificationStyle

Constructor detail

RemoteNotifier

()

constructor

public function RemoteNotifier()

Language version:

ActionScript 3.0

Runtime version:

AIR 3.4

Creates a new RemoteNotifier object.

Method detail

()

method

public function subscribe(options:RemoteNotifierSubscribeOptions = null):void

Language version:

ActionScript 3.0

Runtime version:

AIR 3.4

Subscribes/registers the application to receive remote notifications from APNs.

RemoteNotificationEvent (TOKEN) is fired once the token is available. This token is to be used by remote notification providers to send remote notifications to this application on the device via APNs.
RemoteNotificationEvent (NOTIFICATION) is fired when platform OS communicates the notification to the application.
StatusEvent (STATUS) is fired when an error occurs while subscribing for remote notifications.

Parameters

options:RemoteNotifierSubscribeOptions (default = null) — options required for the subscription process on some platforms.

unsubscribe

()

method

public function unsubscribe():void

Language version:

ActionScript 3.0

Runtime version:

AIR 3.4

Unsubscribes the application from receiving remote notifications via APNs.

Event detail

notification

event

Event object type: flash.events.RemoteNotificationEvent

Language version:

ActionScript 3.0

Runtime version:

AIR 3.4

Dispatched in response to a new notification received by the application.

For iOS, this event is fired in the following scenarios:

The application was in the foreground when a new notification was received.
As display of a notification popup, the user taps the action button of the alert or taps (or clicks) the application icon. In this case, no information about the notification payload is available.

status

event

Event object type: flash.events.StatusEvent

Language version:

ActionScript 3.0

Runtime version:

AIR 3.4

Dispatched if an error is encountered during the subscription process.

token

event

Event object type: flash.events.RemoteNotificationEvent

Language version:

ActionScript 3.0

Runtime version:

AIR 3.4

Dispatched when a notification token is available from the iOS upon successful subscription for remote notifications.

Submit Feedback

ActionScript 3.0 Language Reference	All Packages \| All Classes \| Language Elements \| Index \| Appendices \| Conventions \| Frames No Frames
Class RemoteNotifier	Properties \| Methods \| Events

Package	flash.notifications
Class	public class RemoteNotifier
Inheritance	RemoteNotifier EventDispatcher Object