提交 cfedb144 编写于 作者: X xuezhongzhu

api文档修改

Signed-off-by: Nxuezhongzhu <xuezhongzhu@huawei.com>
上级 ae5ba5a7
......@@ -476,6 +476,10 @@ queryAbilityByWant(want: Want, bundleFlags: number, userId: number, callback: As
以异步方法根据给定的意图获取Ability信息,使用callback形式返回结果。
**系统能力:**
SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
......@@ -509,6 +513,10 @@ queryAbilityByWant(want: Want, bundleFlags: number, callback: AsyncCallback<Arra
以异步方法根据给定的意图获取Ability信息,使用callback形式返回结果。
**系统能力:**
SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
......@@ -699,6 +707,10 @@ getNameForUid(uid: number): Promise\<string>
以异步方法通过uid获取对应的包名,使用Promise形式返回结果。
**系统能力:**
SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
......@@ -728,6 +740,10 @@ getNameForUid(uid: number, callback: AsyncCallback<string>): void;
以异步方法通过uid获取对应的包名,使用callback形式返回结果。
**系统能力:**
SystemCapability.BundleManager.BundleFramework
**参数:**
| 名称 | 类型 | 必填 | 描述 |
......@@ -748,9 +764,10 @@ bundle.getNameForUid(uid, (err, data) => {
})
```
## ElementName
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | ------ | ---- | ------------------------------------------------------------ |
| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 |
......@@ -761,6 +778,8 @@ bundle.getNameForUid(uid, (err, data) => {
## InstallStatus
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------- | -------- | ---------------- | ---- | ------------------------------------------------------------ |
| status | 只读 | InstallErrorCode | 是 | 安装结果code<br/>SUCCESS = 0<br/>STATUS_INSTALL_FAILURE = 1<br/>STATUS_INSTALL_FAILURE_ABORTED = 2,<br/>STATUS_INSTALL_FAILURE_INVALID = 3<br/>STATUS_INSTALL_FAILURE_CONFLICT = 4<br/>STATUS_INSTALL_FAILURE_STORAGE = 5<br/>STATUS_INSTALL_FAILURE_INCOMPATIBLE = 6<br/>STATUS_UNINSTALL_FAILURE = 7<br>STATUS_UNINSTALL_FAILURE_BLOCKED = 8<br/>STATUS_UNINSTALL_FAILURE_ABORTED = 9<br/>STATUS_UNINSTALL_FAILURE_CONFLICT = 10<br/>STATUS_INSTALL_FAILURE_DOWNLOAD_TIMEOUT = 0x0B<br/>STATUS_INSTALL_FAILURE_DOWNLOAD_FAILED = 0x0C<br/>STATUS_RECOVER_FAILURE_INVALID = 0x0D<br/>STATUS_ABILITY_NOT_FOUND = 0x40<br/>STATUS_BMS_SERVICE_ERROR = 0x41<br/>STATUS_FAILED_NO_SPACE_LEFT = 0x42<br/>STATUS_GRANT_REQUEST_PERMISSIONS_FAILED = 0x43<br/>STATUS_INSTALL_PERMISSION_DENIED = 0x44<br/>STATUS_UNINSTALL_PERMISSION_DENIED = 0x45 |
......@@ -769,6 +788,8 @@ bundle.getNameForUid(uid, (err, data) => {
包的标志
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 默认值 | 说明 |
| ------ | ------ | ------ |
| GET_BUNDLE_DEFAULT | 0x00000000 | 获取默认的应用信息 |
......@@ -788,6 +809,8 @@ bundle.getNameForUid(uid, (err, data) => {
包的选项
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| userId | number | 是 | 是 | 用户ID。默认值:调用方所在用户,取值范围:大于等于0。 |
......@@ -796,6 +819,8 @@ bundle.getNameForUid(uid, (err, data) => {
应用包的信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| name | string | 是 | 否 | 应用包的名称 |
......@@ -826,6 +851,8 @@ bundle.getNameForUid(uid, (err, data) => {
应用程序信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| name | string | 是 | 否 | 应用程序的名称 |
......@@ -854,6 +881,8 @@ bundle.getNameForUid(uid, (err, data) => {
应用程序的模块信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| moduleName | string | 是 | 否 | 模块名称 |
......@@ -863,6 +892,8 @@ bundle.getNameForUid(uid, (err, data) => {
自定义元数据
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----- | ------ | ---- | ---- | ---------------- |
| name | string | 是 | 是 | 自定义元数据名称 |
......@@ -874,6 +905,8 @@ bundle.getNameForUid(uid, (err, data) => {
Hap模块信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| name | string | 是 | 否 | 模块名称 |
......@@ -897,6 +930,8 @@ Hap模块信息
应用运行时需向系统申请的权限集合的详细信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| name | string | 是 | 是 | 需要使用的权限名称 |
......@@ -907,6 +942,8 @@ Hap模块信息
描述权限使用的场景和时机
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| abilities | Array<string> | 是 | 是 | 使用到该权限的Ability集合 |
......@@ -917,6 +954,8 @@ Hap模块信息
Ability信息
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | ------ | ------ | ------ |
| bundleName | string | 是 | 否 | 应用包名 |
......@@ -951,6 +990,8 @@ Ability信息
Ability类型
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 说明 |
| ------- | ---- | --------------------------- |
| UNKNOWN | 无 | 未知Ability类型 |
......@@ -962,6 +1003,8 @@ Ability类型
屏幕显示方向
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 说明 |
| ------------- | ---- | ------------------------ |
| UNSPECIFIED | 无 | 屏幕方向--不指定 |
......@@ -973,6 +1016,8 @@ Ability类型
启动模式
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 说明 |
| ----------- | ---- | ------------------- |
| SINGLETON | 0 | Ability只有一个示例 |
......@@ -982,6 +1027,8 @@ Ability类型
Ability的子类型
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.TransientTask
| 名称 | 类型 | 说明 |
| ----------- | ---- | ----------------------------- |
| UNSPECIFIED | 0 | 未定义Ability子类型 |
......
......@@ -191,12 +191,13 @@ startBackgroundRunning(context: Context, bgMode: BackgroundMode, wantAgent: Want
**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
- **参数**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| context | Context | 是 | 应用运行的上下文 |
| bgMode | BackgroundMode | 是 | 向系统申请的后台模式 |
| wantAgent | [WantAgent](js-apis-notification.md#WantAgent接口) | 是 | 通知参数,用于指定长时任务通知点击跳转的界面 |
| wantAgent | [WantAgent](js-apis-notification.md#WantAgent接口) | 是 | 通知参数,用于指定长时任务通知点击跳转的界面 |
- **返回值**
| 类型 | 说明 |
| -------------- | ------------------------- |
......@@ -295,14 +296,16 @@ backgroundTaskManager.stopBackgroundRunning(featureAbility.getContext()).then(()
## BackgroundMode <sup>8+</sup>
**系统能力:** 以下各项对应的系统能力均为SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask
| 参数名 | 参数值 | 描述 |
| ----------------------- | -------- | -------- |
| DATA_TRANSFER | 1 | 数据传输<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
| AUDIO_PLAYBACK | 2 | 音频播放<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
| AUDIO_RECORDING | 3 | 录音<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
| LOCATION | 4 | 定位导航<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
| BLUETOOTH_INTERACTION | 5 | 蓝牙相关<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
| MULTI_DEVICE_CONNECTION | 6 | 多设备互联<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
| WIFI_INTERACTION | 7 | WLAN相关(系统保留)<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
| VOIP | 8 | 音视频通话(系统保留)<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
| TASK_KEEPING | 9 | 计算任务(仅供PC使用)<br/>**系统能力:** SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask |
\ No newline at end of file
| DATA_TRANSFER | 1 | 数据传输 |
| AUDIO_PLAYBACK | 2 | 音频播放 |
| AUDIO_RECORDING | 3 | 录音 |
| LOCATION | 4 | 定位导航 |
| BLUETOOTH_INTERACTION | 5 | 蓝牙相关 |
| MULTI_DEVICE_CONNECTION | 6 | 多设备互联 |
| WIFI_INTERACTION | 7 | WLAN相关(系统保留) |
| VOIP | 8 | 音视频通话(系统保留) |
| TASK_KEEPING | 9 | 计算任务(仅供PC使用) |
\ No newline at end of file
......@@ -251,8 +251,8 @@ publishAsUser(event: string, userId: number, options: CommonEventPublishData, ca
```js
//公共事件相关信息
var options = {
code: 0; //公共事件的初始代码
data: "initial data";//公共事件的初始数据
code: 0, //公共事件的初始代码
data: "initial data",//公共事件的初始数据
}
//发布公共事件回调
......@@ -541,34 +541,40 @@ CommonEvent.unsubscribe(subscriber, UnsubscribeCallBack);
## CommonEventPublishData
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------------------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| bundleName | 只读 | string | 否 | 表示包名称<br/>**系统能力**:SystemCapability.Notification.CommonEvent |
| code | 只读 | number | 否 | 表示公共事件的结果代码<br/>**系统能力**:SystemCapability.Notification.CommonEvent |
| data | 只读 | string | 否 | 表示公共事件的自定义结果数据<br/>**系统能力**:SystemCapability.Notification.CommonEvent |
| subscriberPermissions | 只读 | Array\<string> | 否 | 表示订阅者的权限<br/>**系统能力**:SystemCapability.Notification.CommonEvent |
| isOrdered | 只读 | boolean | 否 | 表示是否是有序事件<br/>**系统能力**:SystemCapability.Notification.CommonEvent |
| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息<br/>**系统能力**:SystemCapability.Notification.CommonEvent |
**系统能力:**以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| --------------------- | -------- | -------------------- | ---- | ---------------------------- |
| bundleName | 只读 | string | 否 | 表示包名称 |
| code | 只读 | number | 否 | 表示公共事件的结果代码 |
| data | 只读 | string | 否 | 表示公共事件的自定义结果数据 |
| subscriberPermissions | 只读 | Array\<string> | 否 | 表示订阅者的权限 |
| isOrdered | 只读 | boolean | 否 | 表示是否是有序事件 |
| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息 |
## CommonEventSubscribeInfo
**系统能力:**以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ------------------- | -------- | -------------- | ---- | ------------------------------------------------------------ |
| events | 只读 | Array\<string> | 是 | 表示要发送的公共事件<br/>**系统能力**:SystemCapability.Notification.CommonEvent |
| publisherPermission | 只读 | string | 否 | 表示发布者的权限<br/>**系统能力**:SystemCapability.Notification.CommonEvent |
| publisherDeviceId | 只读 | string | 否 | 表示设备ID,该值必须是同一ohos网络上的现有设备ID<br/>**系统能力**:SystemCapability.Notification.CommonEvent |
| userId | 只读 | number | 否 | 表示用户ID。此参数是可选的,默认值当前用户的ID。如果指定了此参数,则该值必须是系统中现有的用户ID。<br/>**系统能力**:SystemCapability.Notification.CommonEvent |
| priority | 只读 | number | 否 | 表示订阅者的优先级。值的范围是-100到1000<br/>**系统能力**:SystemCapability.Notification.CommonEvent |
| events | 只读 | Array\<string> | 是 | 表示要发送的公共事件 |
| publisherPermission | 只读 | string | 否 | 表示发布者的权限 |
| publisherDeviceId | 只读 | string | 否 | 表示设备ID,该值必须是同一ohos网络上的现有设备ID |
| userId | 只读 | number | 否 | 表示用户ID。此参数是可选的,默认值当前用户的ID。如果指定了此参数,则该值必须是系统中现有的用户ID。 |
| priority | 只读 | number | 否 | 表示订阅者的优先级。值的范围是-100到1000 |
## CommonEventData
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | -------------------- | ---- | ------------------------------------------------------------ |
| event | 只读 | string | 是 | 表示当前接收的公共事件名称<br/>**系统能力**:SystemCapability.Notification.CommonEvent |
| bundleName | 只读 | string | 否 | 表示包名称<br/>**系统能力**:SystemCapability.Notification.CommonEvent |
| code | 只读 | number | 否 | 表示公共事件的结果代码,用于传递int类型的数据<br/>**系统能力**:SystemCapability.Notification.CommonEvent |
| data | 只读 | string | 否 | 表示公共事件的自定义结果数据,用于传递string类型的数据<br/>**系统能力**:SystemCapability.Notification.CommonEvent |
| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息<br/>**系统能力**:SystemCapability.Notification.CommonEvent |
**系统能力:**以下各项对应的系统能力均为SystemCapability.Notification.CommonEvent
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---------- | -------- | -------------------- | ---- | ------------------------------------------------------- |
| event | 只读 | string | 是 | 表示当前接收的公共事件名称 |
| bundleName | 只读 | string | 否 | 表示包名称 |
| code | 只读 | number | 否 | 表示公共事件的结果代码,用于传递int类型的数据 |
| data | 只读 | string | 否 | 表示公共事件的自定义结果数据,用于传递string类型的数据< |
| parameters | 只读 | {[key: string]: any} | 否 | 表示公共事件的附加信息 |
## CommonEventSubscriber
......
......@@ -9,16 +9,16 @@
import environment from '@ohos.environment';
```
## 系统能力
SystemCapability.FileManagement.File.Environment
## environment.getStorageDataDir
getStorageDataDir():Promise&lt;string&gt;
异步方法获取内存存储根目录,以promise形式返回结果。
- 系统能力:
SystemCapability.FileManagement.File.Environment
- 返回值:
| 类型 | 说明 |
......@@ -41,6 +41,10 @@ getStorageDataDir(callback:AsyncCallback&lt;string&gt;):void
异步方法获取内存存储根目录,以callback形式返回结果。
- 系统能力:
SystemCapability.FileManagement.File.Environment
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
......@@ -61,6 +65,10 @@ getUserDataDir():Promise&lt;string&gt;
异步方法获取公共文件根目录,以promise形式返回结果。
- 系统能力:
SystemCapability.FileManagement.File.Environment
- 返回值:
| 类型 | 说明 |
......@@ -83,6 +91,10 @@ getUserDataDir(callback:AsyncCallback&lt;string&gt;): void
异步方法获取公共文件根目录,以callback形式返回结果。
- 系统能力:
SystemCapability.FileManagement.File.Environment
- 参数:
| 参数名 | 类型 | 必填 | 说明 |
......
......@@ -23,16 +23,16 @@ createFormBindingData(obj?: Object | string): FormBindingData
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------- | ---- | ------------------------------------------------------------ |
| obj | Object或string | 否 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。 |
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------- | ---- | ------------------------------------------------------------ |
| obj | Object或string | 否 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。 |
**返回值:**
| 类型 | 说明 |
| ----------------------------------- | --------------------------------------- |
| [FormBindingData](#formbindingdata) | 根据传入数据创建的FormBindingData对象。 |
| 类型 | 说明 |
| ----------------------------------- | --------------------------------------- |
| [FormBindingData](#formbindingdata) | 根据传入数据创建的FormBindingData对象。 |
**示例:**
......
......@@ -11,11 +11,6 @@ import reminderAgent from'@ohos.reminderAgent';
```
## 系统能力
SystemCapability.Notification.ReminderAgent
## 权限
ohos.permission.PUBLISH_AGENT_REMINDER
......@@ -27,11 +22,15 @@ publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback&lt;number&
发布一个后台代理提醒,使用callback方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reminderReq | [ReminderRequest](#reminderrequest) | 是 | 需要发布的提醒实例。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 异步回调,返回当前发布的提醒的reminderId。 |
| reminderReq | [ReminderRequest](#reminderrequest) | 是 | 需要发布的提醒实例。 |
| callback | AsyncCallback&lt;number&gt; | 是 | 异步回调,返回当前发布的提醒的reminderId。 |
- 示例:
```
......@@ -54,15 +53,19 @@ publishReminder(reminderReq: ReminderRequest): Promise&lt;number&gt;
发布一个后台代理提醒,使用Promise方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reminderReq | [ReminderRequest](#reminderrequest) | 是 | 需要发布的提醒实例。 |
| reminderReq | [ReminderRequest](#reminderrequest) | 是 | 需要发布的提醒实例。 |
- 返回值:
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;number&gt; | 返回提醒的reminderId。 |
| Promise&lt;number&gt; | 返回提醒的reminderId。 |
- 示例
```
......@@ -86,12 +89,16 @@ cancelReminder(reminderId: number, callback: AsyncCallback&lt;void&gt;): void
取消指定id的提醒,使用callback方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reminderId | number | 是 | 目标reminder的id号。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步回调。 |
| reminderId | number | 是 | 目标reminder的id号。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步回调。 |
- 示例
......@@ -111,17 +118,21 @@ cancelReminder(reminderId: number): Promise&lt;void&gt;
取消指定id的提醒,使用Promise方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reminderId | number | 是 | 目标reminder的id号。 |
| reminderId | number | 是 | 目标reminder的id号。 |
- 返回值
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | Promise类型异步回调。 |
| Promise&lt;void&gt; | Promise类型异步回调。 |
- 示例
......@@ -142,11 +153,15 @@ getValidReminders(callback: AsyncCallback&lt;Array&lt;ReminderRequest&gt;&gt;):
获取当前应用已设置的所有有效(未过期)的提醒,使用callback方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;Array&lt;[ReminderRequest](#reminderrequest)&gt;&gt; | 是 | 异步回调,返回当前应用已设置的所有有效(未过期)的提醒。 |
| callback | AsyncCallback&lt;Array&lt;[ReminderRequest](#reminderrequest)&gt;&gt; | 是 | 异步回调,返回当前应用已设置的所有有效(未过期)的提醒。 |
- 示例
......@@ -183,11 +198,15 @@ getValidReminders(): Promise&lt;Array&lt;ReminderRequest&gt;&gt;
获取当前应用已设置的所有有效(未过期)的提醒,使用Promise方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 返回值
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;Array&lt;[ReminderRequest](#reminderrequest)&gt;&gt; | 返回当前应用已设置的所有有效(未过期)的提醒。 |
| Promise&lt;Array&lt;[ReminderRequest](#reminderrequest)&gt;&gt; | 返回当前应用已设置的所有有效(未过期)的提醒。 |
- 示例
......@@ -224,11 +243,15 @@ cancelAllReminders(callback: AsyncCallback&lt;void&gt;): void
取消当前应用所有的提醒,使用callback方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步回调。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步回调。 |
- 示例
......@@ -244,11 +267,15 @@ cancelAllReminders(): Promise&lt;void&gt;
取消当前应用所有的提醒,使用Promise方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 返回值
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | Promise类型异步回调。 |
| Promise&lt;void&gt; | Promise类型异步回调。 |
- 示例
......@@ -264,12 +291,16 @@ addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback&lt;void&gt;)
添加一个NotificationSlot,使用callback方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| slot | [ERROR:Invalid&nbsp;link:zh-cn_topic_0000001158696346.xml#xref1954171018915,link:zh-cn_topic_0000001180018813.xml#section1382174172015](zh-cn_topic_0000001180018813.xml#section1382174172015) | 是 | notification&nbsp;slot实例。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步回调。 |
| slot | [ERROR:Invalid&nbsp;link:zh-cn_topic_0000001158696346.xml#xref1954171018915,link:zh-cn_topic_0000001180018813.xml#section1382174172015](zh-cn_topic_0000001180018813.xml#section1382174172015) | 是 | notification&nbsp;slot实例。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步回调。 |
- 示例
......@@ -293,17 +324,21 @@ addNotificationSlot(slot: NotificationSlot): Promise&lt;void&gt;
添加一个NotificationSlot,使用Promise方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| slot | [ERROR:Invalid&nbsp;link:zh-cn_topic_0000001158696346.xml#xref2049924012917,link:zh-cn_topic_0000001180018813.xml#section1382174172015](zh-cn_topic_0000001180018813.xml#section1382174172015) | 是 | notification&nbsp;slot实例。 |
| slot | [ERROR:Invalid&nbsp;link:zh-cn_topic_0000001158696346.xml#xref2049924012917,link:zh-cn_topic_0000001180018813.xml#section1382174172015](zh-cn_topic_0000001180018813.xml#section1382174172015) | 是 | notification&nbsp;slot实例。 |
- 返回值
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | Promise类型异步回调。 |
| Promise&lt;void&gt; | Promise类型异步回调。 |
- 示例
......@@ -327,12 +362,16 @@ removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback&
删除目标NotificationSlot,使用callback方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| slotType | [ERROR:Invalid&nbsp;link:zh-cn_topic_0000001158696346.xml#xref11228182975217,link:zh-cn_topic_0000001180018813.xml#section072355105110](zh-cn_topic_0000001180018813.xml#section072355105110) | 是 | 目标notification&nbsp;slot的类型。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步回调。 |
| slotType | [ERROR:Invalid&nbsp;link:zh-cn_topic_0000001158696346.xml#xref11228182975217,link:zh-cn_topic_0000001180018813.xml#section072355105110](zh-cn_topic_0000001180018813.xml#section072355105110) | 是 | 目标notification&nbsp;slot的类型。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步回调。 |
- 示例
......@@ -352,17 +391,21 @@ removeNotificationSlot(slotType: notification.SlotType): Promise&lt;void&gt;
删除目标NotificationSlot,使用Promise方式实现异步调用。
- 系统能力
SystemCapability.Notification.ReminderAgent
- 参数
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| slotType | [ERROR:Invalid&nbsp;link:zh-cn_topic_0000001158696346.xml#xref1120863519109,link:zh-cn_topic_0000001180018813.xml#section072355105110](zh-cn_topic_0000001180018813.xml#section072355105110) | 是 | 目标notification&nbsp;slot的类型。 |
| slotType | [ERROR:Invalid&nbsp;link:zh-cn_topic_0000001158696346.xml#xref1120863519109,link:zh-cn_topic_0000001180018813.xml#section072355105110](zh-cn_topic_0000001180018813.xml#section072355105110) | 是 | 目标notification&nbsp;slot的类型。 |
- 返回值
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| Promise&lt;void&gt; | Promise类型异步回调。 |
| Promise&lt;void&gt; | Promise类型异步回调。 |
- 示例
......@@ -380,72 +423,84 @@ export default {
按钮的类型。
| 名称 | 默认值 | 说明 |
- 系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| ACTION_BUTTON_TYPE_CLOSE | 0 | 表示关闭提醒的按钮。 |
| ACTION_BUTTON_TYPE_SNOOZE | 1 | 表示延迟提醒的按钮。 |
| ACTION_BUTTON_TYPE_CLOSE | 0 | 表示关闭提醒的按钮。 |
| ACTION_BUTTON_TYPE_SNOOZE | 1 | 表示延迟提醒的按钮。 |
## ReminderType
提醒的类型。
| 名称 | 默认值 | 说明 |
- 系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 默认值 | 说明 |
| -------- | -------- | -------- |
| REMINDER_TYPE_TIMER | 0 | 表示提醒类型:倒计时。 |
| REMINDER_TYPE_CALENDAR | 1 | 表示提醒类型:日历。 |
| REMINDER_TYPE_ALARM | 2 | 表示提醒类型:闹钟。 |
| REMINDER_TYPE_TIMER | 0 | 表示提醒类型:倒计时。 |
| REMINDER_TYPE_CALENDAR | 1 | 表示提醒类型:日历。 |
| REMINDER_TYPE_ALARM | 2 | 表示提醒类型:闹钟。 |
## ActionButton
用于设置弹出的提醒通知信息上显示的按钮类型和标题。
| 名称 | 参数类型 | 必填 | 说明 |
- 系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| title | string | 是 | 按钮显示的标题。 |
| type | [ActionButtonType](#actionbuttontype) | 是 | 按钮的类型。 |
| title | string | 是 | 按钮显示的标题。 |
| type | [ActionButtonType](#actionbuttontype) | 是 | 按钮的类型。 |
## WantAgent
点击提醒通知后跳转的目标ability信息。
| 名称 | 参数类型 | 必填 | 说明 |
- 系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pkgName | string | 是 | 指明点击提醒通知栏后跳转的目标hap包名。 |
| abilityName | string | 是 | 指明点击提醒通知栏后跳转的目标ability名称。 |
| pkgName | string | 是 | 指明点击提醒通知栏后跳转的目标hap包名。 |
| abilityName | string | 是 | 指明点击提醒通知栏后跳转的目标ability名称。 |
## MaxScreenWantAgent
提醒到达时自动拉起的目标ability信息。
| 名称 | 参数类型 | 必填 | 说明 |
- 系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pkgName | string | 是 | 指明提醒到达时自动拉起的目标hap包名(如果设备在使用中,则只弹出通知横幅框)。 |
| abilityName | string | 是 | 指明提醒到达时自动拉起的目标ability名(如果设备在使用中,则只弹出通知横幅框)。 |
| pkgName | string | 是 | 指明提醒到达时自动拉起的目标hap包名(如果设备在使用中,则只弹出通知横幅框)。 |
| abilityName | string | 是 | 指明提醒到达时自动拉起的目标ability名(如果设备在使用中,则只弹出通知横幅框)。 |
## ReminderRequest
提醒实例对象,用于设置提醒类型、响铃时长等具体信息。
| 名称 | 参数类型 | 必填 | 说明 |
- 系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reminderType | ReminderType | 是 | 指明提醒类型。 |
| actionButton | [ActionButton?,&nbsp;ActionButton?] | 否 | 弹出的提醒通知栏中显示的按钮(参数可选,支持0/1/2个按钮)。 |
| wantAgent | WantAgent | 否 | 点击通知后需要跳转的目标ability信息。 |
| maxScreenWantAgent | MaxScreenWantAgent | 否 | 提醒到达时跳转的目标包。如果设备正在使用中,则弹出一个通知框。 |
| ringDuration | number | 否 | 指明响铃时长。 |
| snoozeTimes | number | 否 | 指明延迟提醒次数。 |
| timeInterval | number | 否 | 执行延迟提醒间隔。 |
| title | string | 否 | 指明提醒标题。 |
| content | string | 否 | 指明提醒内容。 |
| expiredContent | string | 否 | 指明提醒过期后需要显示的内容。 |
| snoozeContent | string | 否 | 指明延迟提醒时需要显示的内容。 |
| notificationId | number | 否 | 指明提醒使用的通知的id号,相同id号的提醒会覆盖。 |
| slotType | [ERROR:Invalid&nbsp;link:zh-cn_topic_0000001158696346.xml#xref39047351518,link:zh-cn_topic_0000001180018813.xml#section072355105110](zh-cn_topic_0000001180018813.xml#section072355105110) | 否 | 指明提醒的slot类型。 |
| reminderType | ReminderType | 是 | 指明提醒类型。 |
| actionButton | [ActionButton?,&nbsp;ActionButton?] | 否 | 弹出的提醒通知栏中显示的按钮(参数可选,支持0/1/2个按钮)。 |
| wantAgent | WantAgent | 否 | 点击通知后需要跳转的目标ability信息。 |
| maxScreenWantAgent | MaxScreenWantAgent | 否 | 提醒到达时跳转的目标包。如果设备正在使用中,则弹出一个通知框。 |
| ringDuration | number | 否 | 指明响铃时长。 |
| snoozeTimes | number | 否 | 指明延迟提醒次数。 |
| timeInterval | number | 否 | 执行延迟提醒间隔。 |
| title | string | 否 | 指明提醒标题。 |
| content | string | 否 | 指明提醒内容。 |
| expiredContent | string | 否 | 指明提醒过期后需要显示的内容。 |
| snoozeContent | string | 否 | 指明延迟提醒时需要显示的内容。 |
| notificationId | number | 否 | 指明提醒使用的通知的id号,相同id号的提醒会覆盖。 |
| slotType | [ERROR:Invalid&nbsp;link:zh-cn_topic_0000001158696346.xml#xref39047351518,link:zh-cn_topic_0000001180018813.xml#section072355105110](zh-cn_topic_0000001180018813.xml#section072355105110) | 否 | 指明提醒的slot类型。 |
## ReminderRequestCalendar
......@@ -454,11 +509,13 @@ ReminderRequestCalendar extends ReminderRequest
日历实例对象,用于设置提醒的时间。
| 名称 | 参数类型 | 必填 | 说明 |
- 系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| dateTime | [LocalDateTime](#localdatetime) | 是 | 指明提醒的目标时间。 |
| repeatMonths | Array&lt;number&gt; | 否 | 指明重复提醒的月份。 |
| repeatDays | Array&lt;number&gt; | 否 | 指明重复提醒的日期。 |
| dateTime | [LocalDateTime](#localdatetime) | 是 | 指明提醒的目标时间。 |
| repeatMonths | Array&lt;number&gt; | 否 | 指明重复提醒的月份。 |
| repeatDays | Array&lt;number&gt; | 否 | 指明重复提醒的日期。 |
## ReminderRequestAlarm
......@@ -467,11 +524,13 @@ ReminderRequestAlarm extends ReminderRequest
闹钟实例对象,用于设置提醒的时间。
| 名称 | 参数类型 | 必填 | 说明 |
- 系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| hour | number | 是 | 指明提醒的目标时刻。 |
| minute | number | 是 | 指明提醒的目标分钟。 |
| daysOfWeek | Array&lt;number&gt; | 否 | 指明每周哪几天需要重复提醒。 |
| hour | number | 是 | 指明提醒的目标时刻。 |
| minute | number | 是 | 指明提醒的目标分钟。 |
| daysOfWeek | Array&lt;number&gt; | 否 | 指明每周哪几天需要重复提醒。 |
## ReminderRequestTimer
......@@ -480,20 +539,24 @@ ReminderRequestTimer extends ReminderRequest
倒计时实例对象,用于设置提醒的时间。
| 名称 | 参数类型 | 必填 | 说明 |
- 系统能力:SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| triggerTimeInSeconds | number | 是 | 指明倒计时的秒数。 |
| triggerTimeInSeconds | number | 是 | 指明倒计时的秒数。 |
## LocalDateTime
用于日历类提醒设置时指定时间信息。
| 名称 | 参数类型 | 必填 | 说明 |
- 系统能力:以下各项对应的系统能力均为SystemCapability.Notification.ReminderAgent
| 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| year | number | 是 | 年 |
| month | number | 是 | 月 |
| day | number | 是 | 日 |
| hour | number | 是 | 时 |
| minute | number | 是 | 分 |
| second | number | 否 | 秒 |
| year | number | 是 | 年 |
| month | number | 是 | 月 |
| day | number | 是 | 日 |
| hour | number | 是 | 时 |
| minute | number | 是 | 分 |
| second | number | 否 | 秒 |
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册