HarmonyOS API:文件管理

joytrian
发布于 2023-4-6 17:03
浏览
0收藏

版本:v3.1 Beta

@ohos.file.hash (文件哈希处理)

更新时间: 2023-02-17 09:19


该模块提供文件哈希处理能力,对文件内容进行哈希处理。


说明

本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

本模块支持对错误码进行处理,错误码及其适配方式请参考​​错误码适配指导​​。

导入模块

import Hash from '@ohos.file.hash';

使用说明

使用该功能模块对文件/目录进行操作前,需要先获取其应用沙箱路径,获取方式及其接口用法请参考:

Stage模型

import UIAbility from '@ohos.app.ability.UIAbility';

export default class EntryAbility extends UIAbility {
   onWindowStageCreate(windowStage) {
       let context = this.context;
       let pathDir = context.filesDir;
   }
}

FA模型

import featureAbility from '@ohos.ability.featureAbility';

let context = featureAbility.getContext();
context.getFilesDir().then((data) => {
     let pathDir = data;
})

FA模型context的具体获取方法参见​​FA模型​​。

Hash.hash

hash(path: string, algorithm: string): Promise<string>

计算文件的哈希值,使用Promise异步回调。

系统能力:SystemCapability.FileManagement.File.FileIO

参数:

参数名

类型

必填

说明

path

string

待计算哈希值文件的应用沙箱路径。

algorithm

string

哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。

返回值:

类型

说明

Promise<string>

Promise对象。返回文件的哈希值。表示为十六进制数字串,所有字母均大写。

示例:

let filePath = pathDir + "/test.txt";
Hash.hash(filePath, "sha256").then((str) => {
  console.info("calculate file hash succeed:" + str);
}).catch((err) => {
  console.info("calculate file hash failed with error message: " + err.message + ", error code: " + err.code);
});

Hash.hash

hash(path: string, algorithm: string, callback: AsyncCallback<string>): void

计算文件的哈希值,使用callback异步回调。

系统能力:SystemCapability.FileManagement.File.FileIO

参数:

参数名

类型

必填

说明

path

string

待计算哈希值文件的应用沙箱路径。

algorithm

string

哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。

callback

AsyncCallback<string>

异步计算文件哈希操作之后的回调函数(其中给定文件哈希值表示为十六进制数字串,所有字母均大写)。

示例:

let filePath = pathDir + "/test.txt";
Hash.hash(filePath, "sha256", (err, str) => {
  if (err) {
    console.info("calculate file hash failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("calculate file hash succeed:" + str);
  }
});

@ohos.file.securityLabel (数据标签)

更新时间: 2023-03-10 16:42


该模块提供文件数据安全等级的相关功能:向应用程序提供查询、设置文件数据安全等级的JS接口。


说明

本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

本模块支持对错误码进行处理,错误码及其适配方式请参考​​错误码适配指导​​。

导入模块

import securityLabel from '@ohos.file.securityLabel';

使用说明

使用该功能模块对文件/目录进行操作前,需要先获取其应用沙箱路径,获取方式及其接口用法请参考:

Stage模型

import UIAbility from '@ohos.app.ability.UIAbility';

export default class EntryAbility extends UIAbility {
   onWindowStageCreate(windowStage) {
       let context = this.context;
       let pathDir = context.filesDir;
   }
}

FA模型

import featureAbility from '@ohos.ability.featureAbility';

let context = featureAbility.getContext();
context.getFilesDir().then((data) => {
     let pathDir = data;
})

FA模型context的具体获取方法参见​​FA模型​​。

securityLabel.setSecurityLabel

setSecurityLabel(path:string, type:DataLevel):Promise<void>

以异步方法设置数据标签,以promise形式返回结果。

系统能力:SystemCapability.FileManagement.File.FileIO

参数:

参数名

类型

必填

说明

path

string

文件路径

type

DataLevel

文件等级属性,只支持"s0","s1","s2","s3","s4"

返回值:

类型

说明

Promise<void>

Promise实例,用于异步获取结果。本调用将返回空值。

示例:

securityLabel.setSecurityLabel(path, "s0").then(() => {
    console.info("setSecurityLabel successfully");
}).catch((err) => {
    console.info("setSecurityLabel failed with error message: " + err.message + ", error code: " + err.code);
});

securityLabel.setSecurityLabel

setSecurityLabel(path:string, type:DataLevel, callback: AsyncCallback<void>):void

以异步方法设置数据标签,以callback形式返回结果。

系统能力:SystemCapability.FileManagement.File.FileIO

参数:

参数名

类型

必填

说明

path

string

文件路径

type

DataLevel

文件等级属性,只支持"s0","s1","s2","s3","s4"

callback

AsyncCallback<void>

是否设置数据标签之后的回调

示例:

securityLabel.setSecurityLabel(path, "s0", (err) => {
  if (err) {
    console.info("setSecurityLabel failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.info("setSecurityLabel successfully.");
  }
});

securityLabel.setSecurityLabelSync

setSecurityLabelSync(path:string, type:DataLevel):void

以同步方法设置数据标签。

系统能力:SystemCapability.FileManagement.File.FileIO

参数:

参数名

类型

必填

说明

path

string

文件路径

type

DataLevel

文件等级属性,只支持"s0","s1","s2","s3","s4"

示例:

securityLabel.setSecurityLabelSync(path, "s0");

securityLabel.getSecurityLabel

getSecurityLabel(path:string):Promise<string>

异步方法获取数据标签,以promise形式返回结果。

系统能力:SystemCapability.FileManagement.File.FileIO

参数:

参数名

类型

必填

说明

path

string

文件路径

返回值:

类型

说明

Promise<string>

返回数据标签

示例:

securityLabel.getSecurityLabel(path).then((type) => {
    console.log("getSecurityLabel successfully, Label: " + type);
}).catch((err) => {
    console.log("getSecurityLabel failed with error message: " + err.message + ", error code: " + err.code);
});

securityLabel.getSecurityLabel

getSecurityLabel(path:string, callback:AsyncCallback<string>): void

异步方法获取数据标签,以callback形式返回结果。

系统能力:SystemCapability.FileManagement.File.FileIO

参数:

参数名

类型

必填

说明

path

string

文件路径

callback

AsyncCallback<string>

异步获取数据标签之后的回调

示例:

securityLabel.getSecurityLabel(path, (err, type) => {
  if (err) {
    console.log("getSecurityLabel failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.log("getSecurityLabel successfully, Label: " + type);
  }
});

securityLabel.getSecurityLabelSync

getSecurityLabelSync(path:string):string

以同步方法获取数据标签。

系统能力:SystemCapability.FileManagement.File.FileIO

参数:

参数名

类型

必填

说明

path

string

文件路径

返回值:

类型

说明

string

返回数据标签

示例:

let type = securityLabel.getSecurityLabelSync(path);
console.log("getSecurityLabel successfully, Label: " + type);

文件转载自:​​https://developer.harmonyos.com/cn/docs/documentation/doc-references-V3/js-apis-file-securitylabel-0000001452322628-V3?catalogVersion=V3​

分类
已于2023-4-6 17:03:50修改
收藏
回复
举报
回复