net.rim.blackberry.events.CreateChannelSuccessEvent

CreateChannelSuccessEvent

Properties | Methods | Constants


Packagenet.rim.blackberry.events
Classpublic class CreateChannelSuccessEvent
InheritanceCreateChannelSuccessEvent Inheritance PushServiceEvent Inheritance flash.events.Event

An event when a create channel operation has succeeded.

IMPORTANT: This event returns a token that should then be used when subscribing to the Push Initiator. If the Push Service SDK was used to develop the Push Initiator, this would be set as the value for the "address" HTTP request parameter. Otherwise, this token should be communicated to the Push Initiator server-side application and then be used by the Push Initiator to address this device when sending a push request message to the PPG (Push Proxy Gateway).



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

See also

net.rim.blackberry.push.PushService



Public Properties

 PropertyDefined By
  token : String
[read-only] Gets the token which is received on a successful create channel operation.
CreateChannelSuccessEvent

Public Methods

 MethodDefined By
  
CreateChannelSuccessEvent(type:String, token:String)
Creates a create channel success event.
CreateChannelSuccessEvent
  
clone():Event
[override]
CreateChannelSuccessEvent
  
toString():String
[override]
CreateChannelSuccessEvent

Public Constants

 ConstantDefined By
  CREATE_CHANNEL_SUCCESS : String = createChannelSuccess
[static] Type for when a create channel succeeds.
CreateChannelSuccessEvent
 InheritedCREATE_SESSION_SUCCESS : String = createSessionSuccess
[static] Type for when a create session succeeds.
PushServiceEvent
 InheritedDESTROY_CHANNEL_SUCCESS : String = destroyChannelSuccess
[static] Type for when a destroy channel succeeds.
PushServiceEvent
 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
 InheritedUNREGISTER_FROM_LAUNCH_SUCCESS : String = unregisterFromLaunchSuccess
[static] Type for when an unregister from launch succeeds.
PushServiceEvent

Property Detail

token


token:String  [read-only]

Gets the token which is received on a successful create channel operation. Please see class level ASDoc for details on the token.


Implementation

public function get token():String

Constructor Detail

CreateChannelSuccessEvent()


public function CreateChannelSuccessEvent(type:String, token:String)

Creates a create channel success event.

Parameters

type:String — The type of the event. See the list of constants in this class for the available types.
token:String — The token which is received on a successful create channel operation. Please see class level ASDoc for details on the token.

Method Detail

clone()


override public function clone():Event

Returns

Event

toString()


override public function toString():String

Returns

String

Constant Detail

CREATE_CHANNEL_SUCCESS


public static const CREATE_CHANNEL_SUCCESS:String = createChannelSuccess

Type for when a create channel succeeds.





comments powered by Disqus