| { "type": "class", | |
| "qname": "mx.messaging.events.MessageFaultEvent", | |
| "baseClassname": "org.apache.royale.events.Event" | |
| , | |
| "description": "The MessageFaultEvent class is used to propagate fault messages within the messaging system.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]}, | |
| { "tagName": "royalesuppresspublicvarwarning", | |
| "values": []} ], | |
| "members": [ | |
| { "type": "field", | |
| "qname": "FAULT", | |
| "return": "String", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "The FAULT event type; dispatched for a message fault. <p>The value of this constant is <code>"fault"</code>.</p> <p>The properties of the event object have the following values:</p> <table class="innertable"> <tr><th>Property</th><th>Value</th></tr> <tr><td><code>bubbles</code></td><td>false</td></tr> <tr><td><code>cancelable</code></td><td>false</td></tr> <tr><td><code>currentTarget</code></td><td>The Object that defines the event listener that handles the event. For example, if you use <code>myButton.addEventListener()</code> to register an event listener, myButton is the value of the <code>currentTarget</code>. </td></tr> <tr><td><code>faultCode</code></td><td>Provides destination-specific details of the failure.</td></tr> <tr><td><code>faultDetail</code></td><td>Provides access to the destination-specific reason for the failure.</td></tr> <tr><td><code>faultString</code></td><td>Provides access to the underlying reason for the failure if the channel did not raise the failure itself.</td></tr> <tr><td><code>message</code></td><td>The ErrorMessage for this event.</td></tr> <tr><td><code>rootCause</code></td><td> Provides access to the underlying reason for the failure, if one exists.</td></tr> <tr><td><code>target</code></td><td>The Object that dispatched the event; it is not always the Object listening for the event. Use the <code>currentTarget</code> property to always access the Object listening for the event.</td></tr> </table>", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "eventType", | |
| "values": ["fault"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "method", | |
| "qname": "createEvent", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["static"], | |
| "deprecated": {}, | |
| "description": "Utility method to create a new MessageFaultEvent that doesn't bubble and is not cancelable.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["message The ErrorMessage associated with the fault."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "return", | |
| "values": ["New MessageFaultEvent."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "mx.messaging.events.MessageFaultEvent", | |
| "params": [{ "name": "msg", "type": "mx.messaging.messages.ErrorMessage"}]} | |
| , | |
| { "type": "method", | |
| "qname": "mx.messaging.events.MessageFaultEvent", | |
| "namespace": "", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Constructs an instance of a fault message event for the specified message and fault information. list hierarchy. event can be prevented.", | |
| "tags": [ | |
| { "tagName": "param", | |
| "values": ["type The type for the MessageAckEvent.", "bubbles Specifies whether the event can bubble up the display", "cancelable Indicates whether the behavior associated with the", "message The ErrorMessage associated with the fault."]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "", | |
| "params": [{ "name": "type", "type": "String"}, | |
| { "name": "bubbles", "type": "Boolean"}, | |
| { "name": "cancelable", "type": "Boolean"}, | |
| { "name": "message", "type": "mx.messaging.messages.ErrorMessage"}]} | |
| , | |
| { "type": "field", | |
| "qname": "message", | |
| "return": "mx.messaging.messages.ErrorMessage", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "The ErrorMessage for this event.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "String", | |
| "qname": "faultCode", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Provides access to the destination specific failure code. For more specific details see <code>faultString</code> and <code>faultDetails</code> properties. <p>The format of the fault codes are provided by the remote destination, but, will typically have the following form: <i>host.operation.error</i> For example, <code>"Server.Connect.Failed"</code></p>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["#faultString", "#faultDetail"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "String", | |
| "qname": "faultDetail", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Provides destination specific details of the failure. <p>Typically fault details are a stack trace of an exception thrown at the remote destination.</p>", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["#faultString", "#faultCode"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "String", | |
| "qname": "faultString", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "Provides access to the destination specific reason for the failure.", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["#faultCode", "#faultDetail"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "accessor", | |
| "access": "read-only", | |
| "return": "Object", | |
| "qname": "rootCause", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": [], | |
| "deprecated": {}, | |
| "description": "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.", | |
| "tags": [ | |
| { "tagName": "see", | |
| "values": ["MessageFaultEvent#rootCause"]}, | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ]}, | |
| { "type": "method", | |
| "qname": "clone", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["override"], | |
| "deprecated": {}, | |
| "description": "Clones the MessageFaultEvent.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "return", | |
| "values": ["Copy of this MessageFaultEvent."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "org.apache.royale.events.Event", | |
| "params": []} | |
| , | |
| { "type": "method", | |
| "qname": "toString", | |
| "namespace": "public", | |
| "bindable": [], | |
| "details": ["override"], | |
| "deprecated": {}, | |
| "description": "Returns a string representation of the MessageFaultEvent.", | |
| "tags": [ | |
| { "tagName": "playerversion", | |
| "values": ["Flash 9", "AIR 1.1"]}, | |
| { "tagName": "productversion", | |
| "values": ["BlazeDS 4", "LCDS 3"]}, | |
| { "tagName": "return", | |
| "values": ["String representation of the MessageFaultEvent."]}, | |
| { "tagName": "langversion", | |
| "values": ["3.0"]} ], | |
| "return": "String", | |
| "params": []} | |
| ] | |
| } |