diff --git a/zh-cn/application-dev/reference/apis/js-apis-application-Want.md b/zh-cn/application-dev/reference/apis/js-apis-application-Want.md index 446d1e4c11c93ed7227b2e5ec2b086b18cb4cbdc..4b105bf5b338cd9dcac6f9cea8e021e08881f0db 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-application-Want.md +++ b/zh-cn/application-dev/reference/apis/js-apis-application-Want.md @@ -25,6 +25,6 @@ import Want from '@ohos.application.Want'; | 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值:
ohos.aafwk.pacallerPid 表示拉起方的pid。
ohos.aafwk.param.callerToken 表示拉起方的token。
ohos.aafwk.param.callerUid 表示发起方的uid。[Bundle](js-apis-Bundle.js)模块中userId参数,可用于获取应用信息、包信息等,具体参考:[Bundle](js-apis-Bundle.js)。 | +| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述,由开发者自行决定传入的键值对。默认会携带以下key值:
ohos.aafwk.callerPid 表示拉起方的pid。
ohos.aafwk.param.callerToken 表示拉起方的token。
ohos.aafwk.param.callerUid 表示发起方的uid。[Bundle](js-apis-Bundle.js)模块中userId参数,可用于获取应用信息、包信息等,具体参考:[Bundle](js-apis-Bundle.js)。 | | entities | 只读 | Array\ | 否 | 表示entities相关描述。 | | moduleName9+ | 只读 | string | 否 | 表示待启动的Ability所属的模块(module)。同一应用的不同hap的组件可能重名,仅通过BundleName和AbilityName无法区分时,可以通过设置moduleName加以区分,以匹配到指定的Ability。 | | diff --git a/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md b/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md index cb7465d2bd62bd69595f9e15559b86c0a7f3b5be..496ec17ba4000b70553b68fd0beac21b3b02957e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md +++ b/zh-cn/application-dev/reference/apis/js-apis-commonEvent.md @@ -16,20 +16,21 @@ import CommonEvent from '@ohos.commonEvent'; CommonEvent模块支持的事件类型。名称指的是系统公共事件宏;值指的是系统公共事件。 +**系统能力:** SystemCapability.Notification.CommonEvent + | 名称 | 值 | 订阅者所需权限 | 说明 | | ------------ | ------------------ | ---------------------- | -------------------- | | COMMON_EVENT_BOOT_COMPLETED | usual.event.BOOT_COMPLETED | ohos.permission.RECEIVER_STARTUP_COMPLETED | 指示用户已完成引导并加载系统的公共事件的操作。 | | COMMON_EVENT_LOCKED_BOOT_COMPLETED | usual.event.LOCKED_BOOT_COMPLETED | ohos.permission.RECEIVER_STARTUP_COMPLETED | 表示用户已完成引导,系统已加载,但屏幕仍锁定的公共事件的操作。 | | COMMON_EVENT_SHUTDOWN | usual.event.SHUTDOWN | 无 | 指示设备正在关闭并将继续最终关闭的公共事件的操作。 | | COMMON_EVENT_BATTERY_CHANGED | usual.event.BATTERY_CHANGED | 无 | 表示电池充电状态、电平和其他信息发生变化的公共事件的动作。 | -| COMMON_EVENT_BATTERY_LOW | usual.event.BATTERY_LOW | 无 | -表示电池电量低的普通事件的动作。 | +| COMMON_EVENT_BATTERY_LOW | usual.event.BATTERY_LOW | 无 | 表示电池电量低的普通事件的动作。 | | COMMON_EVENT_BATTERY_OKAY | usual.event.BATTERY_OKAY | 无 | 表示电池退出低电平状态的公共事件的动作。 | | COMMON_EVENT_POWER_CONNECTED | usual.event.POWER_CONNECTED | 无 | 设备连接到外部电源的公共事件的动作。 | | COMMON_EVENT_POWER_DISCONNECTED | usual.event.POWER_DISCONNECTED | 无 | 设备与外部电源断开的公共事件的动作。 | | COMMON_EVENT_SCREEN_OFF | usual.event.SCREEN_OFF | 无 | 指示设备屏幕关闭且设备处于睡眠状态的普通事件的动作。 | | COMMON_EVENT_SCREEN_ON | usual.event.SCREEN_ON | 无 | 指示设备屏幕打开且设备处于交互状态的公共事件的操作。 | -| COMMON_EVENT_THERMAL_LEVEL_CHANGED | usual.event.THERMAL_LEVEL_CHANGED | 无 | 指示设备热状态的公共事件的动作。 | +| COMMON_EVENT_THERMAL_LEVEL_CHANGED8+ | usual.event.THERMAL_LEVEL_CHANGED | 无 | 指示设备热状态的公共事件的动作。 | | COMMON_EVENT_USER_PRESENT | usual.event.USER_PRESENT | 无 | 用户解锁设备的公共事件的动作。 | | COMMON_EVENT_TIME_TICK | usual.event.TIME_TICK | 无 | 表示系统时间更改的公共事件的动作。 | | COMMON_EVENT_TIME_CHANGED | usual.event.TIME_CHANGED | 无 | 设置系统时间的公共事件的动作。 | @@ -158,16 +159,16 @@ CommonEvent模块支持的事件类型。名称指的是系统公共事件宏; | COMMON_EVENT_DISK_BAD_REMOVAL | usual.event.data.DISK_BAD_REMOVAL | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 外部存储设备状态变更为挂载状态下移除时发送此公共事件。 | | COMMON_EVENT_DISK_UNMOUNTABLE | usual.event.data.DISK_UNMOUNTABLE | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 外部存储设备状态变更为插卡情况下无法挂载时发送此公共事件。 | | COMMON_EVENT_DISK_EJECT | usual.event.data.DISK_EJECT | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 用户已表示希望删除外部存储介质时发送此公共事件。 | -| COMMON_EVENT_VOLUME_REMOVED | usual.event.data.VOLUME_REMOVED | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 外部存储设备状态变更为移除时发送此公共事件。 | -| COMMON_EVENT_VOLUME_UNMOUNTED | usual.event.data.VOLUME_UNMOUNTED | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 外部存储设备状态变更为卸载时发送此公共事件。 | -| COMMON_EVENT_VOLUME_MOUNTED | usual.event.data.VOLUME_MOUNTED | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 外部存储设备状态变更为挂载时发送此公共事件。 | -| COMMON_EVENT_VOLUME_BAD_REMOVAL | usual.event.data.VOLUME_BAD_REMOVAL | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 外部存储设备状态变更为挂载状态下移除时发送此公共事件。 | -| COMMON_EVENT_VOLUME_EJECT | usual.event.data.VOLUME_EJECT | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 用户已表示希望删除外部存储介质时发送此公共事件。 | +| COMMON_EVENT_VOLUME_REMOVED9+ | usual.event.data.VOLUME_REMOVED | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 外部存储设备状态变更为移除时发送此公共事件。 | +| COMMON_EVENT_VOLUME_UNMOUNTED9+ | usual.event.data.VOLUME_UNMOUNTED | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 外部存储设备状态变更为卸载时发送此公共事件。 | +| COMMON_EVENT_VOLUME_MOUNTED9+ | usual.event.data.VOLUME_MOUNTED | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 外部存储设备状态变更为挂载时发送此公共事件。 | +| COMMON_EVENT_VOLUME_BAD_REMOVAL9+ | usual.event.data.VOLUME_BAD_REMOVAL | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 外部存储设备状态变更为挂载状态下移除时发送此公共事件。 | +| COMMON_EVENT_VOLUME_EJECT9+ | usual.event.data.VOLUME_EJECT | ohos.permission.WRITE_USER_STORAGE 或 ohos.permission.READ_USER_STORAGE | 用户已表示希望删除外部存储介质时发送此公共事件。 | | COMMON_EVENT_VISIBLE_ACCOUNTS_UPDATED | usual.event.data.VISIBLE_ACCOUNTS_UPDATED | ohos.permission.GET_APP_ACCOUNTS | 表示帐户可见更改的公共事件的动作。 | | COMMON_EVENT_ACCOUNT_DELETED | usual.event.data.ACCOUNT_DELETED | ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS | 删除帐户的公共事件的动作。 | | COMMON_EVENT_FOUNDATION_READY | usual.event.data.FOUNDATION_READY | ohos.permission.RECEIVER_STARTUP_COMPLETED | 表示foundation已准备好的公共事件的动作。 | | COMMON_EVENT_AIRPLANE_MODE_CHANGED | usual.event.AIRPLANE_MODE | 无 | 表示设备飞行模式已更改的公共事件的动作。 | -| COMMON_EVENT_SPLIT_SCREEN | usual.event.SPLIT_SCREEN | ohos.permission.RECEIVER_SPLIT_SCREEN | 表示分屏的公共事件的动作。 | +| COMMON_EVENT_SPLIT_SCREEN8+ | usual.event.SPLIT_SCREEN | ohos.permission.RECEIVER_SPLIT_SCREEN | 表示分屏的公共事件的动作。 | ## CommonEvent.publish @@ -178,8 +179,6 @@ publish(event: string, callback: AsyncCallback\): void **系统能力:** SystemCapability.Notification.CommonEvent -**系统API**: 此接口为系统接口,三方应用不支持调用。 - **参数:** | 名称 | 读写属性 | 类型 | 必填 | 描述 | @@ -213,8 +212,6 @@ publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\ **系统能力:** SystemCapability.Notification.CommonEvent -**系统API**: 此接口为系统接口,三方应用不支持调用。 - **参数:** | 名称 | 读写属性 | 类型 | 必填 | 描述 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-notification.md b/zh-cn/application-dev/reference/apis/js-apis-notification.md index 4fe675e5337427cfd7e9efa09f8cad7ad851edc7..0fdd957d8aef4c598afeb621019dd1237326ce0c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-notification.md +++ b/zh-cn/application-dev/reference/apis/js-apis-notification.md @@ -2871,6 +2871,8 @@ cancelAsBundle(id: number, representativeBundle: string, userId: number): Promis **系统能力**:SystemCapability.Notification.Notification +**需要权限**: ohos.permission.NOTIFICATION_CONTROLLER,ohos.permission.NOTIFICATION_AGENT_CONTROLLER + **参数:** @@ -3024,12 +3026,14 @@ Notification.isNotificationSlotEnabled( ### onConsume -onConsume?:(data: [SubscribeCallbackData](#subscribecallbackdata)) +onConsume?: (data: [SubscribeCallbackData](#subscribecallbackdata)) => void 接收通知回调函数。 **系统能力**:SystemCapability.Notification.Notification +**系统API**: 此接口为系统接口,三方应用不支持调用。 + **参数:** | 参数名 | 类型 | 必填 | 说明 | @@ -3071,12 +3075,14 @@ Notification.subscribe(subscriber, subscribeCallback); ### onCancel -onCancel?:(data: [SubscribeCallbackData](#subscribecallbackdata)) +onCancel?:(data: [SubscribeCallbackData](#subscribecallbackdata)) => void 删除通知回调函数。 **系统能力**:SystemCapability.Notification.Notification +**系统API**: 此接口为系统接口,三方应用不支持调用。 + **参数:** | 参数名 | 类型 | 必填 | 说明 | @@ -3109,12 +3115,14 @@ Notification.subscribe(subscriber, subscribeCallback); ### onUpdate -onUpdate?:(data: [NotificationSortingMap](#notificationsortingmap)) +onUpdate?:(data: [NotificationSortingMap](#notificationsortingmap)) => void 更新通知排序回调函数。 **系统能力**:SystemCapability.Notification.Notification +**系统API**: 此接口为系统接口,三方应用不支持调用。 + **参数:** | 参数名 | 类型 | 必填 | 说明 | @@ -3145,12 +3153,14 @@ Notification.subscribe(subscriber, subscribeCallback); ### onConnect -onConnect?:void +onConnect?:() => void 注册订阅回调函数。 **系统能力**:SystemCapability.Notification.Notification +**系统API**: 此接口为系统接口,三方应用不支持调用。 + **示例:** ```javascript @@ -3175,12 +3185,14 @@ Notification.subscribe(subscriber, subscribeCallback); ### onDisconnect -onDisconnect?:void +onDisconnect?:() => void 取消订阅回调函数。 **系统能力**:SystemCapability.Notification.Notification +**系统API**: 此接口为系统接口,三方应用不支持调用。 + **示例:** ```javascript @@ -3205,12 +3217,14 @@ Notification.subscribe(subscriber, subscribeCallback); ### onDestroy -onDestroy?:void +onDestroy?:() => void 服务失联回调函数。 **系统能力**:SystemCapability.Notification.Notification +**系统API**: 此接口为系统接口,三方应用不支持调用。 + **示例:** ```javascript @@ -3235,12 +3249,14 @@ Notification.subscribe(subscriber, subscribeCallback); ### onDoNotDisturbDateChange8+ -onDoNotDisturbDateChange?:(mode: Notification.[DoNotDisturbDate](#donotdisturbdate8)) +onDoNotDisturbDateChange?:(mode: Notification.[DoNotDisturbDate](#donotdisturbdate8)) => void 免打扰时间选项变更回调函数。 **系统能力**:SystemCapability.Notification.Notification +**系统API**: 此接口为系统接口,三方应用不支持调用。 + **参数:** | 参数名 | 类型 | 必填 | 说明 | @@ -3271,12 +3287,14 @@ Notification.subscribe(subscriber, subscribeCallback); ### onEnabledNotificationChanged8+ -onEnabledNotificationChanged?:(callbackData: [EnabledNotificationCallbackData](#enablednotificationcallbackdata8)) +onEnabledNotificationChanged?:(callbackData: [EnabledNotificationCallbackData](#enablednotificationcallbackdata8)) => void 监听应用通知使能变化。 **系统能力**:SystemCapability.Notification.Notification +**系统API**: 此接口为系统接口,三方应用不支持调用。 + **参数:** | 参数名 | 类型 | 必填 | 说明 | @@ -3353,7 +3371,7 @@ Notification.subscribe(subscriber, subscribeCallback); **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification -**系统API**:此接口为系统接口,三方应用不支持调用。 +**系统API**: 此接口为系统接口,三方应用不支持调用。 | 名称 | 值 | 说明 | | ------------ | ---------------- | ------------------------------------------ | @@ -3556,13 +3574,13 @@ Notification.subscribe(subscriber, subscribeCallback); | creatorPid | 是 | 否 | number | 否 | 创建通知的PID。 | | creatorUserId8+| 是 | 否 | number | 否 | 创建通知的UserId。 | | hashCode | 是 | 否 | string | 否 | 通知唯一标识。 | -| classification | 是 | 是 | string | 否 | 通知分类。 | +| classification | 是 | 是 | string | 否 | 通知分类。
**系统API**: 此接口为系统接口,三方应用不支持调用。 | | groupName8+| 是 | 是 | string | 否 | 组通知名称。 | | template8+ | 是 | 是 | [NotificationTemplate](#notificationtemplate8) | 否 | 通知模板。 | -| isRemoveAllowed8+ | 是 | 否 | boolean | 否 | 通知是否能被移除。 | -| source8+ | 是 | 否 | number | 否 | 通知源。 | +| isRemoveAllowed8+ | 是 | 否 | boolean | 否 | 通知是否能被移除。
**系统API**: 此接口为系统接口,三方应用不支持调用。 | +| source8+ | 是 | 否 | number | 否 | 通知源。
**系统API**: 此接口为系统接口,三方应用不支持调用。 | | distributedOption8+ | 是 | 是 | [DistributedOptions](#distributedoptions8) | 否 | 分布式通知的选项。 | -| deviceId8+ | 是 | 否 | string | 否 | 通知源的deviceId。 | +| deviceId8+ | 是 | 否 | string | 否 | 通知源的deviceId。
**系统API**: 此接口为系统接口,三方应用不支持调用。 | | notificationFlags8+ | 是 | 否 | [NotificationFlags](#notificationflags8) | 否 | 获取NotificationFlags。 | @@ -3575,7 +3593,7 @@ Notification.subscribe(subscriber, subscribeCallback); | isDistributed | 是 | 是 | boolean | 否 | 是否为分布式通知。 | | supportDisplayDevices | 是 | 是 | Array\ | 是 | 可以同步通知到的设备类型。 | | supportOperateDevices | 是 | 是 | Array\ | 否 | 可以打开通知的设备。 | -| remindType | 是 | 否 | number | 否 | 通知的提醒方式。 | +| remindType | 是 | 否 | number | 否 | 通知的提醒方式。
**系统API**: 此接口为系统接口,三方应用不支持调用。 | ## NotificationSlot @@ -3602,7 +3620,7 @@ Notification.subscribe(subscriber, subscribeCallback); **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification -**系统API**:此接口为系统接口,三方应用不支持调用。 +**系统API**: 此接口为系统接口,三方应用不支持调用。 | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | -------- | ---- | --- | ------------------------------------- | ---- | ------------ | @@ -3627,7 +3645,7 @@ Notification.subscribe(subscriber, subscribeCallback); **系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification -**系统API**:此接口为系统接口,三方应用不支持调用。 +**系统API**: 此接口为系统接口,三方应用不支持调用。 | 名称 | 可读 | 可写 | 类型 | 必填 | 描述 | | ----------- | --- | ---- | --------------- | ---- | ------------------------------- | @@ -3658,7 +3676,7 @@ Notification.subscribe(subscriber, subscribeCallback); **系统能力**:SystemCapability.Notification.Notification -**系统API**:此接口为系统接口,三方应用不支持调用。 +**系统API**: 此接口为系统接口,三方应用不支持调用。 | 名称 | 值 | 描述 | | -------------------- | --- | --------------------------------- | @@ -3672,6 +3690,8 @@ Notification.subscribe(subscriber, subscribeCallback); **系统能力**:SystemCapability.Notification.Notification +**系统API**: 此接口为系统接口,三方应用不支持调用。 + | 名称 | 值 | 描述 | | -------------------- | --- | -------------------- | | TYPE_NORMAL | 0 | 一般通知。 |