flash.events

# SecurityErrorEvent - AS3

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

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

An object dispatches a SecurityErrorEvent object to report the occurrence of a security error. Security errors reported through this class are generally from asynchronous operations, such as loading data, in which security violations may not manifest immediately. Your event listener can access the object's `text` property to determine what operation was attempted and any URLs that were involved. If there are no event listeners, the debugger version of Flash Player or the AIR Debug Launcher (ADL) application automatically displays an error message that contains the contents of the `text` property. There is one type of security error event: `SecurityErrorEvent.SECURITY_ERROR`.

Security error events are the final events dispatched for any target object. This means that any other events, including generic error events, are not dispatched for a target object that experiences a security error.

View the examples

Related API Elements

Security class
SECURITY_ERROR

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
|  | 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
--- | --- | ---
|  | SecurityErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0) Creates an Event object that contains information about security error events. | SecurityErrorEvent
|  | clone():Event [override] Creates a copy of the SecurityErrorEvent object and sets the value of each property to match that of the original. | SecurityErrorEvent
|  | 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 SecurityErrorEvent object. | SecurityErrorEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | SECURITY_ERROR : String = "securityError" [static] The SecurityErrorEvent.SECURITY_ERROR constant defines the value of the type property of a securityError event object. | SecurityErrorEvent

Constructor Detail

### SecurityErrorEvent

()
Constructor

`public function SecurityErrorEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, text:String = "", id:int = 0)`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

Creates an Event object that contains information about security error events. Event objects are passed as parameters to event listeners.

Parameters

| `type:String` — The type of the event. Event listeners can access this information through the inherited `type` property. There is only one type of error event: `SecurityErrorEvent.SECURITY_ERROR`.
| `bubbles:Boolean` (default = `false`)`` — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited `bubbles` property.
| `cancelable:Boolean` (default = `false`)`` — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited `cancelable` property.
| `text:String` (default = "``")`` — Text to be displayed as an error message. Event listeners can access this information through the `text` property.
| `id:int` (default = `0`)`` — A reference number to associate with the specific error.

Related API Elements

SECURITY_ERROR
Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

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

Returns

| `Event` — A new securityErrorEvent 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, Flash Player 9, Flash Lite 4

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

`[securityErrorEvent type=value bubbles=value cancelable=value text=value errorID=value]` The `errorId` is only available in Adobe AIR

Returns

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

Constant Detail

### SECURITY_ERROR

Constant

`public static const SECURITY_ERROR:String = "securityError"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 1.0, Flash Player 9, Flash Lite 4

The `SecurityErrorEvent.SECURITY_ERROR` constant defines the value of the `type` property of a `securityError` event object.

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`target` | The network object reporting the security error.
`text` | Text to be displayed as an error message.

Related API Elements

flash.net.FileReference.securityError
flash.net.LocalConnection.securityError
flash.net.NetConnection.securityError
flash.net.Socket.securityError
flash.net.URLLoader.securityError
flash.net.URLStream.securityError
flash.net.XMLSocket.securityError
Examples How to use this example
SecurityErrorEventExample.as
The following example uses the `SecurityErrorEventExample` class to show how a listener method `securityErrorHandler()` can be instantiated and set to listen for `securityError` events to be dispatched. This event will occur when a `URLRequest` location is not in exactly the same domain as the calling SWF, and the requested domain has not authorized cross-domain access by way of a cross-domain policy file.

To create a `SecurityErrorEvent`, replace `http://www.[yourdomain].com` with a path that has not been authorized for cross domain access.

Copy

    package {
        import flash.display.Sprite;
        import flash.net.URLLoader;
        import flash.net.URLRequest;
        import flash.events.SecurityErrorEvent;

        public class SecurityErrorEventExample extends Sprite {
            public function SecurityErrorEventExample() {
                var loader:URLLoader = new URLLoader();
                loader.addEventListener(SecurityErrorEvent.SECURITY_ERROR, securityErrorHandler);

                var request:URLRequest = new URLRequest("http://www.[yourDomain].com");
                loader.load(request);
            }

            private function securityErrorHandler(event:SecurityErrorEvent):void {
                trace("securityErrorHandler: " + event);
            }
        }
    }

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