Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 ccc7c3ae 编写于 作者: 田 田雨 提交者： Gitee
浏览文件
操作

Merge branch 'master' of gitee.com:openharmony/docs into master

上级 80252784 bcd16956
展开全部 隐藏空白更改
内联 并排
Showing with 3642 addition and 1806 deletion
README_zh.md
浏览文件 @ ccc7c3ae
......@@ -22,8 +22,10 @@
- OpenHarmony 3.1 Release版本：点击[此处](zh-cn/release-notes/OpenHarmony-v3.1-release.md)了解版本详情。
该已更新至OpenHarmony 3.1.1 Release，点击[此处](zh-cn/release-notes/OpenHarmony-v3.1.1-release.md)了解版本详情。
- OpenHarmony 3.0 LTS版本：点击[此处](zh-cn/release-notes/OpenHarmony-v3.0-LTS.md)了解版本详情。
该版本已更新至OpenHarmony 3.0.3 LTS，点击[此处](zh-cn/release-notes/OpenHarmony-v3.0.3-LTS.md)了解版本详情。
- OpenHarmony 2.2 Beta2版本：点击[此处](zh-cn/release-notes/OpenHarmony-v2.2-beta2.md)了解版本详情。
......@@ -47,4 +49,8 @@ OpenHarmony_v1.x_release：OpenHarmony 1.1.4 LTS稳定版本，点击[此处](zh
您可以对现有文档进行评价、简单更改、反馈文档质量问题、贡献您的原创内容，详细请参考[贡献文档](zh-cn/contribute/贡献文档.md)。
卓越贡献者将会在开发者社区文档贡献专栏表彰公示。
\ No newline at end of file
卓越贡献者将会在开发者社区文档贡献专栏表彰公示。
- 邮件列表：docs@openharmony.io
- Zulip群组：documentation_sig
\ No newline at end of file
en/application-dev/reference/apis/js-apis-Context.md
浏览文件 @ ccc7c3ae
......@@ -836,7 +836,7 @@ Obtains information of the current ability. This API uses an asynchronous callba
| Name | Type | Mandatory| Description |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback\<[AbilityInfo](#abilityInfo)> | Yes | Callback used to return the ability information.|
| callback | AsyncCallback\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | Yes | Callback used to return the ability information.|
**Example**
......@@ -864,7 +864,7 @@ Obtains information of the current ability. This API uses a promise to return th
| Type | Description |
| --------------- | ------------------------- |
| Promise\<[AbilityInfo](#abilityInfo)> | Promise used to return the ability information.|
| Promise\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | Promise used to return the ability information.|
**Example**
......
en/application-dev/reference/arkui-ts/ts-container-list.md
浏览文件 @ ccc7c3ae
......@@ -20,7 +20,7 @@ This component contains the child component [<ListItem>](ts-container-listitem.m
## APIs
List(value:{space?: number, initialIndex?: number})
List(value:{space?: number | string, initialIndex?: number, scroller?: Scroller})
- Parameters
| Name | Type | Mandatory | Default Value | Description |
......
en/application-dev/reference/arkui-ts/ts-container-refresh.md
浏览文件 @ ccc7c3ae
......@@ -15,7 +15,7 @@ This component supports only one child component.
## APIs
Refresh\(value: \{refreshing: boolean, offset?: Length, friction?: number\}\)
Refresh\(value: \{refreshing: boolean, offset?: Length, friction?: number | string\}\)
- Parameters
......
en/readme/user-iam.md
浏览文件 @ ccc7c3ae
......@@ -23,11 +23,9 @@ Based on the unified user authentication framework, the system can be extended t
```undefined
//base/user_iam
├── auth_executor_mgr # Authentication executor management part, which supports unified authentication resource management and scheduling
├── user_auth_framework # User authentication framework, including user authentication, credential management and executor management
├── face_auth # Facial authentication module, which connects to the authentication executor management part and supports facial information recording, deletion, and verification
├── pin_auth # Password authentication module, which connects to the authentication executor management part and supports password recording, deletion, and verification
├── user_auth # Unified user authentication part
└── user_idm # User credential management part
```
......@@ -45,12 +43,12 @@ Based on the unified user authentication framework, the system can be extended t
## Repositories Involved
[useriam_auth_executor_mgr](https://gitee.com/openharmony/useriam_auth_executor_mgr)
[useriam_user_auth_framework](https://gitee.com/openharmony/useriam_user_auth_framework)
[useriam_user_idm](https://gitee.com/openharmony/useriam_user_idm)
[useriam_pin_auth](https://gitee.com/openharmony/useriam_pin_auth)
[useriam_user_auth](https://gitee.com/openharmony/useriam_user_auth)
[useriam_face_auth](https://gitee.com/openharmony/useriam_face_auth)
[useriam_pin_auth](https://gitee.com/openharmony/useriam_pin_auth)
[drivers_interface](https://gitee.com/openharmony/drivers_interface)
[useriam_faceauth](https://gitee.com/openharmony/useriam_faceauth)
[drivers_peripheral](https://gitee.com/openharmony/drivers_peripheral)
\ No newline at end of file
zh-cn/application-dev/ability/fa-dataability.md
浏览文件 @ ccc7c3ae
......@@ -4,6 +4,28 @@
Data提供方可以自定义数据的增、删、改、查，以及文件打开等功能，并对外提供这些接口。
## URI介绍
Data的提供方和使用方都通过URI（Uniform Resource Identifier）来标识一个具体的数据，例如数据库中的某个表或磁盘上的某个文件。HarmonyOS的URI仍基于URI通用标准，格式如下：
![fa-dataability-uri](figures/fa-dataability-uri.png)
- scheme：协议方案名，固定为“dataability”，代表Data Ability所使用的协议类型。
- authority：设备ID。如果为跨设备场景，则为目标设备的ID；如果为本地设备场景，则不需要填写。
- path：资源的路径信息，代表特定资源的位置信息。
- query：查询参数。
- fragment：可以用于指示要访问的子资源。
URI示例：
- 跨设备场景：dataability://*device_id*/*com.domainname.dataability.persondata*/*person*/*10*
- 本地设备：dataability:///*com.domainname.dataability.persondata*/*person*/*10*
```
说明
本地设备的“device_id”字段为空，因此在“dataability:”后面有三个“/”。
```
## 接口说明
**表1** Data中相关生命周期API功能介绍
......
zh-cn/application-dev/ability/stage-ability.md
浏览文件 @ ccc7c3ae
......@@ -8,13 +8,13 @@ Stage模型是区别于FA模型的一种应用开发模型，对此模型的介
- 应用迁移，详见[应用迁移开发指导](stage-ability-continuation.md)。
### 启动模式
ability支持单实例、多实例和指定实例3种启动模式，在module.json中通过launchType配置。启动模式对应Ability被启动时的行为，对启动模式的详细说明如下：
Ability支持单实例、多实例和指定实例3种启动模式，在module.json中通过launchType配置。启动模式对应Ability被启动时的行为，对启动模式的详细说明如下：
| 启动模式 | 描述 |说明 |
| ----------- | ------- |---------------- |
| standard | 多实例 | 每次startAbility都会启动一个新的实例 |
| singleton | 单实例 | 系统中只存在唯一一个实例，startAbility时，如果已存在，则复用系统中的唯一一个实例 |
| specified | 指定实例 | 运行时由ability内部业务决定是否创建多实例 |
| specified | 指定实例 | 运行时由Ability内部业务决定是否创建多实例 |
缺省情况下是singleton模式，module.json示例如下：
```json
......@@ -107,7 +107,7 @@ Ability功能如下（Ability类，具体的API详见[接口文档](../reference
}
```
### 获取AbilityStage及Ability的配置信息
AbilityStage类及Ability类均拥有context属性，应用可以通过`this.context`获取Ability实例的上下文，进而获取详细的配置信息。如下示例展示了AbilityStage通过context属性获取包代码路径、hap包名、ability名以及系统语言的方法。具体示例代码如下：
AbilityStage类及Ability类均拥有context属性，应用可以通过`this.context`获取Ability实例的上下文，进而获取详细的配置信息。如下示例展示了AbilityStage通过context属性获取包代码路径、hap包名、Ability名以及系统语言的方法。具体示例代码如下：
```ts
import AbilityStage from "@ohos.application.AbilityStage"
export default class MyAbilityStage extends AbilityStage {
......@@ -126,7 +126,7 @@ export default class MyAbilityStage extends AbilityStage {
}
```
如下示例展示了Ability通过context属性获取包代码路径、hap包名、ability名以及系统语言的方法。具体示例代码如下：
如下示例展示了Ability通过context属性获取包代码路径、hap包名、Ability名以及系统语言的方法。具体示例代码如下：
```ts
import Ability from '@ohos.application.Ability'
export default class MainAbility extends Ability {
......
zh-cn/application-dev/connectivity/websocket-connection.md
浏览文件 @ ccc7c3ae
......@@ -3,7 +3,7 @@
## 场景介绍
使用WebSocket建立服务器与客户端的双向连接，需要先通过createWebSocket方法创建WebSocket对象，然后通过connect方法连接到服务器。当连接成功后，客户端会收到open事件的回调，之后客户端就可以通过send方法与服务器进行通信。当服务器发信息给客户端时，客户端会收到message事件的回调。当客户端不要此连接时，可以通过调用close方法主动断开连接，之后客户端会收到close事件的回调。
使用WebSocket建立服务器与客户端的双向连接，需要先通过createWebSocket()方法创建WebSocket对象，然后通过connect()方法连接到服务器。当连接成功后，客户端会收到open事件的回调，之后客户端就可以通过send()方法与服务器进行通信。当服务器发信息给客户端时，客户端会收到message事件的回调。当客户端不要此连接时，可以通过调用close()方法主动断开连接，之后客户端会收到close事件的回调。
若在上述任一过程中发生错误，客户端会收到error事件的回调。
......@@ -18,23 +18,23 @@ WebSocket连接功能主要由webSocket模块提供。使用该功能需要申
| connect() | 根据URL地址，建立一个WebSocket连接。 |
| send() | 通过WebSocket连接发送数据。 |
| close() | 关闭WebSocket连接。 |
| on(type:&nbsp;'open') | 订阅WebSocket的打开事件。 |
| off(type:&nbsp;'open') | 取消订阅WebSocket的打开事件。 |
| on(type:&nbsp;'message') | 订阅WebSocket的接收到服务器消息事件。 |
| off(type:&nbsp;'message') | 取消订阅WebSocket的接收到服务器消息事件。 |
| on(type:&nbsp;'close') | 订阅WebSocket的关闭事件。 |
| off(type:&nbsp;'close') | 取消订阅WebSocket的关闭事件 |
| on(type:&nbsp;'error') | 订阅WebSocket的Error事件。 |
| off(type:&nbsp;'error') | 取消订阅WebSocket的Error事件。 |
| on(type: 'open') | 订阅WebSocket的打开事件。 |
| off(type: 'open') | 取消订阅WebSocket的打开事件。 |
| on(type: 'message') | 订阅WebSocket的接收到服务器消息事件。 |
| off(type: 'message') | 取消订阅WebSocket的接收到服务器消息事件。 |
| on(type: 'close') | 订阅WebSocket的关闭事件。 |
| off(type: 'close') | 取消订阅WebSocket的关闭事件 |
| on(type: 'error') | 订阅WebSocket的Error事件。 |
| off(type: 'error') | 取消订阅WebSocket的Error事件。 |
## 开发步骤
1. import需要的webSocket模块。
1. 导入需要的webSocket模块。
2. 创建一个WebSocket连接，返回一个WebSocket对象。
3. （可选）订阅WebSocket的打开、消息、关闭、Error事件。
3. （可选）订阅WebSocket的打开、消息接收、关闭、Error事件。
4. 根据URL地址，发起WebSocket连接。
......@@ -50,9 +50,9 @@ WebSocket连接功能主要由webSocket模块提供。使用该功能需要申
// 当收到on('open')事件时，可以通过send()方法与服务器进行通信
ws.send("Hello, server!", (err, value) => {
if (!err) {
console.log("send success");
console.log("Message sent successfully");
} else {
console.log("send fail, err:" + JSON.stringify(err));
console.log("Failed to send the message. Err:" + JSON.stringify(err));
}
});
});
......@@ -62,9 +62,9 @@ WebSocket连接功能主要由webSocket模块提供。使用该功能需要申
if (value === 'bye') {
ws.close((err, value) => {
if (!err) {
console.log("close success");
console.log("Connection closed successfully");
} else {
console.log("close fail, err is " + JSON.stringify(err));
console.log("Failed to close the connection. Err: " + JSON.stringify(err));
}
});
}
......@@ -77,9 +77,9 @@ WebSocket连接功能主要由webSocket模块提供。使用该功能需要申
});
ws.connect(defaultIpAddress, (err, value) => {
if (!err) {
console.log("connect success");
console.log("Connected successfully");
} else {
console.log("connect fail, err:" + JSON.stringify(err));
console.log("Connection failed. Err:" + JSON.stringify(err));
}
});
```
zh-cn/application-dev/database/database-relational-guidelines.md
浏览文件 @ ccc7c3ae
......@@ -70,8 +70,8 @@
| 类名 | 接口名 | 描述 |
| -------- | -------- | -------- |
| RdbStore | query(predicates:&nbsp;RdbPredicates,&nbsp;columns:&nbsp;Array,&nbsp;callback:&nbsp;AsyncCallback&lt;ResultSet&gt;):&nbsp;void | 根据指定条件查询数据库中的数据，结果以callback形式返回。<br/>-&nbsp;predicates：表示RdbPredicates的实例对象指定的查询条件。<br/>-&nbsp;columns：表示要查询的列。如果值为空，则查询应用于所有列。<br/>-&nbsp;callback：指定callback回调函数。如果操作成功，则返回ResultSet对象。 |
| RdbStore | query(predicates:&nbsp;RdbPredicates,&nbsp;columns:&nbsp;Array):&nbsp;Promise&lt;ResultSet&gt; | 根据指定条件查询数据库中的数据，结果以Promise形式返回。<br/>-&nbsp;predicates：表示RdbPredicates的实例对象指定的查询条件。<br/>-&nbsp;columns：表示要查询的列。如果值为空，则查询应用于所有列。 |
| RdbStore | query(predicates:&nbsp;RdbPredicates,&nbsp;columns:&nbsp;Array&lt;string&gt;,&nbsp;callback:&nbsp;AsyncCallback&lt;ResultSet&gt;):&nbsp;void | 根据指定条件查询数据库中的数据，结果以callback形式返回。<br/>-&nbsp;predicates：表示RdbPredicates的实例对象指定的查询条件。<br/>-&nbsp;columns：表示要查询的列。如果值为空，则查询应用于所有列。<br/>-&nbsp;callback：指定callback回调函数。如果操作成功，则返回ResultSet对象。 |
| RdbStore | query(predicates:&nbsp;RdbPredicates,&nbsp;columns?:&nbsp;Array&lt;string&gt;):&nbsp;Promise&lt;ResultSet&gt; | 根据指定条件查询数据库中的数据，结果以Promise形式返回。<br/>-&nbsp;predicates：表示RdbPredicates的实例对象指定的查询条件。<br/>-&nbsp;columns：表示要查询的列。如果值为空，则查询应用于所有列。 |
| RdbStore | querySql(sql:&nbsp;string,&nbsp;bindArgs:&nbsp;Array&lt;ValueType&gt;,&nbsp;callback:&nbsp;AsyncCallback&lt;ResultSet&gt;):void | 根据指定SQL语句查询数据库中的数据，结果以callback形式返回。<br/>-&nbsp;sql：指定要查询的SQL语句。<br/>-&nbsp;bindArgs：SQL语句中参数的值。<br/>-&nbsp;callback：指定callback回调函数。如果操作成功，则返回ResultSet对象。 |
| RdbStore | querySql(sql:&nbsp;string,&nbsp;bindArgs?:&nbsp;Array&lt;ValueType&gt;):Promise&lt;ResultSet&gt; | 根据指定SQL语句查询数据库中的数据，结果以Promise形式返回。<br/>-&nbsp;sql：指定要查询的SQL语句。<br/>-&nbsp;bindArgs：SQL语句中参数的值。 |
......
zh-cn/application-dev/device-usage-statistics/device-usage-statistics-dev-guide.md
浏览文件 @ ccc7c3ae
......@@ -44,7 +44,7 @@ import stats from '@ohos.bundleState';
...,
"reqPermissions": [
{
"name": "ohos.permission.BUNDLE_ACTIVE_INFO"
"name": "ohos.permission.BUNDLE_ACTIVE_INFO"
}
]
}
......@@ -56,13 +56,13 @@ import stats from '@ohos.bundleState';
import stats from '@ohos.bundleState'
// 异步方法promise方式
stats.queryBundleActiveStates(0, 20000000000000).then( res => {
stats.queryBundleActiveStates(0, 20000000000000).then(res => {
console.log('BUNDLE_ACTIVE queryBundleActiveStates promise success.');
for (let i = 0; i < res.length; i++) {
console.log('BUNDLE_ACTIVE queryBundleActiveStates promise number : ' + (i + 1));
console.log('BUNDLE_ACTIVE queryBundleActiveStates promise result ' + JSON.stringify(res[i]));
}
}).catch( err => {
}).catch(err => {
console.log('BUNDLE_ACTIVE queryBundleActiveStates promise failed, because: ' + err.code);
});
......@@ -86,7 +86,7 @@ import stats from '@ohos.bundleState';
import stats from '@ohos.bundleState'
// 异步方法promise方式
stats.queryBundleStateInfos(0, 20000000000000).then( res => {
stats.queryBundleStateInfos(0, 20000000000000).then(res => {
console.log('BUNDLE_ACTIVE queryBundleStateInfos promise success.');
let i = 1;
for (let key in res){
......@@ -94,7 +94,7 @@ import stats from '@ohos.bundleState';
console.log('BUNDLE_ACTIVE queryBundleStateInfos promise result ' + JSON.stringify(res[key]));
i++;
}
}).catch( err => {
}).catch(err => {
console.log('BUNDLE_ACTIVE queryBundleStateInfos promise failed, because: ' + err.code);
});
......@@ -120,13 +120,13 @@ import stats from '@ohos.bundleState';
import stats from '@ohos.bundleState'
// 异步方法promise方式
stats.queryCurrentBundleActiveStates(0, 20000000000000).then( res => {
stats.queryCurrentBundleActiveStates(0, 20000000000000).then(res => {
console.log('BUNDLE_ACTIVE queryCurrentBundleActiveStates promise success.');
for (let i = 0; i < res.length; i++) {
console.log('BUNDLE_ACTIVE queryCurrentBundleActiveStates promise number : ' + (i + 1));
console.log('BUNDLE_ACTIVE queryCurrentBundleActiveStates promise result ' + JSON.stringify(res[i]));
}
}).catch( err => {
}).catch(err => {
console.log('BUNDLE_ACTIVE queryCurrentBundleActiveStates promise failed, because: ' + err.code);
});
......@@ -150,13 +150,13 @@ import stats from '@ohos.bundleState';
import stats from '@ohos.bundleState'
// 异步方法promise方式
stats.queryBundleStateInfoByInterval(0, 0, 20000000000000).then( res => {
stats.queryBundleStateInfoByInterval(0, 0, 20000000000000).then(res => {
console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval promise success.');
for (let i = 0; i < res.length; i++) {
console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval promise number : ' + (i + 1));
console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval promise result ' + JSON.stringify(res[i]));
}
}).catch( err => {
}).catch(err => {
console.log('BUNDLE_ACTIVE queryBundleStateInfoByInterval promise failed, because: ' + err.code);
});
......@@ -180,9 +180,9 @@ import stats from '@ohos.bundleState';
import stats from '@ohos.bundleState'
// promise方式
stats.queryAppUsagePriorityGroup().then( res => {
stats.queryAppUsagePriorityGroup().then(res => {
console.log('BUNDLE_ACTIVE queryAppUsagePriorityGroup promise succeeded. result: ' + JSON.stringify(res));
}).catch( err => {
}).catch(err => {
console.log('BUNDLE_ACTIVE queryAppUsagePriorityGroup promise failed. because: ' + err.code);
});
......@@ -202,9 +202,9 @@ import stats from '@ohos.bundleState';
import stats from '@ohos.bundleState'
// 异步方法promise方式
stats.isIdleState("com.ohos.camera").then( res => {
stats.isIdleState("com.ohos.camera").then(res => {
console.log('BUNDLE_ACTIVE isIdleState promise succeeded, result: ' + JSON.stringify(res));
}).catch( err => {
}).catch(err => {
console.log('BUNDLE_ACTIVE isIdleState promise failed, because: ' + err.code);
});
......@@ -224,18 +224,18 @@ import stats from '@ohos.bundleState';
import stats from '@ohos.bundleState'
// 异步方法promise方式
stats.getRecentlyUsedModules(1000).then( res => {
stats.getRecentlyUsedModules(1000).then(res => {
console.log('BUNDLE_ACTIVE getRecentlyUsedModules promise succeeded');
for (let i = 0; i < res.length; i++) {
console.log('BUNDLE_ACTIVE getRecentlyUsedModules promise number : ' + (i + 1));
console.log('BUNDLE_ACTIVE getRecentlyUsedModules promise result ' + JSON.stringify(res[i]));
}
}).catch( err=> {
}).catch(err=> {
console.log('BUNDLE_ACTIVE getRecentlyUsedModules promise failed, because: ' + err.code);
});
// 无maNum参数异步方法promise方式
stats.getRecentlyUsedModules().then( res => {
stats.getRecentlyUsedModules().then(res => {
console.log('BUNDLE_ACTIVE getRecentlyUsedModules promise succeeded');
for (let i = 0; i < res.length; i++) {
console.log('BUNDLE_ACTIVE getRecentlyUsedModules promise number : ' + (i + 1));
......@@ -246,7 +246,7 @@ import stats from '@ohos.bundleState';
});
// 异步方法callback方式
stats.getRecentlyUsedModules(1000,(err, res) => {
stats.getRecentlyUsedModules(1000, (err, res) => {
if(err) {
console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback failed, because: ' + err.code);
} else {
......@@ -260,7 +260,7 @@ import stats from '@ohos.bundleState';
// 无maNum参数异步方法callback方式
stats.getRecentlyUsedModules((err, res) => {
if(err) {
if (err) {
console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback failed, because: ' + err.code);
} else {
console.log('BUNDLE_ACTIVE getRecentlyUsedModules callback succeeded.');
......@@ -278,10 +278,10 @@ import stats from '@ohos.bundleState';
import stats from '@ohos.bundleState'
// 异步方法promise方式
stats.queryAppNotificationNumber(0, 20000000000000).then( res => {
stats.queryAppNotificationNumber(0, 20000000000000).then(res => {
console.log('BUNDLE_ACTIVE queryAppNotificationNumber promise success.');
console.log('BUNDLE_ACTIVE queryAppNotificationNumber promise result ' + JSON.stringify(res));
}).catch( err => {
}).catch(err => {
console.log('BUNDLE_ACTIVE queryAppNotificationNumber promise failed, because: ' + err.code);
});
......@@ -302,10 +302,10 @@ import stats from '@ohos.bundleState';
import stats from '@ohos.bundleState'
// 异步方法promise方式
stats.queryBundleActiveEventStates(0, 20000000000000).then( res => {
stats.queryBundleActiveEventStates(0, 20000000000000).then(res => {
console.log('BUNDLE_ACTIVE queryBundleActiveEventStates promise success.');
console.log('BUNDLE_ACTIVE queryBundleActiveEventStates promise result ' + JSON.stringify(res));
}).catch( err => {
}).catch(err => {
console.log('BUNDLE_ACTIVE queryBundleActiveEventStates promise failed, because: ' + err.code);
});
......@@ -326,9 +326,9 @@ import stats from '@ohos.bundleState';
import stats from '@ohos.bundleState'
// 无参异步方法promise方式
stats.queryAppUsagePriorityGroup().then( res => {
stats.queryAppUsagePriorityGroup().then(res => {
console.log('BUNDLE_ACTIVE queryAppUsagePriorityGroup promise succeeded. result: ' + JSON.stringify(res));
}).catch( err => {
}).catch(err => {
console.log('BUNDLE_ACTIVE queryAppUsagePriorityGroup promise failed. because: ' + err.code);
});
......@@ -342,15 +342,15 @@ import stats from '@ohos.bundleState';
});
//有参异步promise方式
stats.queryAppUsagePriorityGroup(this.bundleName).then( res => {
stats.queryAppUsagePriorityGroup(this.bundleName).then(res => {
console.log('BUNDLE_ACTIVE QueryPackageGroup promise succeeded. result: ' + JSON.stringify(res));
}).catch( err => {
}).catch(err => {
console.log('BUNDLE_ACTIVE QueryPackageGroup promise failed. because: ' + err.code);
});
//有参异步方法callback方式
stats.queryAppUsagePriorityGroup(this.bundleName, (err, res) => {
if(err) {
if (err) {
console.log('BUNDLE_ACTIVE QueryPackageGroup callback failed. because: ' + err.code);
} else {
console.log('BUNDLE_ACTIVE QueryPackageGroup callback succeeded. result: ' + JSON.stringify(res));
......@@ -364,14 +364,14 @@ import stats from '@ohos.bundleState';
import stats from '@ohos.bundleState'
//异步方法promise
stats.setBundleGroup(this.bundleName, this.newGroup).then( () => {
stats.setBundleGroup(this.bundleName, this.newGroup).then(() => {
console.log('BUNDLE_ACTIVE SetBundleGroup promise succeeded.');
}).catch( err => {
console.log('BUNDLE_ACTIVE SetBundleGroup promise failed. because: ' + err.code);
});
//异步方法callback
stats.setBundleGroup(this.bundleName, this.newGroup, (err) => {
if(err) {
if (err) {
console.log('BUNDLE_ACTIVE SetBundleGroup callback failed. because: ' + err.code);
} else {
console.log('BUNDLE_ACTIVE SetBundleGroup callback succeeded.');
......@@ -385,7 +385,7 @@ import stats from '@ohos.bundleState';
import stats from '@ohos.bundleState'
//异步方法promise形式
let onBundleGroupChanged = (err,res) =>{
let onBundleGroupChanged = (err,res) => {
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack callback success.');
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result oldGroup is : ' + res.oldGroup);
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result newGroup is : ' + res.newGroup);
......@@ -393,13 +393,13 @@ import stats from '@ohos.bundleState';
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result userId is : ' + res.userId);
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result bundleName is : ' + res.bundleName);
};
stats.registerGroupCallBack(onBundleGroupChanged).then( () => {
stats.registerGroupCallBack(onBundleGroupChanged).then(() => {
console.log('BUNDLE_ACTIVE RegisterGroupCallBack promise succeeded.');
}).catch( err => {
}).catch(err => {
console.log('BUNDLE_ACTIVE RegisterGroupCallBack promise failed. because: ' + err.code);
});
//异步方法callback形式
let onBundleGroupChanged = (err,res) =>{
let onBundleGroupChanged = (err,res) => {
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack callback success.');
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result‘s oldGroup is : ' + res.oldGroup);
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result‘s newGroup is : ' + res.newGroup);
......@@ -407,8 +407,8 @@ import stats from '@ohos.bundleState';
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result‘s userId is : ' + res.userId);
console.log('BUNDLE_ACTIVE onBundleGroupChanged RegisterGroupCallBack result‘s bundleName is : ' + res.bundleName);
};
stats.registerGroupCallBack(onBundleGroupChanged, (err)=>{
if(err) {
stats.registerGroupCallBack(onBundleGroupChanged, (err) => {
if (err) {
console.log('BUNDLE_ACTIVE RegisterGroupCallBack callback failed, because: ' + err.code);
} else {
console.log('BUNDLE_ACTIVE RegisterGroupCallBack callback success.');
......@@ -422,14 +422,14 @@ import stats from '@ohos.bundleState';
import stats from '@ohos.bundleState'
//promise
stats.unRegisterGroupCallBack().then( () => {
stats.unRegisterGroupCallBack().then(() => {
console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack promise succeeded.');
}).catch( err => {
}).catch(err => {
console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack promise failed. because: ' + err.code);
});
//callback
stats.unRegisterGroupCallBack((err)=>{
if(err) {
stats.unRegisterGroupCallBack((err) => {
if (err) {
console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack callback failed, because: ' + err.code);
} else {
console.log('BUNDLE_ACTIVE UnRegisterGroupCallBack callback success.');
......
zh-cn/application-dev/device/sensor-guidelines.md
浏览文件 @ ccc7c3ae
......@@ -34,40 +34,52 @@
1. 获取设备上传感器的数据，需要在“config.json”里面进行配置请求权限。具体如下：
```
”reqPermissions“:[
{
"name":"ohos.permission.ACCELEROMETER",
"reason"":"",
"usedScene":{
"ability": ["sensor.index.MainAbility",".MainAbility"],
"when":"inuse"
}
},
{
"name":"ohos.permission.GYROSCOPE",
"reason"":"",
"usedScene":{
"ability": ["sensor.index.MainAbility",".MainAbility"],
"when":"inuse"
}
},
{
"name":"ohos.permission.ACTIVITY_MOTION",
"reason"":"ACTIVITY_MOTION_TEST",
"usedScene":{
"ability": ["sensor.index.MainAbility",".MainAbility"],
"when":"inuse"
}
},
{
"name":"ohos.permission.READ_HEALTH_DATA",
"reason"":"HEALTH_DATA_TEST",
"usedScene":{
"ability": ["sensor.index.MainAbility",".MainAbility"],
"when":"inuse"
}
},
]
"reqPermissions": [
{
"name": "ohos.permission.ACCELEROMETER",
"reason": "",
"usedScene": {
"ability": [
"sensor.index.MainAbility",
".MainAbility"
],
"when": "inuse"
}
},
{
"name": "ohos.permission.GYROSCOPE",
"reason": "",
"usedScene": {
"ability": [
"sensor.index.MainAbility",
".MainAbility"
],
"when": "inuse"
}
},
{
"name": "ohos.permission.ACTIVITY_MOTION",
"reason": "ACTIVITY_MOTION_TEST",
"usedScene": {
"ability": [
"sensor.index.MainAbility",
".MainAbility"
],
"when": "inuse"
}
},
{
"name": "ohos.permission.READ_HEALTH_DATA",
"reason": "HEALTH_DATA_TEST",
"usedScene": {
"ability": [
"sensor.index.MainAbility",
".MainAbility"
],
"when": "inuse"
}
}
]
```
2. 持续监听传感器数据变化。
......
zh-cn/application-dev/device/vibrator-guidelines.md
浏览文件 @ ccc7c3ae
......@@ -26,36 +26,36 @@
```
"reqPermissions": [
{
"name": "ohos.permission.ACCELEROMETER",
"reason": "",
"usedScene": {
"ability": [
".MainAbility"
],
"when": "inuse"
}
},
{
"name": "ohos.permission.VIBRATE",
"reason": "",
"usedScene": {
"ability": [
".MainAbility"
],
"when": "inuse"
}
},
{
"name": "ohos.permission.ACTIVITY_MOTION",
"reason": "",
"usedScene": {
"ability": [
".MainAbility"
],
"when": "inuse"
}
},
{
"name": "ohos.permission.ACCELEROMETER",
"reason": "",
"usedScene": {
"ability": [
".MainAbility"
],
"when": "inuse"
}
},
{
"name": "ohos.permission.VIBRATE",
"reason": "",
"usedScene": {
"ability": [
".MainAbility"
],
"when": "inuse"
}
},
{
"name": "ohos.permission.ACTIVITY_MOTION",
"reason": "",
"usedScene": {
"ability": [
".MainAbility"
],
"when": "inuse"
}
},
]
```
......@@ -63,12 +63,12 @@
```
import vibrator from "@ohos.vibrator"
vibrator.vibrate(1000).then((error)=>{
if(error){//调用失败，打印error.code和error.message
Console.log("Promise return failed.error.code"+error.code+"error.message"+error.message);
}else{//调用成功,设备开始振动
vibrator.vibrate(1000).then((error) => {
if (error) { //调用失败，打印error.code和error.message
Console.log("Promise return failed.error.code " + error.code + "error.message " + error.message);
} else { //调用成功,设备开始振动
Console.log("Promise returned to indicate a successful vibration.")
};
}
})
```
......@@ -76,12 +76,12 @@
```
import vibrator from "@ohos.vibrator"
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then((error)=>{
if(error){//调用失败，打印error.code和error.message
Console.log("Promise return failed.error.code"+error.code+"error.message"+error.message);
}else{//调用成功，设备停止振动
vibrator.stop(vibrator.VibratorStopMode.VIBRATOR_STOP_MODE_PRESET).then((error) => {
if (error) { //调用失败，打印error.code和error.message
Console.log("Promise return failed.error.code " + error.code + "error.message " + error.message);
} else { //调用成功，设备停止振动
Console.log("Promise returned to indicate successful.");
};
}
})
```
......
zh-cn/application-dev/internationalization/intl-guidelines.md
浏览文件 @ ccc7c3ae
......@@ -7,21 +7,19 @@
调用[Locale](../reference/apis/js-apis-intl.md)的相关接口实现最大化区域信息或最小化区域信息。
### 接口说明
| 模块 | 接口名称 | 描述 |
| -------- | -------- | -------- |
| ohos.intl | constructor()<sup>8+</sup> | 实例化Locale对象。 |
| ohos.intl | constructor(locale:&nbsp;string,&nbsp;options?:&nbsp;LocaleOptions) | 基于locale参数及其选项实例化Locale对象。 |
| ohos.intl | toString():&nbsp;string | 将Locale信息转换为字符串。 |
| ohos.intl | maximize():&nbsp;Locale | 最大化区域信息。 |
| ohos.intl | minimize():&nbsp;Locale | 最小化区域信息。 |
| ohos.intl | constructor(locale:string,options?:LocaleOptions) | 基于locale参数及其选项实例化Locale对象。 |
| ohos.intl | toString():string | 将Locale信息转换为字符串。 |
| ohos.intl | maximize():Locale | 最大化区域信息。 |
| ohos.intl | minimize():Locale | 最小化区域信息。 |
### 开发步骤
1. 实例化Locale对象
1. 实例化Locale对象。
使用Locale的构造函数创建Locale对象，该方法接收一个表示Locale的字符串及可选的[属性](../reference/apis/js-apis-intl.md)列表（intl为导入的模块名）。
......@@ -39,281 +37,290 @@
| kn | 表示字符串排序、比较时是否考虑数字的实际值 |
| kf | 表示字符串排序、比较时是否考虑大小写 |
```
| 扩展参数ID | 扩展参数说明 |
| -------- | -------- |
| ca | 表示日历系统 |
| co | 表示排序规则 |
| hc | 表示守时惯例 |
| nu | 表示数字系统 |
| kn | 表示字符串排序、比较时是否考虑数字的实际值 |
| kf | 表示字符串排序、比较时是否考虑大小写 |
```js
var locale = "zh-CN";
var options = {caseFirst: false, calendar: "chinese", collation: pinyin};
var localeObj = new intl.Locale(locale, options);
```
2. 获取Locale的字符串表示
2. 获取Locale的字符串表示。
调用toString方法来获取Locale对象的字符串表示，其中包括了语言、区域及其他选项信息。
```
```js
var localeStr = localeObj.toString();
```
3. 最大化区域信息
3. 最大化区域信息。
调用maximize方法来最大化区域信息，即当缺少脚本与地区信息时，对其进行补全。
```
```js
var maximizedLocale = localeObj.maximize();
```
4. 最小化区域信息
4. 最小化区域信息。
调用minimize方法来最小化区域信息，即当存在脚本与地区信息时，对其进行删除。
```
```js
var minimizedLocale = localeObj.minimize();
```
## 格式化日期时间
调用日期时间格式化[DateTimeFormat](../reference/apis/js-apis-intl.md)的接口，实现针对特定Locale的日期格式化以及时间段格式化功能。
### 接口说明
| 模块 | 接口名称 | 描述 |
| -------- | -------- | -------- |
| ohos.intl | constructor()<sup>8+</sup> | 创建日期时间格式化对象。 |
| ohos.intl | constructor(locale:&nbsp;string&nbsp;\|&nbsp;Array&lt;string&gt;,&nbsp;options?:&nbsp;DateTimeOptions) | 创建日期时间格式化对象，并设置提供的Locale和格式化相关属性。 |
| ohos.intl | format(date:&nbsp;Date):&nbsp;string | 依据DateTimeFormat对象的Locale及其他格式化属性，计算日期时间的格式化表示。 |
| ohos.intl | formatRange(startDate:&nbsp;Date,&nbsp;endDate:&nbsp;Date):&nbsp;string | 依据DateTimeFormat对象的Locale及其他格式化属性，计算时间段的格式化表示。 |
| ohos.intl | resolvedOptions():&nbsp;DateTimeOptions | 获取DateTimeFormat对象的相关属性。 |
| ohos.intl | constructor(locale:string\|Array&lt;string&gt;,options?:DateTimeOptions) | 创建日期时间格式化对象，并设置提供的Locale和格式化相关属性。 |
| ohos.intl | format(date:Date):string | 依据DateTimeFormat对象的Locale及其他格式化属性，计算日期时间的格式化表示。 |
| ohos.intl | formatRange(startDate:Date,endDate:Date):string | 依据DateTimeFormat对象的Locale及其他格式化属性，计算时间段的格式化表示。 |
| ohos.intl | resolvedOptions():DateTimeOptions | 获取DateTimeFormat对象的相关属性。 |
### 开发步骤
1. 实例化日期时间格式化对象
1. 实例化日期时间格式化对象。
一种方法是使用DateTimeFormat提供的默认构造函数，通过访问系统语言和地区设置，获取系统默认Locale，并将其作为DateTimeFormat对象内部的Locale（intl为导入的模块名）。
```
```js
var dateTimeFormat = new intl.DateTimeFormat();
```
另一种方法是使用开发者提供的Locale和格式化参数来创建日期时间格式化对象。其中，格式化参数是可选的，完整的格式化参数列表见[DateTimeOptions](../reference/apis/js-apis-intl.md)。
```
```js
var options = {dateStyle: "full", timeStyle: "full"};
var dateTimeFormat = new intl.DateTimeFormat("zh-CN", options);
```
2. 格式化日期时间
2. 格式化日期时间。
使用DateTimeFormat的format方法对一个Date对象进行格式化，该方法会返回一个字符串作为格式化的结果。
```
```js
Date date = new Date();
var formatResult = dateTimeFormat.format(date);
```
3. 格式化时间段
3. 格式化时间段。
使用DateTimeFormat的formatRange方法对一个时间段进行格式化。该方法需要传入两个Date对象，分别表示时间段的起止时间，返回一个字符串作为格式化的结果。
```
```js
Date startDate = new Date();
Date endDate = new Date();
var formatResult = dateTimeFormat.formatRange(startDate, endDate);
```
4. 访问日期时间格式化对象的相关属性
4. 访问日期时间格式化对象的相关属性。
DateTimeFormat的resolvedOptions方法会返回一个对象，该对象包含了DateTimeFormat对象的所有相关属性及其值。
```
```js
var options = dateTimeFormat.resolvedOptions();
```
## 数字格式化
调用数字格式化[NumberFormat](../reference/apis/js-apis-intl.md)的接口，实现针对特定Locale的数字格式化功能。
### 接口说明
| 模块 | 接口名称 | 描述 |
| -------- | -------- | -------- |
| ohos.intl | constructor()<SUP>8+</SUP> | 创建数字格式化对象。 |
| ohos.intl | constructor(locale:&nbsp;string&nbsp;\|&nbsp;Array&lt;string&gt;,&nbsp;options?:&nbsp;NumberOptions) | 创建数字格式化对象，并设置提供的locale和格式化相关属性。 |
| ohos.intl | format(number:&nbsp;number):&nbsp;string | 依据NumberFormat对象的Locale及其他格式化属性，计算数字的格式化表示。 |
| ohos.intl | resolvedOptions():&nbsp;NumberOptions | 获取NumberFormat对象的相关属性。 |
| ohos.intl | constructor(locale:string\|Array&lt;string&gt;,options?:NumberOptions) | 创建数字格式化对象，并设置提供的locale和格式化相关属性。 |
| ohos.intl | format(number:number):string | 依据NumberFormat对象的Locale及其他格式化属性，计算数字的格式化表示。 |
| ohos.intl | resolvedOptions():NumberOptions | 获取NumberFormat对象的相关属性。 |
### 开发步骤
1. 实例化数字格式化对象
1. 实例化数字格式化对象。
一种方法是使用NumberFormat提供的默认构造函数，通过访问系统的语言和地区以获取系统默认Locale并进行设置（intl为导入的模块名）。
```
```js
var numberFormat = new intl.NumberFormat();
```
另一种方法是使用开发者提供的Locale和格式化参数来创建数字格式化对象。其中，格式化参数是可选的，完整的格式化参数列表参见[NumberOptions](../reference/apis/js-apis-intl.md)。
```
```js
var options = {compactDisplay: "short", notation: "compact"};
var numberFormat = new intl.NumberFormat("zh-CN", options);
```
2. 数字格式化
2. 数字格式化。
使用NumberFormat的format方法对传入的数字进行格式化。该方法返回一个字符串作为格式化的结果。
```
```js
var number = 1234.5678
var formatResult = numberFormat.format(number);
```
3. 访问数字格式化对象的相关属性
3. 访问数字格式化对象的相关属性。
NumberFormat的resolvedOptions方法会返回一个对象，该对象包含了NumberFormat对象的所有相关属性及其值。
```
```js
var options = numberFormat.resolvedOptions();
```
## 字符串排序
不同区域的用户对于字符串排序具有不同的需求。调用字符串排序[Collator](../reference/apis/js-apis-intl.md)的接口，实现针对特定Locale的字符串排序功能。
### 接口说明
| 模块 | 接口名称 | 描述 |
| -------- | -------- | -------- |
| ohos.intl | constructor()<sup>8+</sup> | 创建排序对象。 |
| ohos.intl | constructor(locale:&nbsp;string&nbsp;\|&nbsp;Array&lt;string&gt;,&nbsp;options?:&nbsp;CollatorOptions)<sup>8+</sup> | 创建排序对象，并设置提供的locale和其他相关属性。 |
| ohos.intl | compare(first:&nbsp;string,&nbsp;second:&nbsp;string):&nbsp;number<sup>8+</sup> | 依据排序对象的Locale及其属性，计算两个字符串的比较结果。 |
| ohos.intl | resolvedOptions():&nbsp;CollatorOptions<sup>8+</sup> | 获取排序对象的相关属性。 |
| ohos.intl | constructor(locale:string\|Array&lt;string&gt;,options?:CollatorOptions)<sup>8+</sup> | 创建排序对象，并设置提供的locale和其他相关属性。 |
| ohos.intl | compare(first:string,second:string):number<sup>8+</sup> | 依据排序对象的Locale及其属性，计算两个字符串的比较结果。 |
| ohos.intl | resolvedOptions():CollatorOptions<sup>8+</sup> | 获取排序对象的相关属性。 |
### 开发步骤
1. 实例化排序对象
1. 实例化排序对象。
一种方法是使用Collator提供的默认构造函数，通过访问系统的语言和地区以获取系统默认Locale并进行设置（intl为导入的模块名）。
```
```js
var collator = new intl.Collator();
```
另一种方法是使用开发者提供的Locale和其他相关参数来创建Collator对象，完整的参数列表参见[CollatorOptions](../reference/apis/js-apis-intl.md)。
```
var collator= new intl.Collator("zh-CN", {localeMatcher: "best fit", usage: "sort"};
```js
var collator= new intl.Collator("zh-CN", {localeMatcher: "best fit", usage: "sort"});
```
2. 比较字符串
2. 比较字符串。
使用Collator的compare方法对传入的两个字符串进行比较。该方法返回一个数值作为比较的结果，返回-1表示第一个字符串小于第二个字符串，返回1表示第一个字符大于第二个字符串，返回0表示两个字符串相同。
```
```js
var str1 = "first string";
var str2 = "second string";
var compareResult = collator.compare(str1, str2);
```
3. 访问排序对象的相关属性
3. 访问排序对象的相关属性。
Collator的resolvedOptions方法会返回一个对象，该对象包含了Collator对象的所有相关属性及其值。
```
```js
var options = collator.resolvedOptions();
```
## 判定单复数类别
在一些语言的语法中，当数字后面存在名词时，名词需要根据数字的值采用不同的形式。调用单复数[PluralRules](../reference/apis/js-apis-intl.md)的接口，可以实现针对特定Locale计算数字单复数类别的功能，从而选择合适的名词单复数表示。
### 接口说明
| 模块 | 接口名称 | 描述 |
| -------- | -------- | -------- |
| ohos.intl | constructor()<sup>8+</sup> | 创建单复数对象。 |
| ohos.intl | constructor(locale:&nbsp;string&nbsp;\|&nbsp;Array&lt;string&gt;,&nbsp;options?:&nbsp;PluralRulesOptions)<sup>8+</sup> | 创建单复数对象，并设置提供的locale和其他相关属性。 |
| ohos.intl | select(n:&nbsp;number):&nbsp;string<sup>8+</sup> | 依据单复数对象的Locale及其他格式化属性，计算数字的单复数类别。 |
| ohos.intl | constructor(locale:string\|Array&lt;string&gt;,options?:PluralRulesOptions)<sup>8+</sup> | 创建单复数对象，并设置提供的locale和其他相关属性。 |
| ohos.intl | select(n:number):string<sup>8+</sup> | 依据单复数对象的Locale及其他格式化属性，计算数字的单复数类别。 |
### 开发步骤
1. 实例化单复数对象
1. 实例化单复数对象。
一种方法是使用PluralRules提供的默认构造函数，通过访问系统的语言和地区以获取系统默认Locale并进行设置（intl为导入的模块名）。
```
```js
var pluralRules = new intl.PluralRules();
```
另一种方法是使用开发者提供的Locale和其他相关参数来创建单复数对象，完整的参数列表参见[PluralRulesOptions](../reference/apis/js-apis-intl.md)。
另一种方法是使用开发者提供的Locale和其他相关参数来创建单复数对象。完整的参数列表参见[PluralRulesOptions](../reference/apis/js-apis-intl.md)。
```
var plurals = new intl.PluralRules("zh-CN", {localeMatcher: "best fit", type: "cardinal"};
```js
var plurals = new intl.PluralRules("zh-CN", {localeMatcher: "best fit", type: "cardinal"});
```
2. 计算数字单复数类别
2. 计算数字单复数类别。
使用PluralRules的select方法计算传入数字的单复数类别。该方法返回一个字符串作为传入数字的类别，包括："zero", "one", "two", "few", "many", "other"六个类别。
```
```js
var number = 1234.5678
var categoryResult = plurals.select(number);
```
## 相对时间格式化
调用相对时间格式化[RelativeTimeFormat](../reference/apis/js-apis-intl.md)的接口，实现针对特定Locale的相对时间格式化功能。
### 接口说明
| 模块 | 接口名称 | 描述 |
| -------- | -------- | -------- |
| ohos.intl | constructor()<sup>8+</sup> | 创建相对时间格式化对象。 |
| ohos.intl | constructor(locale:&nbsp;string&nbsp;\|&nbsp;Array&lt;string&gt;,&nbsp;options?:&nbsp;RelativeTimeFormatInputOptions)<sup>8+</sup> | 创建相对时间格式化对象，并设置提供的locale和格式化相关属性。 |
| ohos.intl | format(value:&nbsp;number,&nbsp;unit:&nbsp;string):&nbsp;string<sup>8+</sup> | 依据相对时间格式化对象的Locale及其他格式化属性，计算相对时间的格式化表示。 |
| ohos.intl | formatToParts(value:&nbsp;number,&nbsp;unit:&nbsp;string):&nbsp;Array&lt;object&gt;<sup>8+</sup> | 依据相对时间格式化对象的Locale及其他格式化属性，返回相对时间格式化表示的各个部分。 |
| ohos.intl | resolvedOptions():&nbsp;RelativeTimeFormatResolvedOptions<sup>8+</sup> | 获取相对时间格式化对象的相关属性。 |
| ohos.intl | constructor(locale:string\|Array&lt;string&gt;,options?:RelativeTimeFormatInputOptions)<sup>8+</sup> | 创建相对时间格式化对象，并设置提供的locale和格式化相关属性。 |
| ohos.intl | format(value:number,unit:string):string<sup>8+</sup> | 依据相对时间格式化对象的Locale及其他格式化属性，计算相对时间的格式化表示。 |
| ohos.intl | formatToParts(value:number,unit:string):Array&lt;object&gt;<sup>8+</sup> | 依据相对时间格式化对象的Locale及其他格式化属性，返回相对时间格式化表示的各个部分。 |
| ohos.intl | resolvedOptions():RelativeTimeFormatResolvedOptions<sup>8+</sup> | 获取相对时间格式化对象的相关属性。 |
### 开发步骤
1. 实例化相对时间格式化对象
一种方法是使用RelativeTimeFormat提供的默认构造函数，通过访问系统的语言和地区以获取系统默认Locale并进行设置（intl为导入的模块名）。
1. 实例化相对时间格式化对象。
一种方法是使用RelativeTimeFormat提供的默认构造函数，通过访问系统的语言和地区以获取系统默认Locale并进行设置（intl为导入的模块名）。
```
```js
var relativeTimeFormat = new intl.RelativeTimeFormat();
```
另一种方法是使用开发者提供的Locale和格式化参数来创建相对时间格式化对象。其中，格式化参数是可选的，完整的参数列表参见[ RelativeTimeFormatInputOptions](../reference/apis/js-apis-intl.md)。
```
var relativeTimeFormat = new intl.RelativeTimeFormat("zh-CN", {numeric: "always", style: "long"};
var relativeTimeFormat = new intl.RelativeTimeFormat("zh-CN", {numeric: "always", style: "long"});
```
2. 相对时间格式化
2. 相对时间格式化。
使用RelativeTimeFormat的format方法对相对时间进行格式化。方法接收一个表示相对时间长度的数值和表示单位的字符串，其中单位包括："year", "quarter", "month", "week", "day", "hour", "minute", "second"。方法返回一个字符串作为格式化的结果。
```
```js
var number = 2;
var unit = "year"
var formatResult = relativeTimeFormat.format(number, unit);
```
3. 获取相对时间格式化结果的各个部分
3. 获取相对时间格式化结果的各个部分。
获取相对时间格式化结果的各个部分，从而自定义格式化结果。
```
```js
var number = 2;
var unit = "year"
var formatResult = relativeTimeFormat.formatToParts(number, unit);
```
4. 访问相对时间格式化对象的相关属性
4. 访问相对时间格式化对象的相关属性。
RelativeTimeFormat的resolvedOptions方法会返回一个对象，该对象包含了RelativeTimeFormat对象的所有相关属性及其值，完整的属性列表参见[ RelativeTimeFormatResolvedOptions](../reference/apis/js-apis-intl.md)。
```
```js
var options = numberFormat.resolvedOptions();
```
......
zh-cn/application-dev/media/image.md
浏览文件 @ ccc7c3ae
......@@ -15,13 +15,13 @@
包含流程：创建实例、读取图片信息、读写pixelmap、更新数据、打包像素、释放资源等流程。
```js
const Color = new ArrayBuffer(96);//用于存放图像像素数据
const color = new ArrayBuffer(96);//用于存放图像像素数据
let opts = { alphaType: 0, editable: true, pixelFormat: 4, scaleMode: 1, size: { height: 2, width: 3 } } //图像像素数据
//创建pixelmap对象
const Color = new ArrayBuffer(96);
const color = new ArrayBuffer(96);
let opts = { alphaType: 0, editable: true, pixelFormat: 4, scaleMode: 1, size: { height: 2, width: 3 } }
image.createPixelMap(Color, opts, pixelmap => {
image.createPixelMap(color, opts, pixelmap => {
expect(pixelmap !== null).assertTrue();
console.info('TC_001-1 success');
done();
......
zh-cn/application-dev/quick-start/full-sdk-switch-guide.md 0 → 100644
浏览文件 @ ccc7c3ae
# full-SDK替换指南
**public-SDK**是提供给应用开发的工具包，跟随DevEco Studio下载，不包含系统应用所需要的高权限API
**full-SDK**是提供给OEM厂商开发应用的工具包，不能随DevEco Studio下载，包含了系统应用所需要的高权限API
三方开发者通过DevEco Studio自动下载的**API8版本**SDK均为**public版本**。public-SDK**不支持**开发者使用**所有的系统API**，包括animator组件、xcomponent组件、@ohos.application.abilityManager.d.ts、@ohos.application.formInfo.d.ts、@ohos.bluetooth.d.ts等，如工程必须依赖于系统API，请按照以下步骤替换**full-SDK**。
## 下载full-SDK(这里以3.1.1 Release版本为例)
full-SDK需要手动下载。请参考[OpenHarmony 3.1.1 Release版本说明书](https://gitee.com/openharmony/docs/blob/master/zh-cn/release-notes/OpenHarmony-v3.1.1-release.md)中的获取方式，获取所需的操作系统的full-SDK。
![image-20220613161049897](figures/zh-cn_image_0000001655128646.png)
## 查看本地SDK路径(此处以ets工程为例，1.0工程请以相同方式替换js-SDK)
打开DevEco Studio——>Tools——>OpenHarmony SDK Manager，查看本地SDK安装路径。
![](figures/zh-cn_image_0000001655128939.png)
![image-20220613160524053](figures/zh-cn_image_0000001655128998.png)
## 替换SDK
1. 确认下载的SDK版本是否为full-SDK
a.检查下载文件名是否包含full-SDK字样
![image-20220613220702504](figures/zh-cn_image_0000001655129232.png)
b.检查api中是否包含系统API（@ohos.application.abilityManager.d.ts、@ohos.application.formInfo.d.ts、@ohos.bluetooth.d.ts等）
注：系统api判定标准以发布api指导文档为主。
2. 替换SDK，以public-SDK-3.1.6.6版本为例。
以windows为例：
a.解压已下载的full-SDK文件：`ets-windows-3.1.6.5-Release.zip`
![image-20220613165018184](figures/zh-cn_image_0000001655129264.png)
b.替换SDK文件
**备份本地SDK**（复制并重命名ets目录下版本信息目录名，或者将ets目录拷贝至其他本地路径）
打开获取到的本地已安装SDK文件路径并进行备份。
![image-20220613161352157](figures/zh-cn_image_0000001655129041.png)
注：备份版本信息目录名称只要与其下`oh-uni-package.json`配置文件的version字段不一致即可，如下图所示，备份3.1.6.6版本sdk
![image-20220613165018184](figures/zh-cn_image_0000001655129398.png)
`oh-uni-package.json`文件配置信息如下：
```
{
"apiVersion": "8",
"displayName": "Ets",
"meta": {
"metaVersion": "3.0.0"
},
"path": "ets",
"releaseType": "Release",
"version": "3.1.6.6"
}
```
**删除原SDK（3.1.6.6）目录中的所有文件**（否则可能会导致文件无法全部覆盖）
**拷贝full-SDK至本地SDK路径**
将下载的full-SDK文件包中`ets`目录下的所有文件替换至本地SDK路径下`ets\3.1.6.6`目录中
修改`oh-uni-package.json`配置文件的version字段为当前SDK版本号
在`3.1.6.6\build-tools\ets-loader`目录中打开cmd/powerShell窗口，输入命令`npm install`下载**node_modules**依赖包
![image-20220613171111405](figures/zh-cn_image_0000001655129333.png)
c.验证系统API接口
![image-20220613213038104](figures/zh-cn_image_0000001655129372.png)
\ No newline at end of file
zh-cn/application-dev/quick-start/package-structure.md
浏览文件 @ ccc7c3ae
......@@ -116,15 +116,15 @@ app实例：
"bundleName": "com.example.myapplication",
"vendor": "example",
"version": {
"code": 1,
"name": "1.0"
"code": 1,
"name": "1.0"
},
"apiVersion": {
"compatible": 4,
"target": 5,
"releaseType": "Beta1"
"compatible": 4,
"target": 5,
"releaseType": "Beta1"
}
}
}
```
### deviceConfig对象的内部结构
......@@ -187,24 +187,24 @@ deviceConfig示例：
```json
"deviceConfig": {
"default": {
"process": "com.example.test.example",
"supportBackup": false,
"network": {
"cleartextTraffic": true,
"securityConfig": {
"domainSettings": {
"cleartextPermitted": true,
"domains": [
{
"subdomains": true,
"name": "example.ohos.com"
}
]
}
}
}
}
"default": {
"process": "com.example.test.example",
"supportBackup": false,
"network": {
"cleartextTraffic": true,
"securityConfig": {
"domainSettings": {
"cleartextPermitted": true,
"domains": [
{
"subdomains": true,
"name": "example.ohos.com"
}
]
}
}
}
}
}
```
......@@ -240,33 +240,33 @@ module示例：
```json
"module": {
"mainAbility": "MainAbility",
"package": "com.example.myapplication.entry",
"name": ".MyOHOSAbilityPackage",
"description": "$string:description_application",
"supportModes": [
"drive"
],
"deviceType": [
"car"
],
"distro": {
"moduleName": "ohos_entry",
"moduleType": "entry"
},
"abilities": [
...
],
"shortcuts": [
...
],
"js": [
...
],
"reqPermissions": [
...
],
"colorMode": "light"
"mainAbility": "MainAbility",
"package": "com.example.myapplication.entry",
"name": ".MyOHOSAbilityPackage",
"description": "$string:description_application",
"supportModes": [
"drive"
],
"deviceType": [
"car"
],
"distro": {
"moduleName": "ohos_entry",
"moduleType": "entry"
},
"abilities": [
...
],
"shortcuts": [
...
],
"js": [
...
],
"reqPermissions": [
...
],
"colorMode": "light"
}
```
......@@ -283,9 +283,9 @@ distro示例：
```json
"distro": {
"moduleName": "ohos_entry",
"moduleType": "entry",
"installationFree": true,
"moduleName": "ohos_entry",
"moduleType": "entry",
"installationFree": true,
"deliveryWithInstall": true
}
```
......@@ -398,8 +398,7 @@ abilities示例：
"label": "$media:example",
"launchType": "standard",
"orientation": "unspecified",
"permissions": [
],
"permissions": [],
"visible": true,
"skills": [
{
......@@ -488,13 +487,13 @@ skills示例：
],
"uris": [
{
"scheme": "http",
"host": "www.example.com",
"port": "8080",
"path": "query/student/name",
"type": "text/*"
}
]
"scheme": "http",
"host": "www.example.com",
"port": "8080",
"path": "query/student/name",
"type": "text/*"
}
]
}
]
```
......@@ -750,18 +749,18 @@ commonEvents示例：
```json
"commonEvents": [
{
"name":"MainAbility",
"permission": "string",
"data":[
"string",
"string"
],
"events": [
"string",
"string"
]
}
{
"name":"MainAbility",
"permission": "string",
"data":[
"string",
"string"
],
"events": [
"string",
"string"
]
}
]
```
......@@ -774,8 +773,8 @@ commonEvents示例：
```json
"testRunner": {
"name": "myTestRUnnerName",
"srcPath": "etc/test/TestRunner.ts"
"name": "myTestRUnnerName",
"srcPath": "etc/test/TestRunner.ts"
}
```
zh-cn/application-dev/quick-start/stage-structure.md
浏览文件 @ ccc7c3ae
......@@ -21,7 +21,7 @@ app.json示例：
```json
{
"app": {
"app": {
"bundleName": "com.application.music",
"vendor": "application",
"versionCode": 1,
......@@ -233,13 +233,13 @@ deviceTypes示例 :
```json
{
"module": {
"name": "myHapName",
"module": {
"name": "myHapName",
"type": "har",
"deviceTypes" : [
"wearable"
]
}
}
}
```
......@@ -604,7 +604,7 @@ form示例 :
"supportDimensions": [
"2*2"
],
"metadata": [
"metadata": [
{
"name": "string",
"value": "string",
......@@ -620,18 +620,14 @@ form示例 :
```json
{
"extensionAbilities": [
{
"name": "MyForm",
"type": "form",
"metadata": [
{
"name": "ohos.extability.form",
"resource": "$profile:form_config",
}
],
}
]
"extensionAbilities": [{
"name": "MyForm",
"type": "form",
"metadata": [{
"name": "ohos.extability.form",
"resource": "$profile:form_config"
}]
}]
}
```
......@@ -656,19 +652,15 @@ metadata中指定shortcut信息，其中 :
```json
{
"shortcuts": [
{
"shortcutId": "id_test1",
"label": "$string:shortcut",
"icon": "$media:aa_icon",
"wants": [
{
"bundleName": "com.ohos.hello"
"abilityName": "MainAbility"
}
]
}
]
"shortcuts": [{
"shortcutId": "id_test1",
"label": "$string:shortcut",
"icon": "$media:aa_icon",
"wants": [{
"bundleName": "com.ohos.hello",
"abilityName": "MainAbility"
}]
}]
}
```
......@@ -678,23 +670,19 @@ metadata中指定shortcut信息，其中 :
{
"module": {
"name": "MyAbilityStage",
"abilities" : [
{
"name" : "MyAbility",
"srcEntrance": "./abilities/MyAbility.ts",
"skills": [{
"actions": ["action.system.home"],
"entities": ["entity.system.home"],
"uris": []
}],
"metadata": [
{
"name": "ohos.ability.shortcuts",
"resource": "$profile:shortcuts_config",
}
],
}
]
"abilities": [{
"name": "MyAbility",
"srcEntrance": "./abilities/MyAbility.ts",
"skills": [{
"actions": ["action.system.home"],
"entities": ["entity.system.home"],
"uris": []
}],
"metadata": [{
"name": "ohos.ability.shortcuts",
"resource": "$profile:shortcuts_config"
}]
}]
}
}
```
......@@ -721,20 +709,18 @@ metadata中指定commonEvent信息，其中 :
```json
{
"commonEvents": [
{
"name": "abilityName",
"permission": "string",
"types": [
"string",
"string"
],
"events": [
"string",
"string"
]
}
]
"commonEvents": [{
"name": "abilityName",
"permission": "string",
"types": [
"string",
"string"
],
"events": [
"string",
"string"
]
}]
}
```
......@@ -746,12 +732,10 @@ metadata中指定commonEvent信息，其中 :
"name": "mySubscriber",
"srcEntrance": "./extension/my_subscriber.js",
"type": "staticSubscriber",
"metadata": [
{
"name": "ohos.extability.staticSubscriber",
"resource": "$profile:common_event_config",
}
],
"metadata": [{
"name": "ohos.extability.staticSubscriber",
"resource": "$profile:common_event_config",
}],
}
]
```
......@@ -814,17 +798,17 @@ distroFilter示例 :
```json
"distroFilter": [
{
"apiVersion": {
"apiVersion": {
"policy": "include",
"value": [4,5]
"value": [4, 5]
},
"screenShape": {
"policy": "include",
"value": ["circle","rect"]
"value": ["circle", "rect"]
},
"screenWindow": {
"policy": "include",
"value": ["454*454","466*466"]
"value": ["454*454", "466*466"]
}
}
]
......@@ -837,16 +821,13 @@ distroFilter示例 :
{
"name": "mySubscriber",
"srcEntrance": "./extension/my_subscriber.js",
"type": "staticSubscriber",
"metadata": [
{
"name": "ohos.extability.staticSubscriber",
"resource": "$profile:distroFilter_config",
}
],
"type": "staticSubscriber",
"metadata": [{
"name": "ohos.extability.staticSubscriber",
"resource": "$profile:distroFilter_config",
}],
}
]
```
#### testRunner对象内部结构
......@@ -858,8 +839,8 @@ distroFilter示例 :
```
"testRunner": {
"name": "myTestRUnnerName",
"srcPath": "etc/test/TestRunner.ts"
"name": "myTestRUnnerName",
"srcPath": "etc/test/TestRunner.ts"
}
```
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @ ccc7c3ae
......@@ -81,6 +81,7 @@
- 图形图像
- [@ohos.display (屏幕属性)](js-apis-display.md)
- [@ohos.effectKit (图像效果)](js-apis-effectKit.md)
- [@ohos.screenshot (屏幕截图)](js-apis-screenshot.md)
- [@ohos.window (窗口)](js-apis-window.md)
- [webgl (WebGL)](js-apis-webgl.md)
......
zh-cn/application-dev/reference/apis/js-apis-Bundle.md
浏览文件 @ ccc7c3ae
......@@ -8,7 +8,7 @@
> API9 当前为Canary版本，仅供试用，不保证接口可稳定调用。
## 导入模块
```
```js
import bundle from '@ohos.bundle';
```
......@@ -69,8 +69,6 @@ bundle.getApplicationInfo(bundleName, bundleFlags, userId)
})
```
## bundle.getApplicationInfo
getApplicationInfo(bundleName: string, bundleFlags: number, userId: number, callback: AsyncCallback\<ApplicationInfo>): void
......@@ -109,7 +107,6 @@ bundle.getApplicationInfo(bundleName, bundleFlags, userId, (err, data) => {
})
```
## bundle.getApplicationInfo
getApplicationInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback\<ApplicationInfo>): void
......@@ -146,7 +143,6 @@ bundle.getApplicationInfo(bundleName, bundleFlags, (err, data) => {
})
```
## bundle.getAllBundleInfo
getAllBundleInfo(bundleFlag: BundleFlag, userId?: number): Promise<Array\<BundleInfo>>
......@@ -187,8 +183,6 @@ bundle.getAllBundleInfo(bundleFlag, userId)
})
```
## bundle.getAllBundleInfo
getAllBundleInfo(bundleFlag: BundleFlag, callback: AsyncCallback<Array\<BundleInfo>>): void
......@@ -223,7 +217,6 @@ bundle.getAllBundleInfo(bundleFlag, (err, data) => {
})
```
## bundle.getAllBundleInfo
getAllBundleInfo(bundleFlag: BundleFlag, userId: number, callback: AsyncCallback<Array\<BundleInfo>>): void
......@@ -260,8 +253,6 @@ bundle.getAllBundleInfo(bundleFlag, userId, (err, data) => {
})
```
## bundle.getBundleInfo
getBundleInfo(bundleName: string, bundleFlags: number, options?: BundleOptions): Promise\<BundleInfo>
......@@ -306,8 +297,6 @@ bundle.getBundleInfo(bundleName, bundleFlags, options)
})
```
## bundle.getBundleInfo
getBundleInfo(bundleName: string, bundleFlags: number, callback: AsyncCallback\<BundleInfo>): void
......
zh-cn/application-dev/reference/apis/js-apis-Context.md
浏览文件 @ ccc7c3ae
......@@ -832,7 +832,7 @@ getAbilityInfo(callback: AsyncCallback\<AbilityInfo>): void
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | ------------------------- |
| callback | AsyncCallback\<[AbilityInfo](#abilityInfo)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回当前归属Ability详细信息。|
| callback | AsyncCallback\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 是 | 回调函数，可以在回调函数中处理接口返回值，返回当前归属Ability详细信息。|
**示例：**
......@@ -860,7 +860,7 @@ getAbilityInfo(): Promise\<AbilityInfo>
| 类型 | 说明 |
| --------------- | ------------------------- |
| Promise\<[AbilityInfo](#abilityInfo)> | 返回当前归属Ability详细信息。 |
| Promise\<[AbilityInfo](js-apis-bundle-AbilityInfo.md)> | 返回当前归属Ability详细信息。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-EnterpriseAdminExtensionAbility.md
浏览文件 @ ccc7c3ae
# EnterpriseAdminExtentionAbility
EnterpriseAdminExtentionAbility模块提供企业管理员应用扩展相关接口。
本模块提供企业管理员应用拓展能力。
企业管理员应用需要存在一个EnterpriseAdminExtentionAbility并重写相关接口，以此具备模块提供的各项能力，比如接收由系统发送的该应用被激活或者去激活的通知。
> **说明：**
>
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```ts
......@@ -22,12 +26,12 @@ onAdminEnabled(): void
**示例：**
```ts
```ts
export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility {
onAdminEnabled() {
}
onAdminEnabled() {
}
};
```
```
## EnterpriseAdminExtentionAbility.onAdminDisabled
......@@ -38,11 +42,10 @@ onAdminDisabled(): void
**系统能力**：SystemCapability.Customation.EnterpriseDeviceManager
**示例：**
```ts
```ts
export default class EnterpriseAdminAbility extends EnterpriseAdminExtensionAbility {
onAdminDisabled() {
}
onAdminDisabled() {
}
};
```
\ No newline at end of file
```
zh-cn/application-dev/reference/apis/js-apis-abilityAccessCtrl.md
浏览文件 @ ccc7c3ae
......@@ -68,6 +68,36 @@ promise.then(data => {
});
```
### verifyAccessTokenSync<sup>9+</sup>
verifyAccessTokenSync(tokenID: number, permissionName: string): GrantStatus
校验应用是否被授予权限，同步返回结果。
**系统能力：** SystemCapability.Security.AccessToken
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------- | ---- | ------------------------------------------ |
| tokenID | number | 是 | 要校验应用的身份标识。 |
| permissionName | string | 是 | 需要校验的权限名称。 |
**返回值：**
| 类型 | 说明 |
| :------------ | :---------------------------------- |
| [GrantStatus](#grantstatus) | 枚举实例，返回授权状态。 |
**示例：**
```js
var AtManager = abilityAccessCtrl.createAtManager();
let tokenID = 0;
let data = verifyAccessTokenSync(tokenID, "ohos.permission.GRANT_SENSITIVE_PERMISSIONS");
console.log(`data->${JSON.stringify(data)}`);
```
### grantUserGrantedPermission
grantUserGrantedPermission(tokenID: number, permissionName: string, permissionFlag: number): Promise&lt;number&gt;
......
zh-cn/application-dev/reference/apis/js-apis-application-Want.md
浏览文件 @ ccc7c3ae
......@@ -20,11 +20,26 @@ import Want from '@ohos.application.Want';
| ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
| bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了package和AbilityName，则Want可以直接匹配到指定的Ability。 |
| abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中该字段同时指定了package和AbilityName，则Want可以直接匹配到指定的Ability。AbilityName需要在一个应用的范围内保证唯一。 |
| uri | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 |
| type | 只读 | string | 否 | 表示MIME type类型描述，比如："text/plain" 、 "image/*"等。 |
| flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](js-apis-featureAbility.md#flags说明)。 |
| action | 只读 | string | 否 | 表示action选项描述。 |
| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述，由开发者自行决定传入的键值对。默认会携带以下key值：<br>ohos.aafwk.callerPid 表示拉起方的pid。<br>ohos.aafwk.param.callerToken 表示拉起方的token。<br>ohos.aafwk.param.callerUid 表示发起方的uid。[Bundle](js-apis-Bundle.js)模块中userId参数，可用于获取应用信息、包信息等，具体参考：[Bundle](js-apis-Bundle.js)。 |
| entities | 只读 | Array\<string> | 否 | 表示entities相关描述。 |
| moduleName<sup>9+</sup> | 只读 | string | 否 | 表示待启动的Ability所属的模块（module）。同一应用的不同hap的组件可能重名，仅通过BundleName和AbilityName无法区分时，可以通过设置moduleName加以区分，以匹配到指定的Ability。 | |
| moduleName<sup>9+</sup> | 只读 | string | 否 | 表示待启动的Ability所属的模块（module）。 |
**示例：**
``` js
var want = {
"deviceId": "", // deviceId为空表示本设备
"bundleName": "com.extreme.test",
"abilityName": "MainAbility",
"moduleName": "entry" // moduleName非必选
};
this.context.startAbility(want, (error) => {
// 显式拉起Ability，通过bundleName、abilityName和moduleName可以唯一确定一个Ability
console.log("error.code = " + error.code)
})
```
zh-cn/application-dev/reference/apis/js-apis-bundle-ApplicationInfo.md
浏览文件 @ ccc7c3ae
# ApplicationInfo
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 7 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
应用程序信息
## ApplicationInfo
......@@ -41,4 +37,4 @@
| entityType<sup>8+</sup> | string | 是 | 否 | 应用程序的实体类型。 |
| fingerprint<sup>9+</sup> | string | 是 | 否 | 应用程序的签名证书指纹信息，即开发者申请的签名证书的sha256值。 |
| appDistributionType<sup>9+</sup> | string | 是 | 否 | 应用程序签名证书的分发类型，分为：app_gallery、enterprise、os_integration和crowdtesting。 |
| appProvisionType<sup>9+</sup> | string | 是 | 否 | 应用程序签名证书文件的类型，分为debug和release两种类型。|
\ No newline at end of file
| appProvisionType<sup>9+</sup> | string | 是 | 否 | 应用程序签名证书文件的类型，分为debug和release两种类型。|
zh-cn/application-dev/reference/apis/js-apis-bytrace.md
浏览文件 @ ccc7c3ae
......@@ -6,15 +6,12 @@
> - 从API Version 8开始，该接口不再维护，推荐使用新接口[`@ohos.hiTraceMeter`](js-apis-hitracemeter.md)。
> - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```
```js
import bytrace from '@ohos.bytrace';
```
## bytrace.startTrace
startTrace(name: string, taskId: number, expectedTime?: number): void
......@@ -36,12 +33,11 @@ startTrace(name: string, taskId: number, expectedTime?: number): void
**示例：**
```
```js
bytrace.startTrace("myTestFunc", 1);
bytrace.startTrace("myTestFunc", 1, 5); // 从startTrace到finishTrace流程的期望耗时为5ms
```
## bytrace.finishTrace
finishTrace(name: string, taskId: number): void
......@@ -62,7 +58,7 @@ finishTrace(name: string, taskId: number): void
**示例：**
```
```js
bytrace.finishTrace("myTestFunc", 1);
```
......@@ -88,7 +84,6 @@ bytrace.startTrace("myTestFunc", 1); // 第二个跟踪任务开始，同名
bytrace.finishTrace("myTestFunc", 1);
```
## bytrace.traceByValue
traceByValue(name: string, count: number): void
......@@ -105,7 +100,7 @@ traceByValue(name: string, count: number): void
**示例：**
```
```js
let traceCount = 3;
bytrace.traceByValue("myTestCount", traceCount);
traceCount = 4;
......
zh-cn/application-dev/reference/apis/js-apis-display.md
浏览文件 @ ccc7c3ae
......@@ -185,7 +185,7 @@ on(type: 'add'|'remove'|'change', callback: Callback&lt;number&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 监听事件。<br/>-&nbsp;type为"add"，表示增加显示设备事件。<br/>-&nbsp;type为"remove"，表示移除显示设备事件。<br/>-&nbsp;type为"change"，表示改变显示设备事件。 |
| type | string | 是 | 监听事件。<br/>- type为"add"，表示增加显示设备事件。<br/>- type为"remove"，表示移除显示设备事件。<br/>- type为"change"，表示改变显示设备事件。 |
| callback | Callback&lt;number&gt; | 是 | 回调函数。返回监听到的显示设备的id。 |
**示例：**
......@@ -208,7 +208,7 @@ off(type: 'add'|'remove'|'change', callback?: Callback&lt;number&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| type | string | 是 | 设置监听类型。<br/>-&nbsp;type为"add"，表示监听增加显示设备。<br/>-&nbsp;type为"remove"，表示监听移除显示设备。<br/>-&nbsp;type为"change"，表示监听改变显示设备。 |
| type | string | 是 | 监听事件。<br/>- type为"add"，表示增加显示设备事件。<br/>- type为"remove"，表示移除显示设备事件。<br/>- type为"change"，表示改变显示设备事件。 |
| callback | Callback&lt;number&gt; | 否 | 回调函数。返回监听到的显示设备的id。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md 0 → 100755
浏览文件 @ ccc7c3ae
# distributedMissionManager
distributedMissionManager模块提供跨设备系统任务管理能力，包括注册系统任务状态监听、取消系统任务状态监听、开始同步远端任务列表、停止同步远端任务列表操作。
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```
import distributedMissionManager from '@ohos.distributedMissionManager'
```
## 权限列表
ohos.permission.MANAGE_MISSIONS
## distributedMissionManager.registerMissionListener
registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback, callback: AsyncCallback&lt;void&gt;): void;
注册系统任务状态监听，以回调函数的方式返回。
**需要权限**：ohos.permission.MANAGE_MISSIONS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | <a href="#missiondeviceinfo">MissionDeviceInfo</a> | 是 | 注册监听设备信息。 |
| options | <a href="#missioncallback">MissionCallback</a> | 是 | 注册的回调方法。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
**示例：**
```ts
function NotifyMissionsChanged(deviceId) {
console.log('NotifyMissionsChanged deviceId ' + JSON.stringify(deviceId));
}
function NotifySnapshot(deviceId, missionId) {
console.log('NotifySnapshot deviceId ' + JSON.stringify(deviceId));
console.log('NotifySnapshot missionId ' + JSON.stringify(missionId));
}
function NotifyNetDisconnect(deviceId, state) {
console.log('NotifyNetDisconnect deviceId ' + JSON.stringify(deviceId));
console.log('NotifyNetDisconnect state ' + JSON.stringify(state));
}
var parameter = {
deviceId: remoteDeviceId
};
var options = {
notifyMissionsChanged: NotifyMissionsChanged,
notifySnapshot: NotifySnapshot,
notifyNetDisconnect: NotifyNetDisconnect
}
distributedMissionManager.registerMissionListener(parameter, options, (error) => {
console.log("error.code = " + error.code)
})
```
## distributedMissionManager.registerMissionListener
registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback): Promise&lt;void&gt;
注册系统任务状态监听，以promise的方式返回。
**需要权限**：ohos.permission.MANAGE_MISSIONS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | <a href="#missiondeviceinfo">MissionDeviceInfo</a> | 是 | 设备信息。 |
| options | <a href="#missioncallback">MissionCallback</a> | 是 | 注册的回调方法。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | promise方式返回执行结果。 |
**示例：**
```ts
function NotifyMissionsChanged(deviceId) {
console.log('NotifyMissionsChanged deviceId ' + JSON.stringify(deviceId));
}
function NotifySnapshot(deviceId, missionId) {
console.log('NotifySnapshot deviceId ' + JSON.stringify(deviceId));
console.log('NotifySnapshot missionId ' + JSON.stringify(missionId));
}
function NotifyNetDisconnect(deviceId, state) {
console.log('NotifyNetDisconnect deviceId ' + JSON.stringify(deviceId));
console.log('NotifyNetDisconnect state ' + JSON.stringify(state));
}
var parameter = {
deviceId: remoteDeviceId
};
var options = {
notifyMissionsChanged: NotifyMissionsChanged,
notifySnapshot: NotifySnapshot,
notifyNetDisconnect: NotifyNetDisconnect
}
distributedMissionManager.registerMissionListener(parameter, options)
.then(data => {
console.info('success data is ' + data);
}).catch(error => {
console.info('error error is ' + error);
})
```
## distributedMissionManager.unregisterMissionListener
unregisterMissionListener(parameter: MissionDeviceInfo, callback: AsyncCallback&lt;void&gt;): void;
取消任务状态监听, 以回调函数的方式返回。
**需要权限**：ohos.permission.MANAGE_MISSIONS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| listenerId | number | 是 | 系统任务状态监听方法的index值，和监听方法一一对应，由registerMissionListener方法返回。 |
| parameter | <a href="#missiondeviceinfo">MissionDeviceInfo</a> | 是 | 设备信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
**示例：**
```ts
var parameter = {
deviceId: remoteDeviceId
};
distributedMissionManager.unregisterMissionListener(parameter, (error) => {
console.log("error.code = " + error.code)
})
```
## distributedMissionManager.unregisterMissionListener
unregisterMissionListener(parameter: MissionDeviceInfo): Promise&lt;void&gt;
取消任务状态监听，以promise方式返回执行结果。
**需要权限**：ohos.permission.MANAGE_MISSIONS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | <a href="#missiondeviceinfo">MissionDeviceInfo</a> | 是 | 设备信息。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | promise方式返回执行结果。 |
**示例：**
```ts
var parameter = {
deviceId: remoteDeviceId
};
distributedMissionManager.unregisterMissionListener(parameter)
.then(data => {
console.info('success data is ' + data);
}).catch(error => {
console.info('error error is ' + error);
})
```
## distributedMissionManager.startSyncRemoteMissions
startSyncRemoteMissions(parameter: MissionParameter, callback: AsyncCallback&lt;void&gt;): void;
开始同步远端任务列表, 以回调函数的方式返回。
**需要权限**：ohos.permission.MANAGE_MISSIONS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| listenerId | number | 是 | 系统任务状态监听方法的index值，和监听方法一一对应，由registerMissionListener方法返回。 |
| parameter | <a href="#missionparameter">MissionParameter</a> | 是 | 同步信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
**示例：**
```ts
var parameter = {
deviceId: remoteDeviceId,
fixConflict: false,
tag: 0
};
distributedMissionManager.startSyncRemoteMissions(parameter, (error) => {
console.log("error.code = " + error.code)
})
```
## distributedMissionManager.startSyncRemoteMissions
startSyncRemoteMissions(parameter: MissionParameter): Promise&lt;void&gt;
开始同步远端任务列表，以promise方式返回执行结果。
**需要权限**：ohos.permission.MANAGE_MISSIONS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | <a href="#missionparameter">MissionParameter</a> | 是 | 同步信息。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | promise方式返回执行结果。 |
**示例：**
```ts
var parameter = {
deviceId: remoteDeviceId,
fixConflict: false,
tag: 0
};
distributedMissionManager.startSyncRemoteMissions(parameter)
.then(data => {
console.info('success data is ' + data);
}).catch(error => {
console.info('error error is ' + error);
})
```
## distributedMissionManager.stopSyncRemoteMissions
stopSyncRemoteMissions(parameter: MissionDeviceInfo, callback: AsyncCallback&lt;void&gt;): void;
停止同步远端任务列表, 以回调函数的方式返回。
**需要权限**：ohos.permission.MANAGE_MISSIONS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| listenerId | number | 是 | 系统任务状态监听方法的index值，和监听方法一一对应，由registerMissionListener方法返回。 |
| parameter | <a href="#missiondeviceinfo">MissionDeviceInfo</a> | 是 | 同步信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 执行结果回调函数。 |
**示例：**
```ts
var parameter = {
deviceId: remoteDeviceId
};
distributedMissionManager.stopSyncRemoteMissions(parameter, (error) => {
console.log("error.code = " + error.code)
})
```
## distributedMissionManager.stopSyncRemoteMissions
stopSyncRemoteMissions(parameter: MissionDeviceInfo): Promise&lt;void&gt;
停止同步远端任务列表，以promise方式返回执行结果。
**需要权限**：ohos.permission.MANAGE_MISSIONS
**系统能力**：SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter | <a href="#missiondeviceinfo">MissionDeviceInfo</a> | 是 | 同步信息。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | promise方式返回执行结果。 |
**示例：**
```ts
var parameter = {
deviceId: remoteDeviceId
};
distributedMissionManager.stopSyncRemoteMissions(parameter)
.then(data => {
console.info('success data is ' + data);
}).catch(error => {
console.info('error error is ' + error);
})
```
## <a id ="missioncallback">MissionCallback</a>
表示开始同步后，建立的回调函数。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| notifyMissionsChanged | function | 是 | 否 | 通知任务变化，返回设备ID。|
| notifySnapshot | function | 是 | 否 | 通知快照变化，返回设备ID，任务ID |
| notifyNetDisconnect | function | 是 | 否 | 通知断开连接，返回设备ID，网络状态 |
## <a id ="missionparameter">MissionParameter</a>
表示同步时所需参数的枚举。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口，三方应用不支持调用。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 是 | 表示设备ID。|
| fixConflict | boolean | 是 | 是 | 表示是否存在版本冲突。 |
| tag | number | 是 | 是 | 表示特定的标签。 |
## <a id ="missiondeviceinfo">MissionDeviceInfo</a>
表示注册监听时所需参数的枚举。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Mission
**系统API**: 此接口为系统接口，三方应用不支持调用。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 是 | 表示设备ID。|
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-effectKit.md
浏览文件 @ ccc7c3ae
......@@ -5,6 +5,7 @@
该模块提供以下图像效果相关的常用功能：
- [Filter](#filter)：效果链。
- [Color](#color)：颜色类，用于保存取色的结果。
- [ColorPicker](#colorpicker)：智能取色器。
> **说明：**
......@@ -52,7 +53,7 @@ image.createPixelMap(color, opts)
createColorPicker(source: image.PixelMap): Promise\<ColorPicker>
通过属性创建PixelMap，使用Promise异步回调。
通过传入的PixelMap创建ColorPicker实例，使用Promise异步回调。
**系统能力：** SystemCapability.Multimedia.Image.Core
......@@ -60,13 +61,13 @@ createColorPicker(source: image.PixelMap): Promise\<ColorPicker>
| 名称 | 类型 | 必填 | 说明 |
| -------- | ----------- | ---- | -------------------------- |
| source | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | image模块创建的PixelMap实例 |
| source | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | image模块创建的PixelMap实例。 |
**返回值：**
| 类型 | 说明 |
| ---------------------- | -------------- |
| Promisse\<[ColorPicker](#colorpicker)> | Promise对象。返回当前创建的子窗口对象。 |
| Promisse\<[ColorPicker](#colorpicker)> | Promise对象。返回创建的ColorPicker实例。 |
**示例：**
......@@ -87,7 +88,7 @@ image.createPixelMap(color, opts, (pixelmap) => {
createColorPicker(source: image.PixelMap, callback: AsyncCallback\<ColorPicker>): void
通过属性创建PixelMap，使用callback异步回调。
通过传入的PixelMap创建ColorPicker实例，使用callback异步回调。
**系统能力：** SystemCapability.Multimedia.Image.Core
......@@ -95,8 +96,8 @@ createColorPicker(source: image.PixelMap, callback: AsyncCallback\<ColorPicker>)
| 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------ | ---- | -------------------------- |
| source | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | BGRA_8888格式的颜色数组。 |
| callback | AsyncCallback\<[ColorPicker](#colorpicker)> | 是 | 回调函数，返回ColorPicker。 |
| source | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 |image模块创建的PixelMap实例。 |
| callback | AsyncCallback\<[ColorPicker](#colorpicker)> | 是 | 回调函数。返回创建的ColorPicker实例。 |
**示例：**
......@@ -107,9 +108,9 @@ let opts = { editable: true, pixelFormat: 3, size: { height: 4, width: 6 } }
image.createPixelMap(color, opts, (pixelmap) => {
effectKit.createColorPicker(pixelMap, (error, colorPicker) ) {
if(error) {
console.log('create color picker failed.');
console.log('Failed to create color picker.');
} else {
console.log('create color picker succeeded.');
console.log('Succeeded in creating color picker.');
}
})
})
......@@ -144,16 +145,16 @@ getMainColor(): Promise\<Color>
| 类型 | 说明 |
| :------------- | :---------------------------------------------- |
| Promise\<[Color](#color)> | Promise实例，用于获取结果，失败时返回错误信息。 |
| Promise\<[Color](#color)> | Promise对象。返回图像主色对应的颜色值，失败时返回错误信息。 |
**示例：**
```js
colorPicker.getMainColor().then(color => {
console.log('get main color succeeded.')
console.log('Succeeded in getting main color.')
console.info("color[ARGB]=" + color.alpha "," + color.red + "," + color.green + "," + color.blue);
}).catch(error => {
console.log('get main color failed.');
console.log('Failed to get main color.');
})
```
......@@ -169,7 +170,7 @@ getMainColorSync(): Color
| 类型 | 说明 |
| :------- | :----------------------------------- |
| [Color](#color) | Color实例，用于获取结果，失败时返回null。 |
| [Color](#color) | Color实例，即图像主色对应的颜色值，失败时返回null。 |
**示例：**
......@@ -266,7 +267,7 @@ grayscale(): Filter
| 类型 | 说明 |
| :------------- | :---------------------------------------------- |
| Filter | 返回效果链表头。 |
| [Filter](#filter) | 返回效果链表头。 |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-environment.md
浏览文件 @ ccc7c3ae
# 目录环境能力
该模块提供环境目录能力，获取内存存储根目录、公共文件根目录的JS接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
>
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 本模块接口为系统接口，三方应用不支持调用。
该模块提供环境目录能力，获取内存存储根目录、公共文件根目录的JS接口。
## 导入模块
```js
......
zh-cn/application-dev/reference/apis/js-apis-fileio.md
浏览文件 @ ccc7c3ae
# 文件管理
该模块提供文件存储管理能力，包括文件基本管理、文件目录管理、文件信息统计、文件流式读写等常用功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
该模块提供文件存储管理能力，包括文件基本管理、文件目录管理、文件信息统计、文件流式读写等常用功能。
## 导入模块
......
zh-cn/application-dev/reference/apis/js-apis-filemanager.md
浏览文件 @ ccc7c3ae
# 公共文件访问与管理
该模块提供公共文件访问和管理的服务接口，向下对接底层文件管理服务，如媒体库、外卡管理；向上对应用程序提供公共文件查询、创建的能力。
>![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
>
>- 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>- 本模块接口为系统接口，三方应用不支持调用，当前只支持filepicker调用。
该模块提供公共文件访问和管理的服务接口，向下对接底层文件管理服务，如媒体库、外卡管理；向上对应用程序提供公共文件查询、创建的能力。
## 导入模块
```js
......
zh-cn/application-dev/reference/apis/js-apis-media.md
浏览文件 @ ccc7c3ae
......@@ -1333,7 +1333,7 @@ videoPlayer.setSpeed(speed).then() => {
selectBitrate(bitrate:number, callback: AsyncCallback\<number>): void
通过回调方式设置码率。
通过回调方式设置码率，通过[availableBitrateCollected](#on('availableBitrateCollected')<sup>9+</sup>)获取当前码流支持的Bitrate。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
......@@ -1392,7 +1392,7 @@ videoPlayer.selectBitrate(bitrate).then() => {
on(type: 'playbackCompleted', callback: Callback\<void>): void
开始监听视频播放完成事件，通过[availableBitrateCollected](#on('availableBitrateCollected')<sup>9+</sup>)获取当前码流支持的Bitrate。
开始监听视频播放完成事件。
**系统能力：** SystemCapability.Multimedia.Media.VideoPlayer
......@@ -1521,7 +1521,7 @@ on(type: 'availableBitrateCollected', callback: (bitrates: Array<number>) => voi
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | ---- | ------------------------------------------------------------ |
| type | string | 是 | 视频播放码率上报事件回调类型，支持的事件：'availableBitrateCollected'，只在开始播放时候上报一次 |
| callback | function | 是 | 视频播放码率事件回调方法，使用Array数组存放支持的码率。 |
| callback | function | 是 | 视频播放码率事件回调方法，使用数组存放支持的码率。 |
**示例：**
......@@ -1875,7 +1875,7 @@ audioRecorder.prepare(); // pre
## AudioOutputFormat<sup>(deprecated)</sup>
> **说明：**
> 从 API Version 8 开始废弃，建议使用[ContainerFormatType ](#containerformattype8)替代。
> 从 API Version 8 开始废弃，建议使用[ContainerFormatType](#containerformattype8)替代。
表示音频封装格式的枚举。
......
zh-cn/application-dev/reference/apis/js-apis-request.md
浏览文件 @ ccc7c3ae
# 上传下载
request部件主要给应用提供上传下载文件、后台传输代理的基础能力。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
......@@ -18,14 +19,16 @@ import request from '@ohos.request';
默认支持https，如果要支持http，需要在config.json里增加network标签，属性标识 "cleartextTraffic": true。即：
```
var config = {
"deviceConfig": {
"default": {
"network": {
"cleartextTraffic": true
}
...
//...
}
}
}
```
......@@ -466,11 +469,10 @@ on(type: 'progress', callback:(receivedSize: number, totalSize: number) =&gt; vo
**示例：**
```js
downloadTask.on('progress', function download_callback(receivedSize, totalSize) {
downloadTask.on('progress', function download_callback(receivedSize, totalSize) {
console.info("download receivedSize:" + receivedSize + " totalSize:" + totalSize);
}
);
});
```
......@@ -501,11 +503,10 @@ off(type: 'progress', callback?: (receivedSize: number, totalSize: number) =&gt;
**示例：**
```js
downloadTask .off('progress', function download_callback(receivedSize, totalSize) {
console.info("download receivedSize:" + receivedSize + " totalSize:" + totalSize);
}
downloadTask .off('progress', function download_callback(receivedSize, totalSize) {
console.info("download receivedSize:" + receivedSize + " totalSize:" + totalSize);
}
);
});
```
......@@ -529,11 +530,10 @@ on(type: 'complete'|'pause'|'remove', callback:() =&gt; void): void
**示例：**
```js
downloadTask.on('complete', function callback() {
console.info('Download task completed.');
}
downloadTask.on('complete', function callback() {
console.info('Download task completed.');
}
);
});
```
......@@ -557,11 +557,10 @@ off(type: 'complete'|'pause'|'remove', callback?:() =&gt; void): void
**示例：**
```js
downloadTask.off('complete', function callback() {
console.info('Download task completed.');
}
downloadTask.off('complete', function callback() {
console.info('Download task completed.');
}
);
});
```
......@@ -591,11 +590,10 @@ on(type: 'fail', callback: (err: number) =&gt; void): void
**示例：**
```js
downloadTask.on('fail', function callBack(err) {
console.info('Download task failed. Cause:' + err);
}
downloadTask.on('fail', function callBack(err) {
console.info('Download task failed. Cause:' + err);
}
);
});
```
......@@ -625,11 +623,10 @@ off(type: 'fail', callback?: (err: number) =&gt; void): void
**示例：**
```js
downloadTask.off('fail', function callBack(err) {
console.info('Download task failed. Cause:' + err);
}
downloadTask.off('fail', function callBack(err) {
console.info('Download task failed. Cause:' + err);
}
);
});
```
......
zh-cn/application-dev/reference/apis/js-apis-resource-manager.md
浏览文件 @ ccc7c3ae
......@@ -238,6 +238,18 @@ resourceManager.getResourceManager((error, mgr) => {
| offset | number | rawfile的起始偏移量 |
| length | number | rawfile的文件长度 |
## Resource
表示的资源信息。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
| 名称 | 类型 | 说明 |
| ------ | ------ | ------------------ |
| bundleName | string | 应用的bundle名称 |
| moduleName | string | 应用的module名称 |
| id | number | 资源的id值 |
## ResourceManager
......@@ -307,6 +319,68 @@ getString(resId: number): Promise&lt;string&gt;
```
### getString<sup>9+</sup>
getString(resource: Resource, callback: AsyncCallback&lt;string&gt;): void
用户获取指定resource对象对应的字符串，使用callback形式返回字符串。
**系统能力**：SystemCapability.Global.ResourceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------- |
| resource | [Resource](#resource) | 是 | 资源信息 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调，用于返回获取的字符串 |
**示例：**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.string.test').id
};
this.context.resourceManager.getString(resource, (error, value) => {
if (error != null) {
console.log("error is " + error);
} else {
let str = value;
}
});
```
### getString<sup>9+</sup>
getString(resource: Resource): Promise&lt;string&gt;
用户获取指定resource对象对应的字符串，使用Promise形式返回字符串。
**系统能力**：SystemCapability.Global.ResourceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| resource | [Resource](#resource) | 是 | 资源信息 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| Promise&lt;string&gt; | resource对象对应的字符串 |
**示例：**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.string.test').id
};
this.context.resourceManager.getString(resource).then(value => {
let str = value;
}).catch(error => {
console.log("getstring promise error is " + error);
});
```
### getStringArray
getStringArray(resId: number, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
......@@ -364,6 +438,67 @@ getStringArray(resId: number): Promise&lt;Array&lt;string&gt;&gt;
});
```
### getStringArray<sup>9+</sup>
getStringArray(resource: Resource, callback: AsyncCallback&lt;Array&lt;string&gt;&gt;): void
用户获取指定resource对象对应的字符串数组，使用callback形式返回回字符串数组。
**系统能力**：SystemCapability.Global.ResourceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------- |
| resource | [Resource](#resource) | 是 | 资源信息 |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 异步回调，用于返回获取的字符串数组 |
**示例：**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.strarray.test').id
};
this.context.resourceManager.getStringArray(resource, (error, value) => {
if (error != null) {
console.log("error is " + error);
} else {
let strArray = value;
}
});
```
### getStringArray<sup>9+</sup>
getStringArray(resource: Resource): Promise&lt;Array&lt;string&gt;&gt;
用户获取指定resource对象对应的字符串数组，使用Promise形式返回字符串数组。
**系统能力**：SystemCapability.Global.ResourceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| resource | [Resource](#resource) | 是 | 资源信息 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| Promise&lt;Array&lt;string&gt;&gt; | resource对象对应的字符串数组 |
**示例：**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.strarray.test').id
};
this.context.resourceManager.getStringArray(resource).then(value => {
let strArray = value;
}).catch(error => {
console.log("getStringArray promise error is " + error);
});
```
### getMedia
......@@ -422,6 +557,67 @@ getMedia(resId: number): Promise&lt;Uint8Array&gt;
});
```
### getMedia<sup>9+</sup>
getMedia(resource: Resource, callback: AsyncCallback&lt;Uint8Array&gt;): void
用户获取指定resource对象对应的媒体文件内容，使用callback形式返回字节数组。
**系统能力**：SystemCapability.Global.ResourceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------- |
| resource | [Resource](#resource) | 是 | 资源信息 |
| callback | AsyncCallback&lt;Uint8Array&gt; | 是 | 异步回调，用于返回获取的媒体文件内容 |
**示例：**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.media.test').id
};
this.context.resourceManager.getMedia(resource, (error, value) => {
if (error != null) {
console.log("error is " + error);
} else {
let media = value;
}
});
```
### getMedia<sup>9+</sup>
getMedia(resource: Resource): Promise&lt;Uint8Array&gt;
用户获取指定resource对象对应的媒体文件内容，使用Promise形式返回字节数组。
**系统能力**：SystemCapability.Global.ResourceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| resource | [Resource](#resource) | 是 | 资源信息 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| Promise&lt;Uint8Array&gt; | resource对象对应的媒体文件内容 |
**示例：**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.media.test').id
};
this.context.resourceManager.getMedia(resource).then(value => {
let media = value;
}).catch(error => {
console.log("getMedia promise error is " + error);
});
```
### getMediaBase64
......@@ -480,6 +676,68 @@ getMediaBase64(resId: number): Promise&lt;string&gt;
});
```
### getMediaBase64<sup>9+</sup>
getMediaBase64(resource: Resource, callback: AsyncCallback&lt;string&gt;): void
用户获取指定resource对象对应的图片资源Base64编码，使用callback形式返回字符串。
**系统能力**：SystemCapability.Global.ResourceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------ |
| resource | [Resource](#resource) | 是 | 资源信息 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调，用于返回获取的图片资源Base64编码 |
**示例：**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.media.test').id
};
this.context.resourceManager.getMediaBase64(resource, (error, value) => {
if (error != null) {
console.log("error is " + error);
} else {
let media = value;
}
});
```
### getMediaBase64<sup>9+</sup>
getMediaBase64(resource: Resource): Promise&lt;string&gt;
用户获取指定resource对象对应的图片资源Base64编码，使用Promise形式返回字符串。
**系统能力**：SystemCapability.Global.ResourceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| resource | [Resource](#resource) | 是 | 资源信息 |
**返回值：**
| 类型 | 说明 |
| --------------------- | -------------------- |
| Promise&lt;string&gt; | resource对象对应的图片资源Base64编码 |
**示例：**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.media.test').id
};
this.context.resourceManager.getMediaBase64(resource).then(value => {
let media = value;
}).catch(error => {
console.log("getMediaBase64 promise error is " + error);
});
```
### getConfiguration
......@@ -648,6 +906,70 @@ getPluralString(resId: number, num: number): Promise&lt;string&gt;
});
```
### getPluralString<sup>9+</sup>
getPluralString(resource: Resource, num: number, callback: AsyncCallback&lt;string&gt;): void
根据指定数量获取指定resource对象表示的单复数字符串，使用callback形式返回字符串。
**系统能力**：SystemCapability.Global.ResourceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------- |
| resource | [Resource](#resource) | 是 | 资源信息 |
| num | number | 是 | 数量值 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步回调，返回根据指定数量获取指定resource对象表示的单复数字符串 |
**示例：**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.plural.test').id
};
this.context.resourceManager.getPluralString(resource, 1, (error, value) => {
if (error != null) {
console.log("error is " + error);
} else {
let str = value;
}
});
```
### getPluralString<sup>9+</sup>
getPluralString(resource: Resource, num: number): Promise&lt;string&gt;
根据指定数量获取对指定resource对象表示的单复数字符串，使用Promise形式返回字符串。
**系统能力**：SystemCapability.Global.ResourceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| resource | [Resource](#resource) | 是 | 资源信息 |
| num | number | 是 | 数量值 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------------------- |
| Promise&lt;string&gt; | 根据提供的数量获取对应resource对象表示的单复数字符串 |
**示例：**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.plural.test').id
};
this.context.resourceManager.getPluralString(resource, 1).then(value => {
let str = value;
}).catch(error => {
console.log("getPluralString promise error is " + error);
});
```
### getRawFile<sup>8+</sup>
getRawFile(path: string, callback: AsyncCallback&lt;Uint8Array&gt;): void
......@@ -1118,6 +1440,34 @@ getStringSync(resId: number): string
resourceManager.getStringSync($r('app.string.test').id);
```
### getStringSync<sup>9+</sup>
getStringSync(resource: Resource): string
用户获取指定resource对象对应的字符串，使用同步方式返回字符串。
**系统能力**：SystemCapability.Global.ResourceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| resource | [Resource](#resource) | 是 | 资源信息 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| string | resource对象对应的字符串 |
**示例：**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.string.test').id
};
this.context.resourceManager.getStringSync(resource);
```
### getStringByNameSync<sup>9+</sup>
getStringByNameSync(resName: string): string
......@@ -1163,6 +1513,33 @@ getBoolean(resId: number): boolean
```
resourceManager.getBoolean($r('app.boolean.boolean_test').id);
```
### getBoolean<sup>9+</sup>
getBoolean(resource: Resource): boolean
使用同步方式，返回获取指定resource对象对应的布尔结果。
**系统能力**：SystemCapability.Global.ResourceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| resource | [Resource](#resource) | 是 | 资源信息 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| boolean | resource对象对应的布尔结果 |
**示例：**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.boolean.boolean_test').id
};
this.context.resourceManager.getBoolean(resource);
```
### getBooleanByName<sup>9+</sup>
......@@ -1211,6 +1588,34 @@ getNumber(resId: number): number
resourceManager.getNumber($r('app.float.float_test').id);
```
### getNumber<sup>9+</sup>
getNumber(resource: Resource): number
用户获取指定resource对象对应的integer数值或者float数值，使用同步方式返回资源对应的数值。
**系统能力**：SystemCapability.Global.ResourceManager
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| resource | [Resource](#resource) | 是 | 资源信息 |
**返回值：**
| 类型 | 说明 |
| --------------------- | ----------- |
| number | resource对象对应的数值 |
**示例：**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.integer.integer_test').id
};
this.context.resourceManager.getNumber(resource);
```
### getNumberByName<sup>9+</sup>
getNumberByName(resName: string): number
......
zh-cn/application-dev/reference/apis/js-apis-router.md
浏览文件 @ ccc7c3ae
......@@ -29,6 +29,7 @@ push(options: RouterOptions): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| options | [RouterOptions](#routeroptions) | 是 | 跳转页面描述信息。 |
| mode<sup>9+</sup> | [RouterMode](#routermode9) | 否 | 跳转页面使用的模式。 |
**示例：**
......@@ -77,6 +78,7 @@ replace(options: RouterOptions): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| options | [RouterOptions](#routeroptions) | 是 | 替换页面描述信息。 |
| mode<sup>9+</sup> | [RouterMode](#routermode9) | 否 | 跳转页面使用的模式。 |
**示例：**
......@@ -89,7 +91,7 @@ replace(options: RouterOptions): void
params: {
data1: 'message',
},
});
}, router.RouterMode.Standard);
}
}
```
......@@ -438,3 +440,13 @@ getParams(): Object
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 页面路由栈支持的最大Page数量为32。
## RouterMode<sup>9+</sup>
路由跳转模式。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.ArkUI.ArkUI.Lite。
| 名称 | 描述 |
| -------- | -------- |
| Standard | 标准模式。 |
| Single | 单实例模式。<br/>如果目标页面的url在页面栈中已经存在同url页面，离栈顶最近的页面会被移动到栈顶，移动后的页面为新建页。<br/>如目标页面的url在页面栈中不存在同url页面，按标准模式跳转。 |
zh-cn/application-dev/reference/apis/js-apis-securityLabel.md
浏览文件 @ ccc7c3ae
# 数据标签
该模块提供文件数据安全等级的相关功能：向应用程序提供查询、设置文件数据安全等级的JS接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
该模块提供文件数据安全等级的相关功能：向应用程序提供查询、设置文件数据安全等级的JS接口。
## 导入模块
```js
......
zh-cn/application-dev/reference/apis/js-apis-statfs.md
浏览文件 @ ccc7c3ae
# statfs
该模块提供文件系统相关存储信息的功能，向应用程序提供获取文件系统总字节数、空闲字节数的JS接口。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
该模块提供文件系统相关存储信息的功能，向应用程序提供获取文件系统总字节数、空闲字节数的JS接口。
## 导入模块
```js
......
zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md
浏览文件 @ ccc7c3ae
# 应用空间统计
该模块提供空间查询相关的常用功能：包括对内外卡的空间查询，对应用分类数据统计的查询，对应用数据的查询等。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
>
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - API 9当前为Canary版本，仅供试用，不保证接口可稳定调用。
该模块提供空间查询相关的常用功能：包括对内外卡的空间查询，对应用分类数据统计的查询，对应用数据的查询等。
## 导入模块
```js
......
zh-cn/application-dev/reference/apis/js-apis-usb.md
浏览文件 @ ccc7c3ae
# USB管理
本模块主要提供管理USB设备的相关功能，包括查询USB设备列表、批量数据传输、控制命令传输、权限控制等。
> **说明：**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
......
zh-cn/application-dev/reference/apis/js-apis-volumemanager.md
浏览文件 @ ccc7c3ae
# 卷管理
该模块提供卷、磁盘查询和管理的相关功能：包括查询卷信息，对卷的挂载卸载、对磁盘分区以及卷的格式化等功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
>
> - 本模块首批接口从API version 9开始支持。
> - API 9当前为Canary版本，仅供试用，不保证接口可稳定调用。
> - 本模块接口为系统接口，三方应用不支持调用。
该模块提供卷、磁盘查询和管理的相关功能：包括查询卷信息，对卷的挂载卸载、对磁盘分区以及卷的格式化等功能。
## 导入模块
```js
......
zh-cn/application-dev/reference/arkui-js/js-appendix-types.md
浏览文件 @ ccc7c3ae
......@@ -12,7 +12,7 @@
| 名称 | 类型定义 | 描述 |
| ----- | --------------------- | ---------------------------------------- |
| color | string&nbsp;\|颜色枚举字符串 | 用于描述颜色信息，JS脚本中不支持颜色枚举格式。<br/>字符串格式如下：<br/>-&nbsp;'rgb(255,&nbsp;255,&nbsp;255)'<br/>-&nbsp;'rgba(255,&nbsp;255,&nbsp;255,&nbsp;1.0)'<br/>-&nbsp;HEX格式：'\#rrggbb'，'\#aarrggbb'<br/>-&nbsp;枚举格式：'black'，'white'。 |
| color | string&nbsp;\|&nbsp;颜色枚举字符串 | 用于描述颜色信息，JS脚本中不支持颜色枚举格式。<br/>字符串格式如下：<br/>-&nbsp;'rgb(255,&nbsp;255,&nbsp;255)'<br/>-&nbsp;'rgba(255,&nbsp;255,&nbsp;255,&nbsp;1.0)'<br/>-&nbsp;HEX格式：'\#rrggbb'，'\#aarrggbb'<br/>-&nbsp;枚举格式：'black'，'white'。 |
**表1** 当前支持的颜色枚举
......
zh-cn/application-dev/reference/arkui-js/js-components-basic-picker-view.md
浏览文件 @ ccc7c3ae
......@@ -70,7 +70,7 @@
| 名称 | 类型 | 默认值 | 必填 | 描述 |
| -------------------------------- | -------------- | ---------- | ---- | ---------------------------------------- |
| color | &lt;color&gt | \#ffffff | 否 | 候选项字体颜色。 |
| color | &lt;color&gt; | \#ffffff | 否 | 候选项字体颜色。 |
| font-size | &lt;length&gt; | 16px | 否 | 候选项字体尺寸，类型length，单位px。 |
| selected-color | &lt;color&gt; | #ff0a69f7 | 否 | 选中项字体颜色。 |
| selected-font-size | &lt;length&gt; | 20px | 否 | 选中项字体尺寸，类型length，单位px。 |
......
zh-cn/application-dev/reference/arkui-js/js-components-common-animation.md
浏览文件 @ ccc7c3ae
......@@ -14,7 +14,7 @@
| animation-name | string | - | 指定\@keyframes，详见表 @keyframes属性说明。 |
| animation-delay | &lt;time&gt; | 0 | 定义动画播放的延迟时间。支持的单位为[s(秒)\|ms(毫秒)&nbsp;]，默认单位为ms，格式为：1000ms或1s。 |
| animation-duration | &lt;time&gt; | 0 | 定义一个动画周期。支持的单位为[s(秒)\|ms(毫秒)&nbsp;]，默认单位为ms，格式为：1000ms或1s。<br/>必须设置animation-duration&nbsp;样式，否则时长为&nbsp;0将不会播放动画。 |
| animation-iteration-count | number&nbsp;&nbsp;\|&nbsp;infinite | 1 | 定义动画播放的次数，默认播放一次，可通过设置为infinite无限次播放。 |
| animation-iteration-count | number&nbsp;\|&nbsp;infinite | 1 | 定义动画播放的次数，默认播放一次，可通过设置为infinite无限次播放。 |
| animation-timing-function | string | ease<br/> | 描述动画执行的速度曲线，用于使动画更为平滑。<br/>可选项有：<br/>-&nbsp;linear：表示动画从头到尾的速度都是相同的。<br/>-&nbsp;ease：表示动画以低速开始，然后加快，在结束前变慢，cubic-bezier(0.25,&nbsp;0.1,&nbsp;0.25,&nbsp;1.0)。<br/>-&nbsp;ease-in：表示动画以低速开始，cubic-bezier(0.42,&nbsp;0.0,&nbsp;1.0,&nbsp;1.0)。<br/>-&nbsp;ease-out：表示动画以低速结束，cubic-bezier(0.0,&nbsp;0.0,&nbsp;0.58,&nbsp;1.0)。<br/>-&nbsp;ease-in-out：表示动画以低速开始和结束，cubic-bezier(0.42,&nbsp;0.0,&nbsp;0.58,&nbsp;1.0)。<br/>-&nbsp;friction：阻尼曲线，cubic-bezier(0.2,&nbsp;0.0,&nbsp;0.2,&nbsp;1.0)。<br/>-&nbsp;extreme-deceleration：急缓曲线，cubic-bezier(0.0,&nbsp;0.0,&nbsp;0.0,&nbsp;1.0)。<br/>-&nbsp;sharp：锐利曲线，cubic-bezier(0.33,&nbsp;0.0,&nbsp;0.67,&nbsp;1.0)。<br/>-&nbsp;rhythm：节奏曲线，cubic-bezier(0.7,&nbsp;0.0,&nbsp;0.2,&nbsp;1.0)。<br/>-&nbsp;smooth：平滑曲线，cubic-bezier(0.4,&nbsp;0.0,&nbsp;0.4,&nbsp;1.0)。<br/>-&nbsp;cubic-bezier：在三次贝塞尔函数中定义动画变化过程，入参的x和y值必须处于0-1之间。<br/>-&nbsp;steps:&nbsp;阶梯曲线<sup>6+</sup>。语法：steps(number[,&nbsp;end\|start])；number必须设置，支持的类型为正整数。第二个参数可选，表示在每个间隔的起点或是终点发生阶跃变化，支持设置end或start，默认值为end。 |
| animation-direction<sup>6+</sup> | string | normal | 指定动画的播放模式：<br/>-&nbsp;normal：&nbsp;动画正向循环播放。<br/>-&nbsp;reverse：&nbsp;动画反向循环播放。<br/>-&nbsp;alternate：动画交替循环播放，奇数次正向播放，偶数次反向播放。<br/>-&nbsp;alternate-reverse：动画反向交替循环播放，奇数次反向播放，偶数次正向播放。 |
| animation-fill-mode | string | none | 指定动画开始和结束的状态：<br/>-&nbsp;none：在动画执行之前和之后都不会应用任何样式到目标上。<br/>-&nbsp;forwards：在动画结束后，目标将保留动画结束时的状态（在最后一个关键帧中定义）。<br/>-&nbsp;backwards<sup>6+</sup>：动画将在animation-delay期间应用第一个关键帧中定义的值。当animation-direction为"normal"或"alternate"时应用from关键帧中的值，当animation-direction为"reverse"或"alternate-reverse"时应用to关键帧中的值。<br/>-&nbsp;both<sup>6+</sup>：动画将遵循forwards和backwards的规则，从而在两个方向上扩展动画属性。 |
......
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkbox.md
浏览文件 @ ccc7c3ae
......@@ -30,7 +30,7 @@ Checkbox( name?: string, group?: string )
| 名称 | 参数类型 | 默认值 | 描述 |
| ------------- | ------- | ------ | -------- |
| select | bool | false | 设置多选框是否选中。 |
| select | boolean | false | 设置多选框是否选中。 |
| selectedColor | Color | - | 设置多选框选中状态颜色。 |
## 事件
......
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-checkboxgroup.md
浏览文件 @ ccc7c3ae
......@@ -29,7 +29,7 @@ CheckboxGroup( group?: string )
| 名称 | 参数类型 | 默认值 | 描述 |
| -------- | -------- | -------- | -------- |
| selectAll | bool | false | 设置是否全选。 |
| selectAll | boolean | false | 设置是否全选。 |
| selectedColor | Color | - | 设置被选中或部分选中状态的颜色。 |
## 事件
......
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-image.md
浏览文件 @ ccc7c3ae
......@@ -166,8 +166,6 @@ struct ImageExample1 {
@Entry
@Component
struct ImageExample2 {
@State width: number = 100
@State height: number = 100
build() {
Column({ space: 10 }) {
......
zh-cn/application-dev/reference/arkui-ts/ts-basic-components-navigation.md
浏览文件 @ ccc7c3ae
......@@ -29,7 +29,7 @@ Navigation()
| 名称 | 参数类型 | 默认值 | 描述 |
| -------------- | ---------------------------------------- | ------------------------ | ---------------------------------------- |
| title | string&nbsp;\|&nbsp;[CustomBuilder](../../ui/ts-types.md) | - | 页面标题。 |
| subtitle | string | - | 页面副标题。 |
| subTitle | string | - | 页面副标题。 |
| menus | Array<NavigationMenuItem&gt;&nbsp;\|&nbsp;[CustomBuilder](../../ui/ts-types.md) | - | 页面右上角菜单。 |
| titleMode | NavigationTitleMode | NavigationTitleMode.Free | 页面标题栏显示模式。 |
| toolBar | {<br/>items:[<br/>Object<br/>]&nbsp;}<br/>\|&nbsp;[CustomBuilder](../../ui/ts-types.md) | - | 设置工具栏内容。<br/>items:&nbsp;工具栏所有项。 |
......
zh-cn/application-dev/reference/arkui-ts/ts-components-canvas-imagebitmap.md
浏览文件 @ ccc7c3ae
......@@ -4,13 +4,12 @@
> 从 API Version 8 开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
CanvasImageData对象可以存储canvas渲染的像素数据。
ImageBitmap对象可以存储canvas渲染的像素数据。
## 属性
| 属性 | 类型 | 描述 |
| -------- | -------- | -------- |
| width | number | 矩形区域实际像素宽度。 |
| height | number | 矩形区域实际像素高度。 |
| data | &lt;Uint8ClampedArray&gt; | 一维数组，保存了相应的颜色数据，数据值范围为0到255。 |
| width | number | ImageBitmap的像素宽度。 |
| height | number | ImageBitmap的像素高度。 |
zh-cn/application-dev/reference/arkui-ts/ts-container-grid.md
浏览文件 @ ccc7c3ae
......@@ -32,7 +32,7 @@ Grid()
| columnsGap | Length | 0 | 用于设置列与列的间距。 |
| rowsGap | Length | 0 | 用于设置行与行的间距。 |
| editMode<font color=ff0000><sup>8+</sup></font> | boolean | flase | 是否进入编辑模式，进入编辑模式可以拖拽Gird组件内部[GridItem](ts-container-griditem.md)。 |
| layoutDirection<font color=ff0000><sup>8+</sup></font> | [LayoutDirection](ts-appendix-enums.md) | LayoutDirection.Row |设置布局的主轴方向，目前支持的主轴布局方向如下：<br/>-&nbsp;LayoutDirection.Row：沿水平方向布局，即先填满一列，再去填下一列。 <br/>-&nbsp;LayoutDirection.Column：沿垂直方向布局，即先填满一行，再去填下一行。|
| layoutDirection<font color=ff0000><sup>8+</sup></font> | number | 0 |设置布局的主轴方向，目前支持的主轴布局方向如下：<br/>-&nbsp;0：主轴布局方向沿水平方向布局，即先填满一列，再去填下一列。 <br/>-&nbsp;1：主轴布局方向沿垂直方向布局，即先填满一行，再去填下一行。|
| maxCount<font color=ff0000><sup>8+</sup></font> | number | 1 | 当layoutDirection是Row时，表示可显示的最大行数<br/>当layoutDirection是Column时，表示可显示的最大列数。 |
| minCount<font color=ff0000><sup>8+</sup></font> | number | 1 | 当layoutDirection是Row时，表示可显示的最小行数<br/>当layoutDirection是Column时，表示可显示的最小列数。 |
| cellLength<font color=ff0000><sup>8+</sup></font> | number | 0 | 当layoutDirection是Row时，表示一行的高度<br/>当layoutDirection是Column时，表示一列的宽度。 |
......
zh-cn/application-dev/reference/arkui-ts/ts-container-list.md
浏览文件 @ ccc7c3ae
......@@ -19,13 +19,14 @@
## 接口
List(value:{space?: number, initialIndex?: number})
List(value:{space?: number | string, initialIndex?: number, scroller?: Scroller})
- 参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| space | number | 否 | 0 | 列表项间距。 |
| space | number&nbsp;\|&nbsp;string | 否 | 0 | 列表项间距。 |
| initialIndex | number | 否 | 0 | 设置当前List初次加载时视口起始位置显示的item，即显示第一个item，如设置的序号超过了最后一个item的序号，则设置不生效。 |
| scroller | [Scroller](ts-container-scroll.md#scroller) | 是 | - | 可滚动组件的控制器。用于与可滚动组件进行绑定。 |
## 属性
......
zh-cn/application-dev/reference/arkui-ts/ts-container-refresh.md
浏览文件 @ ccc7c3ae
......@@ -15,7 +15,7 @@
## 接口
Refresh\(value: \{refreshing: boolean, offset?: Length, friction?: number\}\)
Refresh\(value: \{refreshing: boolean, offset?: Length, friction?: number | string\}\)
- 参数
......@@ -23,7 +23,7 @@ Refresh\(value: \{refreshing: boolean, offset?: Length, friction?: number\}\)
| -------- | -------- | -------- | -------- | -------- |
| refreshing | boolean | 是 | - | 当前组件是否正在刷新。 |
| offset | Length | 否 | 16 | 刷新组件静止时距离父组件顶部的距离。|
| friction | number | 否 | 62 | 下拉摩擦系数，取值范围为0到100。<br/>-&nbsp;0表示下拉刷新容器不跟随手势下拉而下拉。<br/>-&nbsp;100表示下拉刷新容器紧紧跟随手势下拉而下拉。<br/>-&nbsp;数值越大，下拉刷新容器跟随手势下拉的反应越灵敏。 |
| friction | number&nbsp;\|&nbsp;string | 否 | 62 | 下拉摩擦系数，取值范围为0到100。<br/>-&nbsp;0表示下拉刷新容器不跟随手势下拉而下拉。<br/>-&nbsp;100表示下拉刷新容器紧紧跟随手势下拉而下拉。<br/>-&nbsp;数值越大，下拉刷新容器跟随手势下拉的反应越灵敏。 |
......
zh-cn/application-dev/reference/arkui-ts/ts-methods-alert-dialog-box.md
浏览文件 @ ccc7c3ae
......@@ -28,8 +28,8 @@
- paramObject2参数
| 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 |
| -------- | -------- | -------- | -------- | -------- |
| title | string&nbsp;\|&&nbsp;[Resource](../../ui/ts-types.md#resource类型) | 否 | - | 弹窗标题。 |
| message | string&nbsp;\|&&nbsp;[Resource](../../ui/ts-types.md#resource类型) | 是 | - | 弹窗内容。 |
| title | string&nbsp;\|&nbsp;[Resource](../../ui/ts-types.md#resource类型) | 否 | - | 弹窗标题。 |
| message | string&nbsp;\|&nbsp;[Resource](../../ui/ts-types.md#resource类型) | 是 | - | 弹窗内容。 |
| autoCancel | boolean | 否 | true | 点击遮障层时，是否关闭弹窗。 |
| primaryButton | {<br/>value:&nbsp;string&nbsp;\|&nbsp;[Resource](../../ui/ts-types.md#resource类型),<br/>fontColor?:&nbsp;Color&nbsp;\|&nbsp;number&nbsp;\|&nbsp;string&nbsp;\|&nbsp;[Resource](../../ui/ts-types.md#resource类型),<br/>backgroundColor?:&nbsp;Color&nbsp;\|&nbsp;number&nbsp;\|&nbsp;string&nbsp;\|&nbsp;[Resource](../../ui/ts-types.md#resource类型),<br/>action:&nbsp;()&nbsp;=&gt;&nbsp;void;<br/>} | 否 | - | 按钮的文本内容、文本色、按钮背景色和点击回调。 |
| secondaryButton | {<br/>value:&nbsp;string&nbsp;\|&nbsp;[Resource](../../ui/ts-types.md#resource类型),<br/>fontColor?:&nbsp;Color&nbsp;\|&nbsp;number&nbsp;\|&nbsp;string&nbsp;\|&nbsp;[Resource](../../ui/ts-types.md#resource类型),<br/>backgroundColor?:&nbsp;Color&nbsp;\|&nbsp;number&nbsp;\|&nbsp;string&nbsp;\|&nbsp;[Resource](../../ui/ts-types.md#resource类型),<br/>action:&nbsp;()&nbsp;=&gt;&nbsp;void;<br/>} | 否 | - | 按钮的文本内容、文本色、按钮背景色和点击回调。 |
......
zh-cn/application-dev/reference/arkui-ts/ts-motion-path-animation.md
浏览文件 @ ccc7c3ae
......@@ -21,8 +21,6 @@
@Entry
@Component
struct MotionPathExample {
@State offsetX: number = 0
@State offsetY: number = 0
@State toggle: boolean = true
build() {
......
zh-cn/application-dev/reference/arkui-ts/ts-transition-animation-shared-elements.md
浏览文件 @ ccc7c3ae
......@@ -30,8 +30,6 @@
@Entry
@Component
struct SharedTransitionExample {
@State scale: number = 1
@State opacity: number = 1
@State active: boolean = false
build() {
......
zh-cn/application-dev/reference/arkui-ts/ts-universal-attributes-component-id.md
浏览文件 @ ccc7c3ae
......@@ -171,17 +171,17 @@ struct IdExample {
console.info(getInspectorTree())
this.text = "Button 'click to start' is clicked"
setTimeout(() => {
sendEventByKey("longclick", 11, "")
sendEventByKey("longClick", 11, "")
}, 2000)
}).id('click')
Button() {
Text('longclick').fontSize(25).fontWeight(FontWeight.Bold)
Text('longClick').fontSize(25).fontWeight(FontWeight.Bold)
}.margin({ top: 20 }).backgroundColor('#0D9FFB')
.gesture(
LongPressGesture().onActionEnd(() => {
console.info('long clicked')
this.text = "Button 'longclick' is longclicked"
this.text = "Button 'longClick' is longclicked"
setTimeout(() => {
let rect = Utils.getComponentRect('onTouch')
let touchPoint: TouchObject = {
......@@ -196,7 +196,7 @@ struct IdExample {
touchPoint.type = TouchType.Up
sendTouchEvent(touchPoint)
}, 2000)
})).id('longclick')
})).id('longClick')
Button() {
Text('onTouch').fontSize(25).fontWeight(FontWeight.Bold)
......
zh-cn/application-dev/webgl/webgl-guidelines.md
浏览文件 @ ccc7c3ae
......@@ -669,7 +669,7 @@ WebGL主要帮助开发者在前端开发中完成图形图像的相关处理，
// 初始化着色器
if (!initShaders(gl, VSHADER_SOURCE, FSHADER_SOURCE)) {
console.log('Failed to intialize shaders.');
console.log('Failed to initialize shaders.');
return;
}
......
zh-cn/contribute/template/concept-overview-template.md 已删除 100644 → 0
浏览文件 @ 80252784
# 概述
## 基本概念
*【 **写作要求**】*
*必选，描述本开发任务相关的基本概念，帮助开发者更好的理解开发任务。* *写作要求见下，完成写作后，请逐项自检*。
| 内容要求 | 是否满足 |
| -------- | -------- |
| 业界通用的概念不用赘述。 | |
| 注意使用业界通用术语来表达，不用开发者无法理解的内部语言。 | |
【写作样例】
XX系统音频模块支持音频业务的开发，提供音频相关的功能，主要包括音频播放、音频采集、音量管理和短音播放等。
在进行应用的开发前，开发者应了解以下基本概念：
- 采样
采样就是把模拟信号数字化的过程，所有的模拟信号都需要通过采样转换为可以用0101来表示的数字信号。
- 采样率
采样率为每秒从连续信号中提取并组成离散信号的采样次数，单位用赫兹（Hz）来表示。通常人耳能听到频率范围大约在20Hz～20kHz之间的声音。常用的音频采样频率有：8kHz、11.025kHz、22.05kHz、16kHz、37.8kHz、44.1kHz、48kHz、96kHz、192kHz等。
- 声道
声道是指声音在录制或播放时在不同空间位置采集或回放的相互独立的音频信号，所以声道数也就是声音录制时的音源数量或回放时相应的扬声器数量。
- 音频帧
音频数据是流式的，本身没有明确的一帧帧的概念，在实际的应用中，为了音频算法处理/传输的方便，一般约定俗成取2.5ms~60ms为单位的数据量为一帧音频。这个时间被称之为“采样时间”，其长度没有特别的标准，它是根据编解码器和具体应用的需求来决定的。
## 运作机制
*【 **写作要求**】*
*可选。如果机制比较简单，通过前面基本概念就可以说清楚，此章节可以不用提供，删除标题即可*。
*描述实现原理介绍机制，如关键步骤相关接口调用时机和触发时机，帮助开发者了解该功能的基本运作原理，以便更好的理解开发任务和定位问题*。
*写作要求见下，完成写作后，请逐项自检*。
| 内容要求 | 是否满足 |
| -------- | -------- |
| 仅描述开发任务相关的原理。 | |
| 尽量图文配合，一般使用时序图、流程图等形式。文字描述与图形描述匹配。 | |
【写作样例-1】
- 信号量初始化，为配置的N个信号量申请内存（N值可以由用户自行配置，受内存限制），并把所有的信号量初始化成未使用，并加入到未使用链表中供系统使用。
- 信号量创建，从未使用的信号量链表中获取一个信号量资源，并设定初值。
- 信号量申请，若其计数器值大于0，则直接减1返回成功。否则任务阻塞，等待其它任务释放该信号量，等待的超时时间可设定。当任务被一个信号量阻塞时，将该任务挂到信号量等待任务队列的队尾。
- 信号量释放，若没有任务等待该信号量，则直接将计数器加1返回。否则唤醒该信号量等待任务队列上的第一个任务。
- 信号量删除，将正在使用的信号量置为未使用信号量，并挂回到未使用链表。
- 信号量允许多个任务在同一时刻访问同一资源，但会限制同一时刻访问此资源的最大任务数目。访问同一资源的任务数达到该资源的最大数量时，会阻塞其他试图获取该资源的任务，直到有任务释放该信号量。
【写作样例-2】
**互斥锁运作原理**
多任务环境下会存在多个任务访问同一公共资源的场景，而有些公共资源是非共享的，需要任务进行独占式处理。互斥锁怎样来避免这种冲突呢？
用互斥锁处理非共享资源的同步访问时，如果有任务访问该资源，则互斥锁为加锁状态。此时其他任务如果想访问这个公共资源则会被阻塞，直到互斥锁被持有该锁的任务释放后，其他任务才能重新访问该公共资源，此时互斥锁再次上锁，如此确保同一时刻只有一个任务正在访问这个公共资源，保证了公共资源操作的完整性。
## 约束与限制
【写作要求】
*必选*。 *描述本开发任务过程中* *的约束条件，以及此操作约束带来相应的负面影响，包括但不限于如下几方面*：
- **功能限制**：
- 功能使用范围（明确不支持的场景）。
- 规格限制。
* **操作限制**：
* 已知问题的操作。
* 潜在风险的操作（如引起性能降低）。
* 引起性能降低的操作。
写作要求见下，完成写作后，请逐项自检。
| 内容要求 | 是否满足 |
| -------- | -------- |
| 明确功能限制或操作限制。 | |
| 约束对指导任务开发有影响或体验有感知，否则不用体现。 | |
| 容易出错的操作在步骤里描述，不在此体现。 | |
【**写作样例**】
**互斥锁的约束与限制**：
- 两个任务不能对同一把互斥锁加锁。如果某任务对已被持有的互斥锁加锁，则该任务会被挂起，直到持有该锁的任务对互斥锁解锁，才能执行对这把互斥锁的加锁操作。
- 互斥锁不能在中断服务程序中使用。
- XXX作为实时操作系统需要保证任务调度的实时性，尽量避免任务的长时间阻塞，因此在获得互斥锁之后，应该尽快释放互斥锁。
- 持有互斥锁的过程中，不得再调用LOS_TaskPriSet等接口更改持有互斥锁任务的优先级。
zh-cn/device-dev/driver/driver-platform-mmc-develop.md
浏览文件 @ ccc7c3ae
......@@ -318,7 +318,7 @@ MMC模块适配的三个环节是配置属性文件，实例化驱动入口，
...
ret = HimciHostInit(host, cntlr);// 厂商自定义的初始化，失败就 goto _ERR;
...
ret = MmcCntlrAdd(cntlr); // 调用核心层函数 失败就goto _ERR;
ret = MmcCntlrAdd(cntlr); // 调用核心层函数 失败就goto _ERR;
...
(void)MmcCntlrAddDetectMsgToQueue(cntlr);// 将卡检测消息添加到队列中。
HDF_LOGD("HimciMmcBind: success.");
......
zh-cn/device-dev/driver/driver-platform-regulator-develop.md
浏览文件 @ ccc7c3ae
......@@ -129,12 +129,12 @@ Regulator模块适配包含以下四个步骤：
device_regulator :: device {
device0 :: deviceNode { // 为每一个Regulator控制器配置一个HDF设备节点，存在多个时添加，否则不用
policy = 1; // 2：用户态可见；1：内核态可见；0：不需要发布服务
priority = 50; // 驱动启动优先级
priority = 50; // 驱动启动优先级
permission = 0644; // 驱动创建设备节点权限
/* 【必要】用于指定驱动名称，需要与期望的驱动Entry中的moduleName一致 */
moduleName = "HDF_PLATFORM_REGULATOR_MANAGER";
serviceName = "HDF_PLATFORM_REGULATOR_MANAGER"; //【必要且唯一】驱动对外发布服务的名称
/* 【必要】用于配置控制器私有数据，要与regulator_config.hcs中对应控制器保持一致，具体的控制器信息在regulator_config.hcs中 */
/* 【必要】用于配置控制器私有数据，要与regulator_config.hcs中对应控制器保持一致，具体的控制器信息在regulator_config.hcs中 */
deviceMatchAttr = "hdf_platform_regulator_manager";
}
device1 :: deviceNode {
......@@ -215,8 +215,8 @@ Regulator模块适配包含以下四个步骤：
};
struct RegulatorDesc {
const char *name; /* regulator名称 */
const char *parentName; /* regulator父节点名称 */
const char *name; /* regulator名称 */
const char *parentName; /* regulator父节点名称 */
struct RegulatorConstraints constraints; /* regulator约束信息 */
uint32_t minUv; /* 最小输出电压值 */
uint32_t maxUv; /* 最大输出电压值 */
......
zh-cn/device-dev/driver/driver-platform-spi-des.md
浏览文件 @ ccc7c3ae
......@@ -91,7 +91,7 @@ DevHandle SpiOpen(const struct SpiDevInfo *info);
```
struct SpiDevInfo spiDevinfo; /* SPI设备描述符 */
DevHandle spiHandle = NULL; /* SPI设备句柄 */
DevHandle spiHandle = NULL; /* SPI设备句柄 */
spiDevinfo.busNum = 0; /* SPI设备总线号 */
spiDevinfo.csNum = 0; /* SPI设备片选号 */
......
zh-cn/device-dev/driver/driver-platform-spi-develop.md
浏览文件 @ ccc7c3ae
......@@ -90,7 +90,7 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
platform :: host {
hostName = "platform_host";
priority = 50;
device_spi :: device { //为每一个 SPI 控制器配置一个HDF设备节点
device_spi :: device { //为每一个 SPI 控制器配置一个HDF设备节点
device0 :: deviceNode {
policy = 1;
priority = 60;
......@@ -104,8 +104,8 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
priority = 60;
permission = 0644;
moduleName = "HDF_PLATFORM_SPI"; // 【必要】用于指定驱动名称，该字段的值必须和驱动入口结构的moduleName值一致
serviceName = "HDF_PLATFORM_SPI_1"; // 【必要且唯一】驱动对外发布服务的名称
deviceMatchAttr = "hisilicon_hi35xx_spi_1";// 需要与设备hcs文件中的match_attr匹配
serviceName = "HDF_PLATFORM_SPI_1"; // 【必要且唯一】驱动对外发布服务的名称
deviceMatchAttr = "hisilicon_hi35xx_spi_1"; // 需要与设备hcs文件中的match_attr匹配
}
...
}
......@@ -294,10 +294,10 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
int32_t ret;
struct SpiCntlr *cntlr = NULL;
...
cntlr = SpiCntlrFromDevice(device);// 这里有HdfDeviceObject到SpiCntlr的强制转化，通过service成员，赋值见Bind函数
cntlr = SpiCntlrFromDevice(device); // 这里有HdfDeviceObject到SpiCntlr的强制转化，通过service成员，赋值见Bind函数
// return (device == NULL) ? NULL : (struct SpiCntlr *)device->service;
...
ret = Pl022Init(cntlr, device);// 【必要】实例化厂商自定义操作对象，示例见下
ret = Pl022Init(cntlr, device); // 【必要】实例化厂商自定义操作对象，示例见下
...
ret = Pl022Probe(cntlr->priv);
...
......@@ -318,15 +318,15 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
// 计算最大，最小速度对应的频率
pl022->maxSpeedHz = (pl022->clkRate) / ((SCR_MIN + 1) * CPSDVSR_MIN);
pl022->minSpeedHz = (pl022->clkRate) / ((SCR_MAX + 1) * CPSDVSR_MAX);
DListHeadInit(&pl022->deviceList);// 初始化DList链表
pl022->cntlr = cntlr; // 使Pl022与SpiCntlr可以相互转化的前提
cntlr->priv = pl022; // 使Pl022与SpiCntlr可以相互转化的前提
cntlr->busNum = pl022->busNum; // 给SpiCntlr的busNum赋值
cntlr->method = &g_method; // SpiCntlrMethod的实例化对象的挂载
DListHeadInit(&pl022->deviceList); // 初始化DList链表
pl022->cntlr = cntlr; // 使Pl022与SpiCntlr可以相互转化的前提
cntlr->priv = pl022; // 使Pl022与SpiCntlr可以相互转化的前提
cntlr->busNum = pl022->busNum; // 给SpiCntlr的busNum赋值
cntlr->method = &g_method; // SpiCntlrMethod的实例化对象的挂载
...
ret = Pl022CreatAndInitDevice(pl022);
if (ret != 0) {
Pl022Release(pl022); // 初始化失败就释放Pl022对象
Pl022Release(pl022); // 初始化失败就释放Pl022对象
return ret;
}
return 0;
......@@ -352,11 +352,11 @@ SPI模块适配HDF框架的三个环节是配置属性文件，实例化驱动
{
struct SpiCntlr *cntlr = NULL;
...
cntlr = SpiCntlrFromDevice(device);// 这里有HdfDeviceObject到SpiCntlr的强制转化，通过service成员，赋值见Bind函数
// return (device==NULL) ?NULL:(struct SpiCntlr *)device->service;
cntlr = SpiCntlrFromDevice(device); // 这里有HdfDeviceObject到SpiCntlr的强制转化，通过service成员，赋值见Bind函数
// return (device==NULL) ?NULL:(struct SpiCntlr *)device->service;
...
if (cntlr->priv != NULL) {
Pl022Remove((struct Pl022 *)cntlr->priv);// 这里有SpiCntlr到Pl022的强制转化
Pl022Remove((struct Pl022 *)cntlr->priv); // 这里有SpiCntlr到Pl022的强制转化
}
SpiCntlrDestroy(cntlr); // 释放Pl022对象
}
......
zh-cn/device-dev/driver/driver-platform-uart-des.md
浏览文件 @ ccc7c3ae
......@@ -80,7 +80,7 @@ DevHandle UartOpen(uint32_t port);
```
DevHandle handle = NULL; /* UART设备句柄 */
uint32_t port = 3; /* UART设备端口号 */
uint32_t port = 3; /* UART设备端口号 */
handle = UartOpen(port);
if (handle == NULL) {
HDF_LOGE("UartOpen: failed!\n");
......
zh-cn/readme/用户IAM子系统.md
浏览文件 @ ccc7c3ae
此差异已折叠。
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或