卷管理

該模塊提供卷、磁盤查詢和管理的相關功能：包括查詢卷信息，對卷的掛載卸載、對磁盤分區(qū)以及卷的格式化等功能。

說明：
開發(fā)前請熟悉鴻蒙開發(fā)指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

• 本模塊首批接口從API version 9開始支持。
• API 9當前為Canary版本，僅供試用，不保證接口可穩(wěn)定調(diào)用。
• 本模塊接口為系統(tǒng)接口，三方應用不支持調(diào)用。

導入模塊

import volumemanager from "@ohos.volumeManager";

volumemanager.getAllVolumes

getAllVolumes(): Promise>

異步獲取當前所有可獲得的卷信息，以promise方式返回。

需要權限 ：ohos.permission.STORAGE_MANAGER

系統(tǒng)能力 ：SystemCapability.FileManagement.StorageService.Volume

返回值：

示例：

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

volumemanager.getAllVolumes

getAllVolumes(callback: AsyncCallback>): void

異步獲取當前所有可獲得的卷信息，以callback方式返回。

需要權限 ：ohos.permission.STORAGE_MANAGER

系統(tǒng)能力 ：SystemCapability.FileManagement.StorageService.Volume

參數(shù)：

示例：

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

volumemanager.mount

mount(volumeId: string): Promise

異步掛載指定卷，以promise方式返回。

需要權限 ：ohos.permission.MOUNT_UNMOUNT_MANAGER

系統(tǒng)能力 ：SystemCapability.FileManagement.StorageService.Volume

參數(shù)：

返回值：

示例：

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

volumemanager.mount

mount(volumeId: string, callback:AsyncCallback):void

異步獲取指定卷的可用空間大小，以callback方式返回。

需要權限 ：ohos.permission.MOUNT_UNMOUNT_MANAGER

系統(tǒng)能力 ：SystemCapability.FileManagement.StorageService.Volume

參數(shù)：

示例：

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

volumemanager.unmount

unmount(volumeId: string): Promise

異步卸載指定卷，以promise方式返回。

需要權限 ：ohos.permission.MOUNT_UNMOUNT_MANAGER

系統(tǒng)能力 ：SystemCapability.FileManagement.StorageService.Volume

參數(shù)：

返回值：

示例：

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

volumemanager.unmount

unmount(volumeId: string, callback:AsyncCallback):void

異步卸載指定卷，以callback方式返回。

需要權限 ：ohos.permission.MOUNT_UNMOUNT_MANAGER

系統(tǒng)能力 ：SystemCapability.FileManagement.StorageService.Volume

參數(shù)：

示例：

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

volumemanager.getVolumeByUuid

getVolumeByUuid(uuid: string): Promise

異步通過uuid獲得卷信息，以promise方式返回。

需要權限 ：ohos.permission.STORAGE_MANAGER

系統(tǒng)能力 ：SystemCapability.FileManagement.StorageService.Volume

參數(shù)：

| 參數(shù)名 | 類型 | 必填 | 說明 | | -------- | ------ | ---- | ---- | | uuid | string | 是 | 卷uuid |

返回值：

| 類型 | 說明 | | ---------------------------------- | -------------------------- | | Promise<[Volume]> | 返回當前所有可獲得的卷信息 |

示例：

let uuid = "";
volumemanager.getVolumeByUuid(uuid).then(function(volume) {
    console.info("getVolumeByUuid successfully:" + JSON.stringify(volume));
}).catch(function(error){
    console.info("getVolumeByUuid failed with error:"+ error);
});

volumemanager.getVolumeByUuid

getVolumeByUuid(uuid: string, callback: AsyncCallback): void

異步通過uuid獲得卷信息，以callback方式返回。

需要權限 ：ohos.permission.STORAGE_MANAGER

系統(tǒng)能力 ：SystemCapability.FileManagement.StorageService.Volume

參數(shù)：

示例：

let uuid = "";
volumemanager.getVolumeByUuid(uuid, (error, volume) = > {
    // do something    
});

volumemanager.getVolumeById

getVolumeById(id: string): Promise

異步通過卷id獲得卷信息，以promise方式返回。

需要權限 ：ohos.permission.STORAGE_MANAGER

系統(tǒng)能力 ：SystemCapability.FileManagement.StorageService.Volume

參數(shù)：

返回值：

示例：

let id = "";
volumemanager.getVolumeById(id).then(function(volume) {
    console.info("getVolumeById successfully:" + JSON.stringify(volume));
}).catch(function(error){
    console.info("getVolumeById failed with error:"+ error);
});

volumemanager.getVolumeById

getVolumeById(id: string, callback: AsyncCallback): void

異步通過卷id獲得卷信息，以callback方式返回。

需要權限 ：ohos.permission.STORAGE_MANAGER

系統(tǒng)能力 ：SystemCapability.FileManagement.StorageService.Volume

參數(shù)：

| 參數(shù)名 | 類型 | 必填 | 說明 | | -------- | ------------------------------------------------ | ---- | -------------------- | | id | string | 是 | 卷id | | callback | callback:AsyncCallback<[Volume]> | 是 | 獲取卷信息之后的回調(diào) |

示例：

let id = "";
volumemanager.getVolumeById(id, (error, volume) = > {
    // do something    
});

volumemanager.setVolumeDescription

setVolumeDescription(uuid: string, description: string): Promise

異步通過uuid設置卷描述，以promise方式返回。

需要權限 ：ohos.permission.MOUNT_UNMOUNT_MANAGER

系統(tǒng)能力 ：SystemCapability.FileManagement.StorageService.Volume

參數(shù)：

返回值：

示例：

let uuid = "";
let description = "";
volumemanager.setVolumeDescription(uuid, description).then(function() {
    console.info("setVolumeDescription successfully");
}).catch(function(error){
    console.info("setVolumeDescription failed with error:"+ error);
});

volumemanager.setVolumeDescription

setVolumeDescription(uuid: string, description: string, callback: AsyncCallback): void

異步通過uuid設置卷描述，以callback方式返回。

需要權限 ：ohos.permission.MOUNT_UNMOUNT_MANAGER

系統(tǒng)能力 ：SystemCapability.FileManagement.StorageService.Volume

參數(shù)：

示例：

let uuid = "";
let description = "";
volumemanager.setVolumeDescription(uuid, description, (error, bool) = > {
    // do something    
});

volumemanager.format

format(volId: string): Promise

異步對指定卷進行格式化，以promise方式返回。

需要權限 ：ohos.permission.MOUNT_FORMAT_MANAGER

系統(tǒng)能力 ：SystemCapability.FileManagement.StorageService.Volume

參數(shù)：

返回值：

| 類型 | 說明 | | --------------------- | ----------------------- | | Promise | 對指定卷進行格式化 |

示例：

let volId = "";
volumemanager.format(volId).then(function() {
    console.info("format successfully");
}).catch(function(error){
    console.info("format failed with error:"+ error);
});

volumemanager.format

format(volId: string, callback: AsyncCallback): void

異步對指定卷進行格式化，以callback方式返回。

需要權限 ：ohos.permission.MOUNT_FORMAT_MANAGER

系統(tǒng)能力 ：SystemCapability.FileManagement.StorageService.Volume

參數(shù)：

| 參數(shù)名 | 類型 | 必填 | 說明 | | -------- | --------------------------------------- | ---- | ---------------- | | volId | string | 是 | 卷id | | callback | callback:AsyncCallback | 是 | 對指定卷進行格式化 |

示例：

let volId = "";
volumemanager.format(volId, (error, bool) = > {
    // do something    
});

volumemanager.partition

partition(volId: string, fstype: string): Promise

異步對磁盤進行分區(qū)，以promise方式返回。

需要權限 ：ohos.permission.MOUNT_FORMAT_MANAGER

系統(tǒng)能力 ：SystemCapability.FileManagement.StorageService.Volume

參數(shù)：

| 參數(shù)名 | 類型 | 必填 | 說明 | | ----------- | ------ | ---- | ---- | | volId | string | 是 | 卷所屬的磁盤id | | fstype | string | 是 | 分區(qū)類型 |

返回值：

示例：

let volId = "";
let fstype = "";
volumemanager.partition(volId, fstype).then(function() {
    console.info("partition successfully");
}).catch(function(error){
    console.info("partition failed with error:"+ error);
});

volumemanager.partition

partition(volId: string, fstype : string, callback: AsyncCallback): void

異步對磁盤進行分區(qū)，以callback方式返回。

需要權限 ：ohos.permission.MOUNT_FORMAT_MANAGER

系統(tǒng)能力 ：SystemCapability.FileManagement.StorageService.Volume

參數(shù)：

示例：

let volId = "";
let fstype = "";
volumemanager.partition(volId, fstype, (error, bool) = > {
    // do something    
});

Volume

系統(tǒng)能力 ：以下各項對應的系統(tǒng)能力均為SystemCapability.FileManagement.StorageService.Volume。

屬性

審核編輯 黃宇