View source

class MessageFaultEvent

package feathers.messaging.events

extends Event

@:directlyUsed

The MessageFaultEvent class is used to propagate fault messages within the messaging system.

Static variables

@:value("fault")staticfinalread onlyFAULT:String = "fault"

The FAULT event type; dispatched for a message fault.

The value of this constant is "fault".

The properties of the event object have the following values:

PropertyValue
`bubbles`false
`cancelable`false
`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`.
`faultCode`Provides destination-specific details of the failure.
`faultDetail`Provides access to the destination-specific reason for the failure.
`faultString`Provides access to the underlying reason for the failure if the channel did not raise the failure itself.
`message`The ErrorMessage for this event.
`rootCause` Provides access to the underlying reason for the failure, if one exists.
`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.

Static methods

staticcreateEvent(msg:ErrorMessage):MessageFaultEvent

Utility method to create a new MessageFaultEvent that doesn't bubble and is not cancelable.

Parameters:

message

The ErrorMessage associated with the fault.

Returns:

New MessageFaultEvent.

Constructor

@:value({ message : null, cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, ?message:ErrorMessage)

Constructs an instance of a fault message event for the specified message and fault information.

Parameters:

type

The type for the MessageAckEvent.

bubbles

Specifies whether the event can bubble up the display list hierarchy.

cancelable

Indicates whether the behavior associated with the event can be prevented.

message

The ErrorMessage associated with the fault.

Variables

@:flash.propertyread onlyfaultCode:String

Provides access to the destination specific failure code. For more specific details see faultString and faultDetails properties.

The format of the fault codes are provided by the remote destination, but, will typically have the following form: host.operation.error For example, "Server.Connect.Failed"

See also:

  • faultString

  • faultDetail

@:flash.propertyread onlyfaultDetail:String

Provides destination specific details of the failure.

Typically fault details are a stack trace of an exception thrown at the remote destination.

See also:

  • faultString

  • faultCode

@:flash.propertyread onlyfaultString:String

Provides access to the destination specific reason for the failure.

See also:

  • faultCode

  • faultDetail

message:ErrorMessage

The ErrorMessage for this event.

@:flash.propertyread onlyrootCause:Dynamic

Provides access to the root cause of the failure, if one exists.

In the case of custom exceptions thrown by a destination, the root cause represents the top level failure that is merely transported by the ErrorMessage.

See also:

  • MessageFaultEvent#rootCause

Methods

clone():Event

Clones the MessageFaultEvent.

Returns:

Copy of this MessageFaultEvent.

toString():String

Returns a string representation of the MessageFaultEvent.

Returns:

String representation of the MessageFaultEvent.