未验证 提交 58bba735 编写于 作者: O openharmony_ci 提交者: Gitee

!3934 add securityLabel api

Merge pull request !3934 from zhangxingxia/master
......@@ -113,6 +113,7 @@
- [@ohos.statfs (statfs)](js-apis-statfs.md)
- [@ohos.storageStatistics (应用空间统计)](js-apis-storage-statistics.md)
- [@ohos.volumeManager (卷管理)](js-apis-volumemanager.md)
- [@ohos.securityLabel (数据标签)](js-apis-securityLabel.md)
- 电话服务
- [@ohos.contact (联系人)](js-apis-contact.md)
......
......@@ -1900,7 +1900,7 @@ mkdtemp(prefix: string): Promise<string>
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
**返回值:**
| 参数名 | 说明 |
| 类型 | 说明 |
| --------------------- | ---------- |
| Promise<string> | 生成的唯一目录路径。 |
......@@ -1950,7 +1950,7 @@ mkdtempSync(prefix: string): string
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
**返回值:**
| 参数名 | 说明 |
| 类型 | 说明 |
| ------ | ---------- |
| string | 产生的唯一目录路径。 |
......@@ -1975,7 +1975,7 @@ fchmod(fd: number, mode: number): Promise<void>
| mode | number | 是 | 若创建文件,则指定文件的权限,可给定如下权限,以按位或的方式追加权限。<br/>-&nbsp;0o700:所有者具有读、写及可执行权限。<br/>-&nbsp;0o400:所有者具有读权限。<br/>-&nbsp;0o200:所有者具有写权限。<br/>-&nbsp;0o100:所有者具有可执行权限。<br/>-&nbsp;0o070:所有用户组具有读、写及可执行权限。<br/>-&nbsp;0o040:所有用户组具有读权限。<br/>-&nbsp;0o020:所有用户组具有写权限。<br/>-&nbsp;0o010:所有用户组具有可执行权限。<br/>-&nbsp;0o007:其余用户具有读、写及可执行权限。<br/>-&nbsp;0o004:其余用户具有读权限。<br/>-&nbsp;0o002:其余用户具有写权限。<br/>-&nbsp;0o001:其余用户具有可执行权限。 |
**返回值:**
| 参数名 | 说明 |
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果,本调用将返回空值。 |
......@@ -2099,7 +2099,7 @@ createStreamSync(path: string, mode: string): Stream
| mode | string | 是 | -&nbsp;r:打开只读文件,该文件必须存在。<br/>-&nbsp;r+:打开可读写的文件,该文件必须存在。<br/>-&nbsp;w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。<br/>-&nbsp;a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
**返回值:**
| 参数名 | 说明 |
| 类型 | 说明 |
| ------------------ | --------- |
| [Stream](#stream7) | 返回文件流的结果。 |
......@@ -2124,7 +2124,7 @@ fdopenStream(fd: number, mode: string): Promise&lt;Stream&gt;
| mode | string | 是 | -&nbsp;r:打开只读文件,该文件必须存在。<br/>-&nbsp;r+:打开可读写的文件,该文件必须存在。<br/>-&nbsp;w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。<br/>-&nbsp;a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
**返回值:**
| 参数名 | 说明 |
| 类型 | 说明 |
| --------------------------------- | --------- |
| Promise&lt;[Stream](#stream7)&gt; | 返回文件流的结果。 |
......@@ -2176,7 +2176,7 @@ fdopenStreamSync(fd: number, mode: string): Stream
| mode | string | 是 | -&nbsp;r:打开只读文件,该文件必须存在。<br/>-&nbsp;r+:打开可读写的文件,该文件必须存在。<br/>-&nbsp;w:打开只写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+:打开可读写文件,若文件存在则文件长度清0,即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a:以附加的方式打开只写文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾,即文件原先的内容会被保留。<br/>-&nbsp;a+:以附加方式打开可读写的文件。若文件不存在,则会建立该文件,如果文件存在,写入的数据会被加到文件尾后,即文件原先的内容会被保留。 |
**返回值:**
| 参数名 | 说明 |
| 类型 | 说明 |
| ------------------ | --------- |
| [Stream](#stream7) | 返回文件流的结果。 |
......@@ -2358,7 +2358,7 @@ createWatcher(filename: string, events: number, callback: AsyncCallback&lt;numbe
| callback | AsyncCallback&lt;number&nbsp;&gt; | 是 | 每发生变化一次,调用一次此函数。 |
**返回值:**
| 参数名 | 说明 |
| 类型 | 说明 |
| -------------------- | ---------- |
| [Watcher](#watcher7) | 文件变化监听的实例。 |
......
# 数据标签
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```js
import securityLabel from '@ohos.securityLabel';
```
## 使用说明
使用该功能模块对文件/目录进行操作前,需要先获取其绝对路径,获取方式及其接口用法请参考:[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)
“文件/目录绝对路径”=“应用目录路径”+“文件/目录名”
通过上述接口获取到应用目录路径dir,文件名为“xxx.txt”,文件所在绝对路径为:
```js
let path = dir + "/xxx.txt";
```
文件描述符fd:
```js
let fd = fileio.openSync(path, 0o102, 0o666);
```
## securityLabel.setSecurityLabel
setSecurityLabel(path:string, dataLevel:string):Promise&lt;void&gt;
以异步方法设置数据标签,以promise形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------------------------------------------- |
| path | string | 是 | 文件路径 |
| dataLevel | string | 是 | 文件等级属性,只支持"s0","s1","s2","s3","s4" |
**返回值:**
| 类型 | 说明 |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | Promise实例,用于异步获取结果。本调用将返回空值。|
**示例:**
```js
securityLabel.setSecurityLabel(path, dataLevel).then(function(){
console.info("setSecurityLabel successfully");
}).catch(function(error){
console.info("setSecurityLabel failed with error:" + error);
});
```
## securityLabel.setSecurityLabel
setSecurityLabel(path:string, dataLevel:string, callback: AsyncCallback&lt;void&gt;):void
以异步方法设置数据标签,以callback形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | -------------------------------------------- |
| path | string | 是 | 文件路径 |
| dataLevel | string | 是 | 文件等级属性,只支持"s0","s1","s2","s3","s4" |
| callback | AsyncCallback&lt;void&gt; | 是 | 是否设置数据标签之后的回调 |
**示例:**
```js
securityLabel.setSecurityLabel(path, dataLevel, function(error){
console.info("setSecurityLabel:" + JSON.stringify(error));
});
```
## securityLabel.setSecurityLabelSync
setSecurityLabelSync(path:string, dataLevel:string):void
以同步方法设置数据标签。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------ | ---- | -------------------------------------------- |
| path | string | 是 | 文件路径 |
| dataLevel | string | 是 | 文件等级属性,只支持"s0","s1","s2","s3","s4" |
**示例:**
```js
securityLabel.setSecurityLabelSync(path, dataLevel);
```
## securityLabel.getSecurityLabel
getSecurityLabel(path:string):Promise&lt;string&gt;
异步方法获取数据标签,以promise形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------- |
| path | string | 是 | 文件路径 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ------------ |
| Promise&lt;string&gt; | 返回数据标签 |
**示例:**
```js
securityLabel.getSecurityLabel(path).then(function(dataLevel){
console.log("getSecurityLabel successfully:" + dataLevel);
}).catch(function(error){
console.log("getSecurityLabel failed with error:" + error);
});
```
## securityLabel.getSecurityLabel
getSecurityLabel(path:string, callback:AsyncCallback&lt;string&gt;): void
异步方法获取数据标签,以callback形式返回结果。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | -------------------------- |
| path | string | 是 | 文件路径 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步获取数据标签之后的回调 |
**示例:**
```js
securityLabel.getSecurityLabel(function(error, dataLevel){
console.log("getSecurityLabel successfully:" + dataLevel);
});
```
## securityLabel.getSecurityLabelSync
getSecurityLabelSync(path:string):string
以同步方法获取数据标签。
**系统能力**:SystemCapability.FileManagement.File.DistributedFile
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------- |
| path | string | 是 | 文件路径 |
**返回值:**
| 类型 | 说明 |
| ------ | ------------ |
| string | 返回数据标签 |
**示例:**
```js
let result = securityLabel.getSecurityLabelSync(path);
console.log("getSecurityLabel successfully:" + result);
```
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册