flash.events

# StatusEvent - AS3

Package | flash.events
Class | public class StatusEvent
Inheritance | StatusEvent Event Object

Language Version: | ActionScript 3.0

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

An object dispatches a StatusEvent object when a device, such as a camera or microphone, or an object such as a LocalConnection object reports its status. There is only one type of status event: `StatusEvent.STATUS`.

Related API Elements

flash.media.Camera
flash.media.Microphone
flash.net.LocalConnection
flash.sensors.Accelerometer
flash.sensors.Geolocation
air.net.ServiceMonitor

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
|  | code : String A description of the object's status. | StatusEvent
|  | 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
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | level : String The category of the message, such as "status", "warning" or "error". | StatusEvent
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | StatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, code:String = "", level:String = "") Creates an Event object that contains information about status events. | StatusEvent
|  | clone():Event [override] Creates a copy of the StatusEvent object and sets the value of each property to match that of the original. | StatusEvent
|  | 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 StatusEvent object. | StatusEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | STATUS : String = "status" [static] Defines the value of the type property of a status event object. | StatusEvent

Property Detail

### code

property

`code:String`

Language Version: | ActionScript 3.0

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

A description of the object's status.

Implementation
`public function get code():String`
`public function set code(value:String):void`

Related API Elements

flash.media.Camera
flash.media.Microphone
flash.net.LocalConnection

### level

property

`level:String`

Language Version: | ActionScript 3.0

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

The category of the message, such as `"status"`, `"warning"` or `"error"`.

Implementation
`public function get level():String`
`public function set level(value:String):void`

Related API Elements

flash.media.Camera
flash.media.Microphone
flash.net.LocalConnection
Constructor Detail

### StatusEvent

()
Constructor

`public function StatusEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, code:String = "", level:String = "")`

Language Version: | ActionScript 3.0

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

Creates an Event object that contains information about status 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 status event: `StatusEvent.STATUS`.
| `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.
| `code:String` (default = "``")`` — A description of the object's status. Event listeners can access this information through the `code` property.
| `level:String` (default = "``")`` — The category of the message, such as `"status"`, `"warning"` or `"error"`. Event listeners can access this information through the `level` property.

Related API Elements

STATUS
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 StatusEvent object and sets the value of each property to match that of the original.

Returns

| `Event` — A new StatusEvent 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 StatusEvent object. The string is in the following format:

`[StatusEvent type=value bubbles=value cancelable=value code=value level=value]`

Returns

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

Constant Detail

### STATUS

Constant

`public static const STATUS:String = "status"`

Language Version: | ActionScript 3.0

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

Defines the value of the `type` property of a `status` event object.

This event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`code` | A description of the object's status.
`currentTarget` | The object that is actively processing the Event object with an event listener.
`level` | The category of the message, such as `"status"`, `"warning"` or `"error"`.
`target` | The object reporting its status.

Related API Elements

flash.media.Camera.status
flash.media.Microphone.status
flash.net.LocalConnection.status
flash.net.NetStream.status
flash.sensors.Geolocation.status
flash.sensors.Accelerometer.status

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