flash.events

# SQLErrorEvent - AS3

Package | flash.events
Class | public class SQLErrorEvent
Inheritance | SQLErrorEvent ErrorEvent TextEvent Event Object

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

A SQLErrorEvent instance is dispatched by a SQLConnection instance or SQLStatement instance when an error occurs while performing a database operation in asynchronous execution mode. The SQLErrorEvent instance that's passed as an event object to listeners provides access to information about the cause of the error and the operation that was being attempted.

The specific details of the failure can be found on the SQLError object in the SQLErrorEvent instance's `error` property.

More examples

Handling database errors

Related API Elements

flash.errors.SQLError
flash.data.SQLConnection
flash.data.SQLStatement

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
|  | 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
|  | error : SQLError [read-only] A SQLError object containing detailed information about the cause of the error. | SQLErrorEvent
|  | errorID : int [read-only] Contains the reference number associated with the specific error. | ErrorEvent
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | target : Object [read-only] The event target. | Event
|  | text : String For a textInput event, the character or sequence of characters entered by the user. | TextEvent
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | SQLErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, error:SQLError = null) Creates a SQLErrorEvent object to pass as an argument to event listeners. | SQLErrorEvent
|  | clone():Event [override] Creates a copy of the SQLErrorEvent object and sets the value of each property to match that of the original. | SQLErrorEvent
|  | formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes. | Event
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event. | Event
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | preventDefault():void Cancels an event's default behavior if that behavior can be canceled. | Event
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow. | Event
|  | stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. | Event
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String [override] Returns a string that contains all the properties of the SQLErrorEvent object. | SQLErrorEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | ERROR : String = "error" [static] The SQLErrorEvent.ERROR constant defines the value of the type property of an error event dispatched when a call to a method of a SQLConnection or SQLStatement instance completes with an error. | SQLErrorEvent

Property Detail

### error

property

`error:SQLError` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

A SQLError object containing detailed information about the cause of the error.

Implementation
`public function get error():SQLError`
Constructor Detail

### SQLErrorEvent

()
Constructor

`public function SQLErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, error:SQLError = null)`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

Creates a SQLErrorEvent object to pass as an argument to event listeners.

Parameters

| `type:String` — The type of the event, accessible in the `type` property. The SQLErrorEvent defines one event type, the `error` event, represented by the `SQLErrorEvent.ERROR` constant.
| `bubbles:Boolean` (default = `false`)`` — Determines whether the event object participates in the bubbling stage of the event flow. The default value is `false`.
| `cancelable:Boolean` (default = `false`)`` — Determines whether the Event object can be cancelled. The default value is `false`.
| `error:SQLError` (default = `null`)`` — The SQLError object that contains the details of the error.

Related API Elements

flash.errors.SQLError;
ERROR
Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

Creates a copy of the SQLErrorEvent object and sets the value of each property to match that of the original.

Returns

| `Event` — A new SQLErrorEvent object with property values that match those of the original.

### toString

()
method

`override public function toString():String`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

Returns a string that contains all the properties of the SQLErrorEvent object. The string is in the following format:

`[SQLErrorEvent type=value bubbles=value cancelable=value error=value]`

The error value has the following format: `SQLError : message value code=value operation=value`

Returns

| `String` — A string that contains all the properties of the SQLErrorEvent object.

Constant Detail

### ERROR

Constant

`public static const ERROR:String = "error"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0

The `SQLErrorEvent.ERROR` constant defines the value of the `type` property of an error event dispatched when a call to a method of a SQLConnection or SQLStatement instance completes with an error. The `error` event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`error` | A SQLError object containing information about the type of error that occurred and the operation that caused the error.
`currentTarget` | The object that is actively processing the event object with an event listener.
`target` | The SQLConnection or SQLStatement object reporting the error.

Related API Elements

flash.data.SQLConnection
flash.data.SQLStatement
flash.errors.SQLError

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00