net.rim.blackberry.events.PushServiceConnectionReadyEvent

PushServiceConnectionReadyEvent

Properties | Methods | Constants


Packagenet.rim.blackberry.events
Classpublic class PushServiceConnectionReadyEvent
InheritancePushServiceConnectionReadyEvent Inheritance PushServiceEvent Inheritance flash.events.Event

An event when the connection to the Push Service is back up and ready again after a create session, create channel, destroy channel, register to launch or unregister from launch operation previously failed with the PushServiceErrorEvent.PUSH_SERVICE_CONNECTION_CLOSED error code.

IMPORTANT: Check the value of lastFailedOperation to determine whether the last failed operation was a create session, create channel, destroy channel, register to launch or unregister from launch. This will allow you to determine which operation should be tried again.



Class information:
BlackBerry 10 Version: 10.1.0
Found in:  BlackBerryPushService.ane

See also

net.rim.blackberry.push.PushService



Public Properties

 PropertyDefined By
  lastFailedOperation : uint
[read-only] Gets the last operation that failed.
PushServiceConnectionReadyEvent

Public Methods

 MethodDefined By
  
PushServiceConnectionReadyEvent(type:String, lastFailedOperation:uint)
Creates a push service connection ready event.
PushServiceConnectionReadyEvent
  
clone():Event
[override]
PushServiceConnectionReadyEvent
  
toString():String
[override]
PushServiceConnectionReadyEvent

Public Constants

 ConstantDefined By
  CREATE_CHANNEL : uint = 1
[static] lastFailedOperation will match this constant if the last failed operation is a create channel.
PushServiceConnectionReadyEvent
  CREATE_SESSION : uint = 0
[static] lastFailedOperation will match this constant if the last failed operation is a create session.
PushServiceConnectionReadyEvent
 InheritedCREATE_SESSION_SUCCESS : String = createSessionSuccess
[static] Type for when a create session succeeds.
PushServiceEvent
  DESTROY_CHANNEL : uint = 2
[static] lastFailedOperation will match this constant if the last failed operation is a destroy channel.
PushServiceConnectionReadyEvent
 InheritedDESTROY_CHANNEL_SUCCESS : String = destroyChannelSuccess
[static] Type for when a destroy channel succeeds.
PushServiceEvent
  PUSH_SERVICE_CONNECTION_READY : String = pushServiceConnectionReady
[static] Type for when the Push Service connection is ready.
PushServiceConnectionReadyEvent
  REGISTER_TO_LAUNCH : uint = 3
[static] lastFailedOperation will match this constant if the last failed operation is a register to launch.
PushServiceConnectionReadyEvent
 InheritedREGISTER_TO_LAUNCH_SUCCESS : String = registerToLaunchSuccess
[static] Type for when a register to launch succeeds.
PushServiceEvent
 InheritedSIM_CHANGE : String = simChange
[static] Type for when a SIM card change has occurred.
PushServiceEvent
  UNREGISTER_FROM_LAUNCH : uint = 4
[static] lastFailedOperation will match this constant if the last failed operation is an unregister from launch.
PushServiceConnectionReadyEvent
 InheritedUNREGISTER_FROM_LAUNCH_SUCCESS : String = unregisterFromLaunchSuccess
[static] Type for when an unregister from launch succeeds.
PushServiceEvent

Property Detail

lastFailedOperation


lastFailedOperation:uint  [read-only]

Gets the last operation that failed. It will have a value matching one of the uint constants in this class.


Implementation

public function get lastFailedOperation():uint

Constructor Detail

PushServiceConnectionReadyEvent()


public function PushServiceConnectionReadyEvent(type:String, lastFailedOperation:uint)

Creates a push service connection ready event.

Parameters

type:String — The type of the event. See the list of constants in this class for the available types.
lastFailedOperation:uint — The last failed operation. Please see class level ASDoc for details on lastFailedOperation.

Method Detail

clone()


override public function clone():Event

Returns

Event

toString()


override public function toString():String

Returns

String

Constant Detail

CREATE_CHANNEL


public static const CREATE_CHANNEL:uint = 1

lastFailedOperation will match this constant if the last failed operation is a create channel.

CREATE_SESSION


public static const CREATE_SESSION:uint = 0

lastFailedOperation will match this constant if the last failed operation is a create session.

DESTROY_CHANNEL


public static const DESTROY_CHANNEL:uint = 2

lastFailedOperation will match this constant if the last failed operation is a destroy channel.

PUSH_SERVICE_CONNECTION_READY


public static const PUSH_SERVICE_CONNECTION_READY:String = pushServiceConnectionReady

Type for when the Push Service connection is ready.

REGISTER_TO_LAUNCH


public static const REGISTER_TO_LAUNCH:uint = 3

lastFailedOperation will match this constant if the last failed operation is a register to launch.

UNREGISTER_FROM_LAUNCH


public static const UNREGISTER_FROM_LAUNCH:uint = 4

lastFailedOperation will match this constant if the last failed operation is an unregister from launch.





comments powered by Disqus