com.distriqt.extension.pushnotifications.PushNotifications

	Property	Defined By
		canOpenDeviceSettings : Boolean [read-only] Returns true if you can display the device settings for your application.	PushNotifications
		canSendTags : Boolean [read-only] Returns whether the current service supports the setting of tags on the current user registration.	PushNotifications
		canSubscribeToTopics : Boolean [read-only] Returns true if the current service supports topic subscription and false otherwise.	PushNotifications
		implementation : String [read-only] The implementation currently in use.	PushNotifications
		inAppMessaging : InAppMessaging [read-only]	PushNotifications
		isSupported : Boolean [static] [read-only] Whether the platform supports push notifications	PushNotifications
		nativeVersion : String [read-only] The native version string of the native extension.	PushNotifications
		service : PushNotifications [static] [read-only] The singleton instance of the PushNotifications class.	PushNotifications
		version : String [read-only] The version of this extension.	PushNotifications

	Method	Defined By
		PushNotifications() Class Constructor	PushNotifications
		authorisationStatus():String Returns the current authorisation status of the device.	PushNotifications
		cancelAll():void Cancels any notifications currently displayed.	PushNotifications
		deleteTag(tag:String):Boolean Deletes a single tag that was previously set on a user with sendTag or sendTags.	PushNotifications
		deleteTags(tags:Array):Boolean Deletes one or more tags that were previously set on a user with sendTag or sendTags.	PushNotifications
		dispose():void Disposes the extension and releases any allocated resources.	PushNotifications
		getDeviceToken():String Returns the deviceToken or registration ID value of a currently registered device from the notification service This value has slightly different terminology on each of the services, as below: "device token" with APNS; "registration id" with Android GCM; "instance token" with FCM. The value unique identifies this device.	PushNotifications
		getServiceToken():String	PushNotifications
		getTags():Boolean Retrieve a list of tags that have been set on the user from the service.	PushNotifications
		hasAuthorisation():Boolean If true the user has granted authorisation to display notifications on this device.	PushNotifications
		init(key:String):void Deprecated: You no longer need to use an application key [static] Initialises the extension class for use with the provided key.	PushNotifications
		isServiceSupported(serviceType:String):Boolean Checks if the specified service type is supported on the current device.	PushNotifications
		openDeviceSettings():Boolean iOS 8 introduced the ability to send your user to your application's device settings within the iOS Settings.	PushNotifications
		provideUserConsent(granted:Boolean):Boolean If your Service is set to require the user's privacy consent and the service supports this functionality, you can provide this consent using this method.	PushNotifications
		register():Boolean Registers this device with the push notification service.	PushNotifications
		removeUserId():void Allows you to disassociate a custom user identifier from your application with the notification service identifier.	PushNotifications
		requestAuthorisation():Boolean This function triggers the authorisation request dialog.	PushNotifications
		sendTag(key:String, value:String):Boolean Tag a user based on an app event/property of your choosing to target these users.	PushNotifications
		sendTags(tags:Object):Boolean Tag a user based on an app event/property of your choosing to target these users.	PushNotifications
		setBadgeNumber(number:int):void Sets the badge number for the application icon Support: iOS Android: Limited, see documentation	PushNotifications
		setup(service:Service):Boolean Sets up the service configuration	PushNotifications
		setUserId(userId:String, authHash:String):void This allows you to associate a custom identifier with your user.	PushNotifications
		subscribeToTopic(topic:String):Boolean Subscribe the current client to the specified topic	PushNotifications
		unregister():void Unregisters the current device	PushNotifications
		unsubscribeFromTopic(topic:String):Boolean Unsubscribe the current client from the specified topic	PushNotifications

Summary	Defined By
authorisation:changed	Dispatched when the authorisation status may have changed	PushNotifications
pushnotification:action	This event is dispatched when the user clicks on a notification action	PushNotifications
pushnotification:error	An error has occurred	PushNotifications
pushnotification:group:selected	This event is dispatched when the user clicks on a group notification	PushNotifications
pushnotification:notification	A Notification was received	PushNotifications
pushnotification:notification:selected	This event is dispatched when the user clicks on a notification	PushNotifications
registration:error	An error has occurred The data field will contain more information about the error that occurred Android additional errors: SERVICE_NOT_AVAILABLE: The device can't read the response, or there was a 500/503 from the server that can be retried later.	PushNotifications
registration:register:failed	Dispatched when the registration process fails	PushNotifications
registration:register:success	Dispatched on successful registration with the server	PushNotifications
registration:registering	This event is dispatched when the service is attempting to register	PushNotifications
registration:unregistered	Dispatched when the service has unregistered from the server	PushNotifications

	Constant	Defined By
		EXT_CONTEXT_ID : String = com.distriqt.PushNotifications [static]	PushNotifications
		VERSION : String = 16.0.2 [static]	PushNotifications

canOpenDeviceSettings:Boolean [read-only]

Returns true if you can display the device settings for your application.

Implementation
public function get canOpenDeviceSettings():Boolean

canSendTags:Boolean [read-only]

Returns whether the current service supports the setting of tags on the current user registration.

Implementation
public function get canSendTags():Boolean

canSubscribeToTopics:Boolean [read-only]

Returns true if the current service supports topic subscription and false otherwise.

Implementation
public function get canSubscribeToTopics():Boolean

implementation:String [read-only]

The implementation currently in use. This should be one of the following depending on the platform in use and the functionality supported by this extension:

Android
iOS
default
unknown

Implementation
public function get implementation():String

inAppMessaging:InAppMessaging [read-only]

Implementation
public function get inAppMessaging():InAppMessaging

isSupported:Boolean [read-only]

Whether the platform supports push notifications

Implementation
public static function get isSupported():Boolean

nativeVersion:String [read-only]

The native version string of the native extension.

Implementation
public function get nativeVersion():String

service:PushNotifications [read-only]

The singleton instance of the PushNotifications class.

Implementation
public static function get service():PushNotifications

version:String [read-only]

The version of this extension.

This should be of the format, MAJOR.MINOR.BUILD

Implementation
public function get version():String

public function PushNotifications()

Class Constructor

public function authorisationStatus():String

Returns the current authorisation status of the device. This status indicates whether the user has authorised or denied access to notifications.

The NOT_DETERMINED status is returned when your application is first installed and you have not yet requested authorisation.

Returns

String — A value from the AuthorisationStatus constants

public function cancelAll():void

Cancels any notifications currently displayed.

This may cancel local notifications as well created via the Notifications extension.

Support: Android, iOS

public function deleteTag(tag:String):Boolean

Deletes a single tag that was previously set on a user with sendTag or sendTags. Use deleteTags if you need to delete more than one.

Parameters

tag:String — Key of the tag to delete

Returns

Boolean — true if successfully started and false if not supported or there was an error

public function deleteTags(tags:Array):Boolean

Deletes one or more tags that were previously set on a user with sendTag or sendTags.

Parameters

tags:Array — Array of string keys for the tags to delete.

Returns

Boolean — true if successfully started and false if not supported or there was an error

public function dispose():void

Disposes the extension and releases any allocated resources. Once this function has been called, a call to init is neccesary again before any of the extensions functionality will work.

public function getDeviceToken():String

Returns the deviceToken or registration ID value of a currently registered device from the notification service

This value has slightly different terminology on each of the services, as below:

"device token" with APNS;
"registration id" with Android GCM;
"instance token" with FCM.

The value unique identifies this device. It may change and you should be prepared to manage changing tokens on your server.

Returns

String

public function getServiceToken():String

Returns

String —

public function getTags():Boolean

Retrieve a list of tags that have been set on the user from the service.

Returns

Boolean — true if successfully started and false if not supported or there was an error

public function hasAuthorisation():Boolean

If true the user has granted authorisation to display notifications on this device.

This will also return false if authorisation has not yet been requested.

Returns

Boolean — true if notifications can be displayed and false otherwise.

public static function init(key:String):void

Deprecated: You no longer need to use an application key

Initialises the extension class for use with the provided key.

Parameters

key:String

public function isServiceSupported(serviceType:String):Boolean

Checks if the specified service type is supported on the current device.

Parameters

serviceType:String — The type of service to check

Returns

Boolean — true if the service is supported and false otherwise

public function openDeviceSettings():Boolean

iOS 8 introduced the ability to send your user to your application's device settings within the iOS Settings.

Returns

Boolean — true if the settings open was successful and false if the device settings are not available.

public function provideUserConsent(granted:Boolean):Boolean

If your Service is set to require the user's privacy consent and the service supports this functionality, you can provide this consent using this method. Until you call provideUserConsent(true), the service will not fully initialize and will not send any data to the service.

Parameters

granted:Boolean — true if your user has granted permission

Returns

Boolean — true if successful and false if not supported or there was an error

See also

isEnabled

public function removeUserId():void

Allows you to disassociate a custom user identifier from your application with the notification service identifier. You should call this if your user logs out of your application. Only supported on OneSignal currently (equivalent to removeExternalUserId)

public function requestAuthorisation():Boolean

This function triggers the authorisation request dialog. This dialog will only be displayed once to a user on iOS so make sure you have adequately informed your user why you are requesting authorisation.

Note calling register at any point will trigger the request authorisation dialog as well so make sure you have implemented your authorisation logic before calling register

Returns

Boolean — true if the request was started successfully and false otherwise

public function sendTag(key:String, value:String):Boolean

Tag a user based on an app event/property of your choosing to target these users. Use sendTags if you need to set more than one tag on a user at a time.

Parameters

	`key:String` — Key of your choosing to create or update.

	`value:String` — Value to set on the key. NOTE: Passing in a blank/empty string deletes the key, you can also call deleteTag or deleteTags.

Returns

Boolean — true if successfully started and false if not supported or there was an error

public function sendTags(tags:Object):Boolean

Tag a user based on an app event/property of your choosing to target these users.

Parameters

tags:Object — Key value pairs of your choosing. These should be string values and keys.

Returns

Boolean — true if successfully started and false if not supported or there was an error

public function setBadgeNumber(number:int):void

Sets the badge number for the application icon

Support:

iOS
Android: Limited, see documentation

Parameters

number:int — Badge number to set

public function setup(service:Service):Boolean

Sets up the service configuration

Parameters

service:Service — The service configuration

Returns

Boolean

Example

An example of setting up the default service with a single category

         var service:Service = new Service( Service.DEFAULT, Config.gcmSenderId );
         service.enableNotificationsWhenActive = true;
         service.categories.push(
             new CategoryBuilder()
                 .setIdentifier( "INVITE_CATEGORY" )
                 .addAction( 
                     new ActionBuilder()
                         .setTitle( "Accept" )
                         .setIdentifier( "ACCEPT_IDENTIFIER" )
                         .build()
                 )
                 .addAction( 
                     new ActionBuilder()    
                         .setTitle( "Delete" )
                         .setDestructive( true )
                         .setIdentifier( "DELETE_IDENTIFIER" )
                         .build()
                 )
                 .build()
         );
         
         PushNotifications.service.setup( service );

public function setUserId(userId:String, authHash:String):void

This allows you to associate a custom identifier with your user. You should call this method each time your user logs into your app to pass in your custom User ID (as a string). Only supported on OneSignal currently (equivalent to setExternalUserId)

Parameters

	`userId:String` — The custom user identifier

	`authHash:String` — [optional] auth hash (if required)

public function subscribeToTopic(topic:String):Boolean

Subscribe the current client to the specified topic

Parameters

topic:String — The topic to subscribe the client to

Returns

Boolean — true if successful

public function unregister():void

Unregisters the current device

public function unsubscribeFromTopic(topic:String):Boolean

Unsubscribe the current client from the specified topic

Parameters

topic:String — The topic to unsubscribe the client from

Returns

Boolean — true if successful

Event Object Type: com.distriqt.extension.pushnotifications.events.AuthorisationEvent
AuthorisationEvent.type property = com.distriqt.extension.pushnotifications.events.AuthorisationEvent.CHANGED

Dispatched when the authorisation status may have changed

Event Object Type: com.distriqt.extension.pushnotifications.events.PushNotificationEvent
PushNotificationEvent.type property = com.distriqt.extension.pushnotifications.events.PushNotificationEvent.ACTION

This event is dispatched when the user clicks on a notification action

Dispatched when a user selects an action on a notification.

The identifier will contain the identifier of the action allowing you to determine what action to take.

Event Object Type: com.distriqt.extension.pushnotifications.events.PushNotificationEvent
PushNotificationEvent.type property = com.distriqt.extension.pushnotifications.events.PushNotificationEvent.ERROR

An error has occurred

Dispatched when an error occurred, either an invalid format notification payload or a connection issue.

The payload will contain the details of the error.

Event Object Type: com.distriqt.extension.pushnotifications.events.PushNotificationGroupEvent
PushNotificationGroupEvent.type property = com.distriqt.extension.pushnotifications.events.PushNotificationGroupEvent.GROUP_SELECTED

This event is dispatched when the user clicks on a group notification

Dispatched when a group notification is selected

Android only

Event Object Type: com.distriqt.extension.pushnotifications.events.PushNotificationEvent
PushNotificationEvent.type property = com.distriqt.extension.pushnotifications.events.PushNotificationEvent.NOTIFICATION

A Notification was received

The payload field will contain a json formatted string containing the payload sent with this notification.

Event Object Type: com.distriqt.extension.pushnotifications.events.PushNotificationEvent
PushNotificationEvent.type property = com.distriqt.extension.pushnotifications.events.PushNotificationEvent.NOTIFICATON_SELECTED

This event is dispatched when the user clicks on a notification

Event Object Type: com.distriqt.extension.pushnotifications.events.RegistrationEvent
RegistrationEvent.type property = com.distriqt.extension.pushnotifications.events.RegistrationEvent.ERROR

An error has occurred

The data field will contain more information about the error that occurred

Android additional errors:

SERVICE_NOT_AVAILABLE: The device can't read the response, or there was a 500/503 from the server that can be retried later. In this case the extension will perform retries of the registration or unregistration in an exponential backoff process, so you can safely assume you will eventually get a register / unregister event as long as the retry eventually suceeds.
ACCOUNT_MISSING: There is no Google account on the phone. The application should ask the user to open the account manager and add a Google account. Fix on the device side.
AUTHENTICATION_FAILED: Bad password. The application should ask the user to enter his/her password, and let user retry manually later. Fix on the device side.
TOO_MANY_REGISTRATIONS: The user has too many applications registered. The application should tell the user to uninstall some other applications, let user retry manually. Fix on the device side.
INVALID_SENDER: The sender account is not recognized.
PHONE_REGISTRATION_ERROR: Incorrect phone registration with Google. This phone doesn't currently support C2DM.

iOS additional errors:

REGISTER_FAILED: The registration failed

Event Object Type: com.distriqt.extension.pushnotifications.events.RegistrationEvent
RegistrationEvent.type property = com.distriqt.extension.pushnotifications.events.RegistrationEvent.REGISTER_FAILED

Dispatched when the registration process fails

Dispatched when the registration process fails. This could be due to connection issues or an issue with the server at the time of connection.

Event Object Type: com.distriqt.extension.pushnotifications.events.RegistrationEvent
RegistrationEvent.type property = com.distriqt.extension.pushnotifications.events.RegistrationEvent.REGISTER_SUCCESS

Dispatched on successful registration with the server

The call to getDeviceToken will now return a valid registration id.

Event Object Type: com.distriqt.extension.pushnotifications.events.RegistrationEvent
RegistrationEvent.type property = com.distriqt.extension.pushnotifications.events.RegistrationEvent.REGISTERING

This event is dispatched when the service is attempting to register

Event Object Type: com.distriqt.extension.pushnotifications.events.RegistrationEvent
RegistrationEvent.type property = com.distriqt.extension.pushnotifications.events.RegistrationEvent.UNREGISTERED

Dispatched when the service has unregistered from the server

Android only

Dispatched when the service has unregistered from the server

public static const EXT_CONTEXT_ID:String = com.distriqt.PushNotifications

public static const VERSION:String = 16.0.2

distriqt // PushNotifications Native Extension Documentation	All Packages \| All Classes \| Index \| Frames No Frames
PushNotifications	Properties \| Methods \| Events \| Constants

Package	com.distriqt.extension.pushnotifications
Class	public class PushNotifications
Inheritance	PushNotifications flash.events.EventDispatcher