Package | com.distriqt.extension.pushnotifications.events |
Class | public class RegistrationEvent |
Inheritance | RegistrationEvent ![]() |
Fired when an event has occurred in the extension regarding registration.
Property | Defined By | ||
---|---|---|---|
data : String
The data value attached to this event. | RegistrationEvent | ||
errorCode : int | RegistrationEvent |
Method | Defined By | ||
---|---|---|---|
RegistrationEvent(type:String, data:String, errorCode:int = 0, bubbles:Boolean = false, cancelable:Boolean = true)
Constructor
| RegistrationEvent | ||
clone():Event [override]
| RegistrationEvent |
Constant | Defined By | ||
---|---|---|---|
CHANGED : String = registration:changed [static]
Dispatched on successful registration with the server
and whenever the registration token changes. | RegistrationEvent | ||
ERROR : String = registration:error [static]
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. | RegistrationEvent | ||
REGISTER_FAILED : String = registration:register:failed [static]
Dispatched when the registration process fails. | RegistrationEvent | ||
REGISTERING : String = registration:registering [static]
This event is dispatched when the service is attempting to register
| RegistrationEvent | ||
REGISTER_SUCCESS : String = registration:register:success [static]
Dispatched on successful registration with the server
The call to getDeviceToken will now return a valid registration id. | RegistrationEvent | ||
UNREGISTERED : String = registration:unregistered [static]
Android only
Dispatched when the service has unregistered from the server
| RegistrationEvent |
data | property |
public var data:String
The data value attached to this event.
In the case of an ERROR this contains additional information about the error
Other events vary
See also
errorCode | property |
public var errorCode:int
RegistrationEvent | () | Constructor |
public function RegistrationEvent(type:String, data:String, errorCode:int = 0, bubbles:Boolean = false, cancelable:Boolean = true)
Constructor
Parameterstype:String | |
data:String | |
errorCode:int (default = 0 )
| |
bubbles:Boolean (default = false )
| |
cancelable:Boolean (default = true )
|
clone | () | method |
override public function clone():Event
Returns
Event —
|
CHANGED | Constant |
public static const CHANGED:String = registration:changed
Dispatched on successful registration with the server and whenever the registration token changes.
The call to getDeviceToken
will now return a valid registration id.
ERROR | Constant |
public static const ERROR:String = registration:error
An error has occurred
The data field will contain more information about the error that occurred
Android additional errors:
iOS additional errors:
REGISTER_FAILED | Constant |
public static const REGISTER_FAILED:String = registration:register:failed
Dispatched when the registration process fails. This could be due to connection issues or an issue with the server at the time of connection.
REGISTER_SUCCESS | Constant |
public static const REGISTER_SUCCESS:String = registration:register:success
Dispatched on successful registration with the server
The call to getDeviceToken
will now return a valid registration id.
REGISTERING | Constant |
public static const REGISTERING:String = registration:registering
This event is dispatched when the service is attempting to register
UNREGISTERED | Constant |
public static const UNREGISTERED:String = registration:unregistered
Android only
Dispatched when the service has unregistered from the server