Volume Management

NOTE

• The initial APIs of this module are supported since API version 9.
• API version 9 is a canary release for trial use. The APIs of this version may be unstable.

Modules to Import

import volumemanager from "@ohos.volumeManager";

volumemanager.getAllVolumes

getAllVolumes(): Promise<Array<Volume>>

Asynchronously obtains information about all available volumes. This method uses a promise to return the result.

System capability: SystemCapability.FileManagement.StorageService.Volume

• Return value

• Example

  volumemanager.getAllVolumes().then(function(volumes){
      // do something
  });
  

volumemanager.getAllVolumes

getAllVolumes(callback: AsyncCallback<Array<Volume>>): void

Asynchronously obtains information about all available volumes. This method uses a callback to return the result.

System capability: SystemCapability.FileManagement.StorageService.Volume

• Parameters

• Example

  let uuid = "";
  volumemanager.getAllVolumes(uuid, function(error, volumes){
      // do something
  });
  

volumemanager.mount

mount(volumeId: string): Promise<boolean>

Asynchronously mounts a volume. This method uses a promise to return the result.

System capability: SystemCapability.FileManagement.StorageService.Volume

• Parameters

• Return value

• Example

  let volumeId = "";
  volumemanager.mount(volumeId).then(function(flag){
      // do something
  });
  

volumemanager.mount

mount(volumeId: string, callback:AsyncCallback<boolean>):void

Asynchronously obtains the available space of the specified volume. This method uses a callback to return the result.

System capability: SystemCapability.FileManagement.StorageService.Volume

• Parameters

• Example

  let volumeId = "";
  volumemanager.mount(volumeId, function(error, flag){
      // do something
  });
  

volumemanager.unmount

unmount(volumeId: string): Promise<boolean>

Asynchronously unmounts a volume. This method uses a promise to return the result.

System capability: SystemCapability.FileManagement.StorageService.Volume

• Parameters

• Return value

• Example

  let volumeId = "";
  volumemanager.unmount(volumeId).then(function(flag){
      // do something
  });
  

volumemanager.unmount

unmount(volumeId: string, callback:AsyncCallback<boolean>):void

Asynchronously unmounts a volume. This method uses a callback to return the result.

System capability: SystemCapability.FileManagement.StorageService.Volume

• Parameters

• Example

  let volumeId = "";
  volumemanager.unmount(volumeId, function(error, flag){
      // do something
  });
  

Volume

System capability: SystemCapability.FileManagement.StorageService.Volume

Attributes