openharmony 鸿蒙 js-apis-file-securityLabel

2025-06-12 浏览 (1)

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

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

说明：

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

导入模块

import { securityLabel } from '@kit.CoreFileKit';

使用说明

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

import { UIAbility } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';

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

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

DataLevel

type DataLevel = 's0'|'s1'|'s2'|'s3'|'s4'

数据安全级别。

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

securityLabel.setSecurityLabel

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

以异步方法设置数据标签。数据标签安全等级仅可由低向高或平级设置，以Promise形式返回结果。

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

参数：

参数名类型必填说明
pathstring是文件路径。
typeDataLevel是文件等级属性，只支持"s0","s1","s2","s3","s4"。

返回值：

类型说明
Promise<void>Promise实例，用于异步获取结果。本调用将返回空值。

错误码：

以下错误码的详细介绍请参见基础文件IO错误码。

错误码ID错误信息
13900001Operation not permitted
13900007Arg list too long
13900015File exists
13900020Invalid argument
13900025No space left on device
13900037No data available
13900041Quota exceeded
13900042Unknown error

示例：

import { BusinessError } from '@kit.BasicServicesKit';
let filePath = pathDir + '/test.txt';
securityLabel.setSecurityLabel(filePath, "s0").then(() => {
  console.info("setSecurityLabel successfully");
}).catch((err: BusinessError) => {
  console.error("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

参数：

参数名类型必填说明
pathstring是文件路径。
typeDataLevel是文件等级属性，只支持"s0","s1","s2","s3","s4"。
callbackAsyncCallback<void>是设置数据标签之后的回调。

错误码：

以下错误码的详细介绍请参见基础文件IO错误码。

错误码ID错误信息
13900001Operation not permitted
13900007Arg list too long
13900015File exists
13900020Invalid argument
13900025No space left on device
13900037No data available
13900041Quota exceeded
13900042Unknown error

示例：

import { BusinessError } from '@kit.BasicServicesKit';
let filePath = pathDir + '/test.txt';
securityLabel.setSecurityLabel(filePath, "s0", (err: BusinessError) => {
  if (err) {
    console.error("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

参数：

参数名类型必填说明
pathstring是文件路径。
typeDataLevel是文件等级属性，只支持"s0","s1","s2","s3","s4"。

错误码：

以下错误码的详细介绍请参见基础文件IO错误码。

错误码ID错误信息
13900001Operation not permitted
13900007Arg list too long
13900015File exists
13900020Invalid argument
13900025No space left on device
13900037No data available
13900041Quota exceeded
13900042Unknown error

示例：

let filePath = pathDir + '/test.txt';
securityLabel.setSecurityLabelSync(filePath, "s0");

securityLabel.getSecurityLabel

getSecurityLabel(path:string):Promise<string>

异步方法获取数据标签。若未设置过数据标签安全等级则默认返回“s3”，以Promise形式返回结果。

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

参数：

参数名类型必填说明
pathstring是文件路径。

返回值：

类型说明
Promise<string>返回数据标签。

错误码：

以下错误码的详细介绍请参见基础文件IO错误码。

错误码ID错误信息
13900001Operation not permitted
13900007Arg list too long
13900015File exists
13900020Invalid argument
13900025No space left on device
13900037No data available
13900041Quota exceeded
13900042Unknown error

示例：

import { BusinessError } from '@kit.BasicServicesKit';
let filePath = pathDir + '/test.txt';
securityLabel.getSecurityLabel(filePath).then((type: string) => {
  console.log("getSecurityLabel successfully, Label: " + type);
}).catch((err: BusinessError) => {
  console.error("getSecurityLabel failed with error message: " + err.message + ", error code: " + err.code);
});

securityLabel.getSecurityLabel

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

异步方法获取数据标签。若未设置过数据标签安全等级则默认返回“s3”，以callback形式返回结果。

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

参数：

参数名类型必填说明
pathstring是文件路径。
callbackAsyncCallback<string>是异步获取数据标签之后的回调。

错误码：

以下错误码的详细介绍请参见基础文件IO错误码。

错误码ID错误信息
13900001Operation not permitted
13900007Arg list too long
13900015File exists
13900020Invalid argument
13900025No space left on device
13900037No data available
13900041Quota exceeded
13900042Unknown error

示例：

import { BusinessError } from '@kit.BasicServicesKit';
let filePath = pathDir + '/test.txt';
securityLabel.getSecurityLabel(filePath, (err: BusinessError, type: string) => {
  if (err) {
    console.error("getSecurityLabel failed with error message: " + err.message + ", error code: " + err.code);
  } else {
    console.log("getSecurityLabel successfully, Label: " + type);
  }
});

securityLabel.getSecurityLabelSync

getSecurityLabelSync(path:string):string

以同步方法获取数据标签。若未设置过数据标签安全等级则默认返回“s3”。

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

参数：

参数名类型必填说明
pathstring是文件路径。

返回值：

类型说明
string返回数据标签。

错误码：

以下错误码的详细介绍请参见基础文件IO错误码。

错误码ID错误信息
13900001Operation not permitted
13900007Arg list too long
13900015File exists
13900020Invalid argument
13900025No space left on device
13900037No data available
13900041Quota exceeded
13900042Unknown error

示例：

let filePath = pathDir + '/test.txt';
let type = securityLabel.getSecurityLabelSync(filePath);
console.log("getSecurityLabel successfully, Label: " + type);

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Core File Kit（文件基础服务）

harmony 鸿蒙Environment

harmony 鸿蒙FileIO

harmony 鸿蒙FileShare_PolicyErrorResult

harmony 鸿蒙FileShare_PolicyInfo

harmony 鸿蒙error_code.h

harmony 鸿蒙文件管理错误码

harmony 鸿蒙FileShare

harmony 鸿蒙FileUri

harmony 鸿蒙@ohos.application.BackupExtensionAbility (备份恢复扩展能力)(系统接口)

  • 所属分类： 后端技术
  • 本文标签： 鸿蒙 软件
  • 版权声明： 本文链接 https://seaxiang.com/blog/gGCjCr