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

说明

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

## 导入模块

PhonePC/2in1TabletTVWearable



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

## 使用说明

PhonePC/2in1TabletTVWearable

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



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

4. export default class EntryAbility extends UIAbility {
5. onWindowStageCreate(windowStage: window.WindowStage) {
6. let context = this.context;
7. let pathDir = context.filesDir;
8. }
9. }
```

使用该功能模块对文件/目录进行操作前，需要先获取其应用沙箱路径，获取方式及其接口用法请参考：[应用上下文Context-获取应用文件路径](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/application-context-stage#获取应用文件路径)。

## DataLevel

PhonePC/2in1TabletTVWearable

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

数据安全等级。

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

展开

| 类型 | 说明 |
| --- | --- |
| 's0' | 数据安全等级"S0" 。 |
| 's1' | 数据安全等级"S1" 。 |
| 's2' | 数据安全等级"S2" 。 |
| 's3' | 数据安全等级"S3" 。 |
| 's4' | 数据安全等级"S4" 。 |

数据安全等级详细说明请见[数据安全标签](https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/access-control-by-device-and-data-level#数据安全标签)。

## securityLabel.setSecurityLabel

PhonePC/2in1TabletTVWearable

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

设置文件或目录的数据安全等级。数据安全等级仅可由低向高或平级设置。使用Promise异步回调。

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

**参数：**

展开

| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| path | string | 是 | 文件路径。 |
| type | [DataLevel](/consumer/cn/doc/harmonyos-references/js-apis-file-securitylabel#datalevel) | 是 | 数据安全等级，只支持"s0","s1","s2","s3","s4"。 |

**返回值：**

展开

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

**错误码：**

以下错误码的详细介绍请参见[基础文件IO错误码](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/errorcode-filemanagement#基础文件io错误码)。

展开

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

**示例：**



```
1. import { BusinessError } from '@kit.BasicServicesKit';
2. let filePath = pathDir + '/test.txt';
3. securityLabel.setSecurityLabel(filePath, "s0").then(() => {
4. console.info("setSecurityLabel successfully");
5. }).catch((err: BusinessError) => {
6. console.error("setSecurityLabel failed with error message: " + err.message + ", error code: " + err.code);
7. });
```

## securityLabel.setSecurityLabel

PhonePC/2in1TabletTVWearable

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

设置文件或目录的数据安全等级。数据安全等级仅可由低向高或平级设置。使用callback异步回调。

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

**参数：**

展开

| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| path | string | 是 | 文件路径。 |
| type | [DataLevel](/consumer/cn/doc/harmonyos-references/js-apis-file-securitylabel#datalevel) | 是 | 数据安全等级，只支持"s0","s1","s2","s3","s4"。 |
| callback | AsyncCallback<void> | 是 | 设置数据安全等级之后的回调。 |

**错误码：**

以下错误码的详细介绍请参见[基础文件IO错误码](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/errorcode-filemanagement#基础文件io错误码)。

展开

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

**示例：**



```
1. import { BusinessError } from '@kit.BasicServicesKit';
2. let filePath = pathDir + '/test.txt';
3. securityLabel.setSecurityLabel(filePath, "s0", (err: BusinessError) => {
4. if (err) {
5. console.error("setSecurityLabel failed with error message: " + err.message + ", error code: " + err.code);
6. } else {
7. console.info("setSecurityLabel successfully.");
8. }
9. });
```

## securityLabel.setSecurityLabelSync

PhonePC/2in1TabletTVWearable

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

以同步方法设置文件或目录的数据安全等级。数据安全等级仅可由低向高或平级设置。

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

**参数：**

展开

| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| path | string | 是 | 文件路径。 |
| type | [DataLevel](/consumer/cn/doc/harmonyos-references/js-apis-file-securitylabel#datalevel) | 是 | 数据安全等级，只支持"s0","s1","s2","s3","s4"。 |

**错误码：**

以下错误码的详细介绍请参见[基础文件IO错误码](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/errorcode-filemanagement#基础文件io错误码)。

展开

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

**示例：**



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

## securityLabel.getSecurityLabel

PhonePC/2in1TabletTVWearable

getSecurityLabel(path:string):Promise<string>

获取文件或目录的数据安全等级。若未设置过数据安全等级则默认返回“s3”。使用Promise异步回调。

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

**参数：**

展开

| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| path | string | 是 | 文件路径。 |

**返回值：**

展开

| 类型 | 说明 |
| --- | --- |
| Promise<string> | 返回数据安全等级。 |

**错误码：**

以下错误码的详细介绍请参见[基础文件IO错误码](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/errorcode-filemanagement#基础文件io错误码)。

展开

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

**示例：**



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

## securityLabel.getSecurityLabel

PhonePC/2in1TabletTVWearable

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

获取文件或目录的数据安全等级。若未设置过数据安全等级则默认返回“s3”。使用callback异步回调。

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

**参数：**

展开

| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| path | string | 是 | 文件路径。 |
| callback | AsyncCallback<string> | 是 | 异步获取数据安全等级之后的回调。 |

**错误码：**

以下错误码的详细介绍请参见[基础文件IO错误码](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/errorcode-filemanagement#基础文件io错误码)。

展开

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

**示例：**



```
1. import { BusinessError } from '@kit.BasicServicesKit';
2. let filePath = pathDir + '/test.txt';
3. securityLabel.getSecurityLabel(filePath, (err: BusinessError, type: string) => {
4. if (err) {
5. console.error("getSecurityLabel failed with error message: " + err.message + ", error code: " + err.code);
6. } else {
7. console.info("getSecurityLabel successfully, Label: " + type);
8. }
9. });
```

## securityLabel.getSecurityLabelSync

PhonePC/2in1TabletTVWearable

getSecurityLabelSync(path:string):string

以同步方法获取文件或目录的数据安全等级。若未设置过数据安全等级则默认返回“s3”。

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

**参数：**

展开

| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | --- |
| path | string | 是 | 文件路径。 |

**返回值：**

展开

| 类型 | 说明 |
| --- | --- |
| string | 返回数据安全等级。 |

**错误码：**

以下错误码的详细介绍请参见[基础文件IO错误码](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/errorcode-filemanagement#基础文件io错误码)。

展开

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

**示例：**



```
1. let filePath = pathDir + '/test.txt';
2. let type = securityLabel.getSecurityLabelSync(filePath);
3. console.info("getSecurityLabel successfully, Label: " + type);
```