Language Version : | ActionScript 3.0 |
Product Versions : | BlazeDS 4, LCDS 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The ChannelEvent is used to propagate channel events within the messaging system.
public var channel:Channel
Language Version : | ActionScript 3.0 |
Product Versions : | BlazeDS 4, LCDS 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The Channel that generated this event.
public var connected:Boolean
Language Version : | ActionScript 3.0 |
Product Versions : | BlazeDS 4, LCDS 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Indicates whether the Channel that generated this event is already connected.
public var reconnecting:Boolean
Language Version : | ActionScript 3.0 |
Product Versions : | BlazeDS 4, LCDS 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Indicates whether the Channel that generated this event is reconnecting.
public var rejected:Boolean
Language Version : | ActionScript 3.0 |
Product Versions : | BlazeDS 4, LCDS 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Indicates whether the Channel that generated this event was rejected.
This would be true in the event that the channel has been
disconnected due to inactivity and should not attempt to failover or
connect on an alternate channel.
public function ChannelEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, channel:Channel = null, reconnecting:Boolean = false, rejected:Boolean = false, connected:Boolean = false)
Language Version : | ActionScript 3.0 |
Product Versions : | BlazeDS 4, LCDS 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructs an instance of this event with the specified type and Channel
instance.
Parameters | type:String — The ChannelEvent type.
|
|
| bubbles:Boolean (default = false ) — Specifies whether the event can bubble up the display
list hierarchy.
|
|
| cancelable:Boolean (default = false ) — Indicates whether the behavior associated with the
event can be prevented; used by the RPC subclasses.
|
|
| channel:Channel (default = null ) — The Channel generating the event.
|
|
| reconnecting:Boolean (default = false ) — Indicates whether the Channel is in the process of
reconnecting or not.
|
|
| rejected:Boolean (default = false ) — Indicates whether the Channel's connection has been rejected,
which suppresses automatic reconnection.
|
|
| connected:Boolean (default = false ) — Indicates whether the Channel that generated this event
is already connected.
|
override public function clone():Event
Language Version : | ActionScript 3.0 |
Product Versions : | BlazeDS 4, LCDS 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Clones the ChannelEvent.
Returns | Event — Copy of this ChannelEvent.
|
public static function createEvent(type:String, channel:Channel = null, reconnecting:Boolean = false, rejected:Boolean = false, connected:Boolean = false):ChannelEvent
Language Version : | ActionScript 3.0 |
Product Versions : | BlazeDS 4, LCDS 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Utility method to create a new ChannelEvent that doesn't bubble and
is not cancelable.
Parameters
| type:String — The ChannelEvent type.
|
|
| channel:Channel (default = null ) — The Channel generating the event.
|
|
| reconnecting:Boolean (default = false ) — Indicates whether the Channel is in the process of
reconnecting or not.
|
|
| rejected:Boolean (default = false ) — Indicates whether the Channel's connection has been rejected,
which suppresses automatic reconnection.
|
|
| connected:Boolean (default = false ) — Indicates whether the Channel that generated this event
is already connected.
|
Returnsoverride public function toString():String
Language Version : | ActionScript 3.0 |
Product Versions : | BlazeDS 4, LCDS 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Returns a string representation of the ChannelEvent.
Returns | String — String representation of the ChannelEvent.
|
public static const CONNECT:String = channelConnect
Language Version : | ActionScript 3.0 |
Product Versions : | BlazeDS 4, LCDS 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The CONNECT event type; indicates that the Channel connected to its
endpoint.
The value of this constant is "channelConnect"
.
The properties of the event object have the following values:
Property | Value |
---|
bubbles | false |
cancelable | false |
channel | The channel that generated this event. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
reconnecting | Indicates whether the channel
that generated this event is reconnecting. |
rejected | Indicates whether the channel that
generated this event was rejected. This would be true in the event that
the channel has been disconnected due to inactivity and should not attempt to
failover or connect on an alternate channel. |
public static const DISCONNECT:String = channelDisconnect
Language Version : | ActionScript 3.0 |
Product Versions : | BlazeDS 4, LCDS 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The DISCONNECT event type; indicates that the Channel disconnected from its
endpoint.
The value of this constant is "channelDisconnect"
.
The properties of the event object have the following values:
Property | Value |
---|
bubbles | false |
cancelable | false |
channel | The channel that generated this event. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
reconnecting | Indicates whether the channel
that generated this event is reconnecting. |
rejected | Indicates whether the channel that
generated this event was rejected. This would be true in the event that
the channel has been disconnected due to inactivity and should not attempt to
failover or connect on an alternate channel. |
Mon Jul 9 2012, 07:18 PM -04:00