blob: db40a6f601eadd2cc53e742cf537bbf2df8737b1 [file] [log] [blame]
{ "type": "class",
"qname": "mx.rpc.events.FaultEvent",
"baseClassname": "mx.rpc.events.AbstractEvent"
,
"description": "This event is dispatched when an RPC call has a fault.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"members": [
{ "type": "field",
"qname": "FAULT",
"return": "String",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "The FAULT event type. <p>The properties of the event object have the following values:</p> <table class=&quot;innertable&quot;> <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>true, calling preventDefault() from the associated token's responder.fault method will prevent the service or operation from dispatching this event</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>fault</code></td><td>The Fault object that contains the details of what caused this event.</td></tr> <tr><td><code>message</code></td><td>The Message associated with this event.</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> <tr><td><code>token</code></td><td>The token that represents the call to the method. Used in the asynchronous completion token pattern.</td></tr> </table>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "eventType",
"values": ["fault"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "mx.rpc.events.FaultEvent",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Creates a new FaultEvent. The fault is a required parameter while the call and message are optional.",
"tags": [
{ "tagName": "param",
"values": ["type The event type; indicates the action that triggered the event.", "bubbles Specifies whether the event can bubble up the display list hierarchy.", "cancelable Specifies whether the behavior associated with the event can be prevented.", "fault Object that holds details of the fault, including a faultCode and faultString.", "token Token representing the call to the method. Used in the asynchronous completion token pattern.", "message Source Message of the fault."]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "",
"params": [{ "name": "type", "type": "String"},
{ "name": "bubbles", "type": "Boolean"},
{ "name": "cancelable", "type": "Boolean"},
{ "name": "fault", "type": "mx.rpc.Fault"},
{ "name": "token", "type": "mx.rpc.AsyncToken"},
{ "name": "message", "type": "mx.messaging.messages.IMessage"}]}
,
{ "type": "accessor",
"access": "read-only",
"return": "mx.rpc.Fault",
"qname": "fault",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The Fault object that contains the details of what caused this event.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Object",
"qname": "headers",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "In certain circumstances, headers may also be returned with a fault to provide further context to the failure.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "int",
"qname": "statusCode",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "If the source message was sent via HTTP, this property provides access to the HTTP response status code (if available), otherwise the value is 0.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "toString",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "Returns a string representation of the FaultEvent.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "return",
"values": ["String representation of the FaultEvent."]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "String",
"params": []}
,
{ "type": "method",
"qname": "callTokenResponders",
"namespace": "mx_internal",
"bindable": [],
"details": ["override"],
"deprecated": {},
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "createEventFromMessageFault",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "Given a MessageFaultEvent, this method constructs and returns a FaultEvent. fault information from.",
"tags": [
{ "tagName": "param",
"values": ["value MessageFaultEvent reference to extract the appropriate", "token AsyncToken [optional] associated with this fault."]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "return",
"values": ["Returns a FaultEvent."]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "mx.rpc.events.FaultEvent",
"params": [{ "name": "value", "type": "mx.messaging.events.MessageFaultEvent"},
{ "name": "token", "type": "mx.rpc.AsyncToken"}]}
,
{ "type": "method",
"qname": "createEvent",
"namespace": "public",
"bindable": [],
"details": ["static"],
"deprecated": {},
"description": "Given a Fault, this method constructs and returns a FaultEvent.",
"tags": [
{ "tagName": "param",
"values": ["fault Fault that contains the details of the FaultEvent.", "token AsyncToken [optional] associated with this fault.", "msg Message [optional] associated with this fault."]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "return",
"values": ["Returns a FaultEvent."]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "mx.rpc.events.FaultEvent",
"params": [{ "name": "fault", "type": "mx.rpc.Fault"},
{ "name": "token", "type": "mx.rpc.AsyncToken"},
{ "name": "msg", "type": "mx.messaging.messages.IMessage"}]}
]
}