flash.events

# StorageVolumeChangeEvent - AS3

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

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The `StorageVolumeInfo.storageVolumeInfo` object dispatches a StorageVolumeChangeEvent event object when a storage volume is mounted or unmounted. There are two types of StorageVolumeChangeEvent: `storageVolumeMount` and `storageVolumeUnmount`.

On Linux, the StorageVolumeInfo object only dispatches `storageVolumeMount` and `storageVolumeUnmount` events for physical devices. It does not dispatch events when the user mounts or unmounts volumes over a network.

Some devices, such as some digital cameras and phones, appear in the `StorageVolumeInfo.getStorageVolumes()` array, but they do not dispatch StorageVolumeChangeEvent objects when mounted or unmounted.

Related API Elements

flash.filesystem.StorageVolumeInfo

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
|  | eventPhase : uint [read-only] The current phase in the event flow. | Event
|  | rootDirectory : File [read-only] A File object corresponding to the root directory of the mounted volume. | StorageVolumeChangeEvent
|  | storageVolume : StorageVolume [read-only] A StorageVolume object containing information about a mounted volume. | StorageVolumeChangeEvent
|  | 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
--- | --- | ---
|  | StorageVolumeChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, path:File = null, volume:StorageVolume = null) Creates a StorageVolumeChangeEvent object to pass as an argument to event listeners. | StorageVolumeChangeEvent
|  | clone():Event [override] Duplicates an instance of an Event subclass. | StorageVolumeChangeEvent
|  | 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 containing all the properties of the Event object. | StorageVolumeChangeEvent
|  | valueOf():Object Returns the primitive value of the specified object. | Object

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | STORAGE_VOLUME_MOUNT : String = "storageVolumeMount" [static] The StorageVolumeChangeEvent.VOLUME_MOUNT constant defines the value of the type property of a StorageVolumeChangeEvent when a volume is mounted. | StorageVolumeChangeEvent
|  | STORAGE_VOLUME_UNMOUNT : String = "storageVolumeUnmount" [static] The StorageVolumeChangeEvent.VOLUME_MOUNT constant defines the value of the type property of a StorageVolumeChangeEvent when a volume is unmounted. | StorageVolumeChangeEvent

Property Detail

### rootDirectory

property

`rootDirectory:File` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

A File object corresponding to the root directory of the mounted volume. If the volume has been unmounted (if the event type is `storageVolumeUnmount`, this property is set to `null`.

Implementation
`public function get rootDirectory():File`

Related API Elements

flash.filesystem.File

### storageVolume

property

`storageVolume:StorageVolume` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

A StorageVolume object containing information about a mounted volume. This property is `null` for an unmounted volume (for an `storageVolumeUnmount` event).

Implementation
`public function get storageVolume():StorageVolume`

Related API Elements

flash.filesystem.StorageVolume
Constructor Detail

### StorageVolumeChangeEvent

()
Constructor

`public function StorageVolumeChangeEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, path:File = null, volume:StorageVolume = null)`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

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

Parameters

| `type:String` — The type of the event, accessible in the `type` property. The StorageVolumeChangeEvent class defines two event types, the `storageVolumeMount` event, represented by the `StorageVolumeChangeEvent.STORAGE_VOLUME_MOUNT` constant, and the `storageVolumeUnmount` event, represented by the `StorageVolumeChangeEvent.STORAGE_VOLUME_UNMOUNT` 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`.
| `path:File` (default = `null`)`` — The name of the storage volume.
| `volume:StorageVolume` (default = `null`)`` — The File object representing the storage volume.

Related API Elements

flash.errors.SQLError
flash.events.ErrorEvent.ERROR
Method Detail

### clone

()
method

`override public function clone():Event`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

Duplicates an instance of an Event subclass.

Returns a new Event object that is a copy of the original instance of the Event object. You do not normally call `clone()`; the EventDispatcher class calls it automatically when you redispatch an event—that is, when you call `dispatchEvent(event)` from a handler that is handling `event`.

The new Event object includes all the properties of the original.

When creating your own custom Event class, you must override the inherited `Event.clone()` method in order for it to duplicate the properties of your custom class. If you do not set all the properties that you add in your event subclass, those properties will not have the correct values when listeners handle the redispatched event.

In this example, `PingEvent` is a subclass of `Event` and therefore implements its own version of `clone()`.

Copy

         class PingEvent extends Event {
             var URL:String;

         public override function clone():Event {
                  return new PingEvent(type, bubbles, cancelable, URL);
            }
         }

Returns

| `Event` — A new Event object that is identical to the original.

### toString

()
method

`override public function toString():String`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

Returns a string containing all the properties of the Event object. The string is in the following format:

`[Event type=value bubbles=value cancelable=value]`

Returns

| `String` — A string containing all the properties of the Event object.

Constant Detail

### STORAGE_VOLUME_MOUNT

Constant

`public static const STORAGE_VOLUME_MOUNT:String = "storageVolumeMount"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The `StorageVolumeChangeEvent.VOLUME_MOUNT` constant defines the value of the `type` property of a StorageVolumeChangeEvent when a volume is mounted.

The event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`currentTarget` | The StorageVolumeChangeEvent object.
`file` | A File object representing the storage volume.
`name` | The name of the storage volume.
`target` | The StorageVolumeChangeEvent object.
`type` | `"storageVolumeMount"`

Related API Elements

flash.filesystem.StorageVolumeInfo

### STORAGE_VOLUME_UNMOUNT

Constant

`public static const STORAGE_VOLUME_UNMOUNT:String = "storageVolumeUnmount"`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The `StorageVolumeChangeEvent.VOLUME_MOUNT` constant defines the value of the `type` property of a StorageVolumeChangeEvent when a volume is unmounted.

The event has the following properties:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `false`; there is no default behavior to cancel.
`currentTarget` | The StorageVolumeChangeEvent object.
`file` | A File object representing the storage volume.
`name` | The name of the storage volume.
`target` | The StorageVolumeChangeEvent object.
`type` | `"storageVolumeUnmount"`

Related API Elements

flash.filesystem.StorageVolumeInfo

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