(Preview)
| Package | mx.messaging.events |
| Class | public class ChannelEvent |
| Inheritance | ChannelEvent  Event Object |
| Subclasses | ChannelFaultEvent |
| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| channel : Channel
The Channel that generated this event. | ChannelEvent | ||
| connected : Boolean
Indicates whether the Channel that generated this event is already connected. | ChannelEvent | ||
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| reconnecting : Boolean
Indicates whether the Channel that generated this event is reconnecting. | ChannelEvent | ||
| rejected : Boolean
Indicates whether the Channel that generated this event was rejected. | ChannelEvent | ||
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
ChannelEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, channel:Channel = null, reconnecting:Boolean = false, rejected:Boolean = false, connected:Boolean = false)
Constructs an instance of this event with the specified type and Channel
instance. | ChannelEvent | ||
[override]
Clones the ChannelEvent. | ChannelEvent | ||
createEvent(type:String, channel:Channel = null, reconnecting:Boolean = false, rejected:Boolean = false, connected:Boolean = false):ChannelEvent [static]
Utility method to create a new ChannelEvent that doesn't bubble and
is not cancelable. | ChannelEvent | ||
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
[override]
Returns a string representation of the ChannelEvent. | ChannelEvent | ||
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| CONNECT : String = "channelConnect" [static]
The CONNECT event type; indicates that the Channel connected to its
endpoint. | ChannelEvent | ||
| DISCONNECT : String = "channelDisconnect" [static]
The DISCONNECT event type; indicates that the Channel disconnected from its
endpoint. | ChannelEvent | ||
Property Detail
channel | property |
public var channel:Channel| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The Channel that generated this event.
connected | property |
public var connected:Boolean| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Indicates whether the Channel that generated this event is already connected.
reconnecting | property |
public var reconnecting:Boolean| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Indicates whether the Channel that generated this event is reconnecting.
rejected | property |
public var rejected:Boolean| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 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.
Constructor Detail
ChannelEvent | () | Constructor |
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, LiveCycle Data Services for Java EE 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructs an instance of this event with the specified type and Channel instance.
Parameterstype:String — The ChannelEvent type.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
channel:Channel (default = null) | |
reconnecting:Boolean (default = false) | |
rejected:Boolean (default = false) | |
connected:Boolean (default = false) |
Method Detail
clone | () | method |
createEvent | () | method |
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, LiveCycle Data Services for Java EE 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) | |
reconnecting:Boolean (default = false) | |
rejected:Boolean (default = false) | |
connected:Boolean (default = false) |
ChannelEvent — New ChannelEvent.
|
toString | () | method |
Constant Detail
CONNECT | Constant |
public static const CONNECT:String = "channelConnect"| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 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. |
DISCONNECT | Constant |
public static const DISCONNECT:String = "channelDisconnect"| Language Version: | ActionScript 3.0 |
| Product Versions: | BlazeDS 4, LiveCycle Data Services for Java EE 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. |
Wed Nov 21 2018, 06:34 AM -08:00