该模块提供文件数据安全品级的相关功能:向应用程序提供查询、设置文件数据安全品级的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;
- }
- }
复制代码 DataLevel
type DataLevel = ‘s0’ | ‘s1’ | ‘s2’ | ‘s3’ | ‘s4’ |
数据安全级别。
系统能力:SystemCapability.FileManagement.File.FileIO
securityLabel.setSecurityLabel
setSecurityLabel(path:string, type ataLevel) romise
以异步方法设置数据标签,数据标签安全品级仅可由低向高或平级设置,以Promise情势返回结果。
系统能力:SystemCapability.FileManagement.File.FileIO
参数:
参数名范例必填阐明pathstring是文件路径type[DataLevel]是文件品级属性,只支持"s0",“s1”,“s2”,“s3”,“s4” 返回值:
范例阐明PromisePromise实例,用于异步获取结果。本调用将返回空值。 错误码ID错误信息13900001Operation not permitted13900007Arg list too long13900015File exists13900020Invalid argument13900025No space left on device13900037No data available13900041Quota exceeded13900042Unknown 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 ataLevel, callback: AsyncCallback):void
以异步方法设置数据标签,数据标签安全品级仅可由低向高或平级设置,以callback情势返回结果。
系统能力:SystemCapability.FileManagement.File.FileIO
参数:
参数名范例必填阐明pathstring是文件路径typeDataLevel是文件品级属性,只支持"s0",“s1”,“s2”,“s3”,“s4”callbackAsyncCallback是是否设置数据标签之后的回调 错误码ID错误信息13900001Operation not permitted13900007Arg list too long13900015File exists13900020Invalid argument13900025No space left on device13900037No data available13900041Quota exceeded13900042Unknown 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 ataLevel):void
以同步方法设置数据标签,数据标签安全品级仅可由低向高或平级设置。
系统能力:SystemCapability.FileManagement.File.FileIO
参数:
参数名范例必填阐明pathstring是文件路径typeDataLevel是文件品级属性,只支持"s0",“s1”,“s2”,“s3”,“s4” 错误码ID错误信息13900001Operation not permitted13900007Arg list too long13900015File exists13900020Invalid argument13900025No space left on device13900037No data available13900041Quota exceeded13900042Unknown error 示例:
- let filePath = pathDir + '/test.txt';
- securityLabel.setSecurityLabelSync(filePath, "s0");
复制代码 securityLabel.getSecurityLabel
getSecurityLabel(path:string) romise
异步方法获取数据标签,若未设置过数据标签安全品级则默认返回“s3”,以Promise情势返回结果。
系统能力:SystemCapability.FileManagement.File.FileIO
参数:
参数名范例必填阐明pathstring是文件路径 返回值:
范例阐明Promise返回数据标签 错误码ID错误信息13900001Operation not permitted13900007Arg list too long13900015File exists13900020Invalid argument13900025No space left on device13900037No data available13900041Quota exceeded13900042Unknown 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): void
异步方法获取数据标签,若未设置过数据标签安全品级则默认返回“s3”,以callback情势返回结果。
系统能力:SystemCapability.FileManagement.File.FileIO
参数:
参数名范例必填阐明pathstring是文件路径callbackAsyncCallback是异步获取数据标签之后的回调 错误码ID错误信息13900001Operation not permitted13900007Arg list too long13900015File exists13900020Invalid argument13900025No space left on device13900037No data available13900041Quota exceeded13900042Unknown 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返回数据标签 错误码ID错误信息13900001Operation not permitted13900007Arg list too long13900015File exists13900020Invalid argument13900025No space left on device13900037No data available13900041Quota exceeded13900042Unknown error 示例:
- let filePath = pathDir + '/test.txt';
- let type = securityLabel.getSecurityLabelSync(filePath);
- console.log("getSecurityLabel successfully, Label: " + type);
复制代码 免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。 |