flash.filesystem

# StorageVolumeInfo - AS3

Package | flash.filesystem
Class | public final class StorageVolumeInfo
Inheritance | StorageVolumeInfo EventDispatcher Object

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The StorageVolumeInfo object dispatches a StorageVolumeChangeEvent object when a storage volume is mounted or unmounted. The `StorageVolume.storageVolume` static property references the singleton StorageVolumeInfo object, which dispatches the events. The StorageVolumeInfo class also defines a `getStorageVolumes` method for listing currently mounted storage volumes.

AIR profile support: This feature is supported on all desktop operating systems, but it is not supported on all AIR for TV devices. It is also not supported on mobile devices. You can test for support at run time using the `StorageVolumeInfo.isSupported` property. See AIR Profile Support for more information regarding API support across multiple profiles.

On modern Linux distributions, the StorageVolumeInfo object only dispatches `storageVolumeMount` and `storageVolumeUnmount` events for physical devices and network drives mounted at particular locations.

More examples

Working with storage volumes

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | isSupported : Boolean [static] [read-only] The isSupported property is set to true if the StorageVolumeInfo class is supported on the current platform, otherwise it is set to false. | StorageVolumeInfo
|  | storageVolumeInfo : StorageVolumeInfo [static] [read-only] The singleton instance of the StorageVolumeInfo object. | StorageVolumeInfo

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. | EventDispatcher
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | getStorageVolumes():Vector.<StorageVolume> Returns vector of StorageVolume objects corresponding to the currently mounted storage volumes. | StorageVolumeInfo
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | EventDispatcher
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | 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
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | EventDispatcher
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | EventDispatcher

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher
|  | storageVolumeMount | Dispatched when a storage volume has been mounted. | StorageVolumeInfo
|  | storageVolumeUnmount | Dispatched when a storage volume has been unmounted. | StorageVolumeInfo

Property Detail

### isSupported

property

`isSupported:Boolean` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The `isSupported` property is set to `true` if the StorageVolumeInfo class is supported on the current platform, otherwise it is set to `false`.

Implementation
`public static function get isSupported():Boolean`

### storageVolumeInfo

property

`storageVolumeInfo:StorageVolumeInfo` [read-only]

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

The singleton instance of the StorageVolumeInfo object. Register event listeners on this object for the `storageVolumeMount` and `storageVolumeUnmount` events.

Implementation
`public static function get storageVolumeInfo():StorageVolumeInfo`
Method Detail

### getStorageVolumes

()
method

`public function getStorageVolumes():Vector.<StorageVolume>`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

Returns vector of StorageVolume objects corresponding to the currently mounted storage volumes.

On modern Linux distributions, this method returns objects corresponding to physical devices and network drives mounted at particular locations.

Returns

| `Vector.<StorageVolume>`

Related API Elements

flash.filesystem.StorageVolume
Example ( How to use this example )
The following code lists the native path for the root directory of each mounted storage volume:
Copy

    var volumes:Vector.<StorageVolume> = new Vector.<StorageVolume>;
    volumes = StorageVolumeInfo.storageVolumeInfo.getStorageVolumes();
    for (var i:int = 0; i < volumes.length; i++)
    {
        trace(volumes[i].rootDirectory.nativePath);
    }

Event Detail

### storageVolumeMount

Event

Event Object Type: `flash.events.StorageVolumeChangeEvent`
property StorageVolumeChangeEvent.type = `flash.events.StorageVolumeChangeEvent.STORAGE_VOLUME_MOUNT`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

Dispatched when a storage volume has been mounted.

On modern Linux distributions, the StorageVolumeInfo object only dispatches `storageVolumeMount` and `storageVolumeUnmount` events for physical devices and network drives mounted at particular locations.

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"`

### storageVolumeUnmount

Event

Event Object Type: `flash.events.StorageVolumeChangeEvent`
property StorageVolumeChangeEvent.type = `flash.events.StorageVolumeChangeEvent.STORAGE_VOLUME_UNMOUNT`

Language Version: | ActionScript 3.0

Runtime Versions: | AIR 2

Dispatched when a storage volume has been unmounted.

On modern Linux distributions, the StorageVolumeInfo object only dispatches `storageVolumeMount` and `storageVolumeUnmount` events for physical devices and network drives mounted at particular locations.

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"`

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