Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 6f1eac15 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!18341 Fix consistency issues & error code issues of Notification 

Merge pull request !18341 from xuzhihao/master
上级 6bf486d6 0d6e6b76
展开全部 隐藏空白更改
内联 并排
Showing with 904 addition and 1447 deletion
zh-cn/application-dev/reference/apis/js-apis-commonEvent.md
浏览文件 @ 6f1eac15
......@@ -19,19 +19,20 @@ import CommonEvent from '@ohos.commonEvent';
全部系统公共事件枚举定义请参见[系统公共事件定义](./commonEvent-definitions.md)。
## CommonEvent.publish
## CommonEvent.publish<sup>(deprecated)</sup>
```ts
publish(event: string, callback: AsyncCallback<void>): void
```
publish(event: string, callback: AsyncCallback\<void>): void
发布公共事件（回调形式）。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[commonEventManager.publish](js-apis-commonEventManager.md#commoneventmanagerpublish)替代。
**系统能力：** `SystemCapability.Notification.CommonEvent`
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------- |
| event | string | 是 | 表示要发送的公共事件。 |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 |
......@@ -52,23 +53,24 @@ function publishCB(err) {
CommonEvent.publish("event", publishCB);
```
## CommonEvent.publish
## CommonEvent.publish<sup>(deprecated)</sup>
```ts
publish(event: string, options: CommonEventPublishData, callback: AsyncCallback<void>): void
```
publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\<void>): void
以回调的形式发布公共事件。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[commonEventManager.publish](js-apis-commonEventManager.md#commoneventmanagerpublish-1)替代。
**系统能力：** `SystemCapability.Notification.CommonEvent`
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------- |
| event | string | 是 | 表示要发布的公共事件。 |
| options | [CommonEventPublishData](./js-apis-inner-commonEvent-commonEventPublishData.md) | 是 | 表示发布公共事件的属性。 |
| callback | syncCallback\<void> | 是 | 表示被指定的回调方法。 |
| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 |
**示例：**
......@@ -94,21 +96,22 @@ function publishCB(err) {
CommonEvent.publish("event", options, publishCB);
```
## CommonEvent.publishAsUser<sup>8+</sup>
## CommonEvent.publishAsUser<sup>(deprecated)</sup>
```ts
publishAsUser(event: string, userId: number, callback: AsyncCallback<void>): void
```
publishAsUser(event: string, userId: number, callback: AsyncCallback\<void>): void
以回调的形式向指定用户发布公共事件。
> **说明：**
> 从 API version 8开始支持，从API version 9开始废弃。建议使用[commonEventManager.publishAsUser](js-apis-commonEventManager.md#commoneventmanagerpublishasuser)替代。
**系统能力：** `SystemCapability.Notification.CommonEvent`
**系统API**：此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | ---------------------------------- |
| event | string | 是 | 表示要发送的公共事件。 |
| userId | number | 是 | 表示指定向该用户ID发送此公共事件。 |
......@@ -133,21 +136,22 @@ let userId = 100;
CommonEvent.publishAsUser("event", userId, publishCB);
```
## CommonEvent.publishAsUser<sup>8+</sup>
## CommonEvent.publishAsUser<sup>(deprecated)</sup>
```ts
publishAsUser(event: string, userId: number, options: CommonEventPublishData, callback: AsyncCallback<void>): void
```
publishAsUser(event: string, userId: number, options: CommonEventPublishData, callback: AsyncCallback\<void>): void
以回调形式向指定用户发布公共事件并指定发布信息。
> **说明：**
> 从 API version 8开始支持，从API version 9开始废弃。建议使用[commonEventManager.publishAsUser](js-apis-commonEventManager.md#commoneventmanagerpublishasuser-1)替代。
**系统能力：** `SystemCapability.Notification.CommonEvent`
**系统API**：此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| -------- | ---------------------- | ---- | ---------------------- |
| event | string | 是 | 表示要发布的公共事件。 |
| userId | number | 是 | 表示指定向该用户ID发送此公共事件。 |
......@@ -180,19 +184,20 @@ let userId = 100;
CommonEvent.publishAsUser("event", userId, options, publishCB);
```
## CommonEvent.createSubscriber
## CommonEvent.createSubscriber<sup>(deprecated)</sup>
```ts
createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback<CommonEventSubscriber>): void
```
以回调形式创建订阅者。
> **说明：**
>从 API version 7开始支持，从API version 9开始废弃。建议使用[commonEventManager.createSubscriber](js-apis-commonEventManager.md#commoneventmanagercreatesubscriber)替代。
**系统能力：** `SystemCapability.Notification.CommonEvent`
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ------------- | ------------------------------------------------------------ | ---- | -------------------------- |
| subscribeInfo | [CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md) | 是 | 表示订阅信息。 |
| callback | AsyncCallback\<[CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md)> | 是 | 表示创建订阅者的回调方法。 |
......@@ -222,19 +227,20 @@ function createCB(err, commonEventSubscriber) {
CommonEvent.createSubscriber(subscribeInfo, createCB);
```
## CommonEvent.createSubscriber
## CommonEvent.createSubscriber<sup>(deprecated)</sup>
```ts
createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise<CommonEventSubscriber>
```
以Promise形式创建订阅者。
> **说明：**
>从 API version 7开始支持，从API version 9开始废弃。建议使用[commonEventManager.createSubscriber](js-apis-commonEventManager.md#commoneventmanagercreatesubscriber-1)替代。
**系统能力：** `SystemCapability.Notification.CommonEvent`
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ------------- | ----------------------------------------------------- | ---- | -------------- |
| subscribeInfo | [CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md) | 是 | 表示订阅信息。 |
......@@ -262,19 +268,20 @@ CommonEvent.createSubscriber(subscribeInfo).then((commonEventSubscriber) => {
});
```
## CommonEvent.subscribe
## CommonEvent.subscribe<sup>(deprecated)</sup>
```ts
subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback<CommonEventData>): void
```
以回调形式订阅公共事件。
> **说明：**
>从 API version 7开始支持，从API version 9开始废弃。建议使用[commonEventManager.subscribe](js-apis-commonEventManager.md#commoneventmanagersubscribe)替代。
**系统能力：** `SystemCapability.Notification.CommonEvent`
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ---------- | ---------------------------------------------------- | ---- | -------------------------------- |
| subscriber | [CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md) | 是 | 表示订阅者对象。 |
| callback | AsyncCallback\<[CommonEventData](./js-apis-inner-commonEvent-commonEventData.md)> | 是 | 表示接收公共事件数据的回调函数。 |
......@@ -314,19 +321,20 @@ function createCB(err, commonEventSubscriber) {
CommonEvent.createSubscriber(subscribeInfo, createCB);
```
## CommonEvent.unsubscribe
## CommonEvent.unsubscribe<sup>(deprecated)</sup>
```ts
unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback<void>): void
```
unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>): void
以回调形式取消订阅公共事件。
> **说明：**
>从 API version 7开始支持，从API version 9开始废弃。建议使用[commonEventManager.subscribe](js-apis-commonEventManager.md#commoneventmanagerunsubscribe)替代。
**系统能力：** `SystemCapability.Notification.CommonEvent`
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| 名称 | 类型 | 必填 | 说明 |
| ---------- | ----------------------------------------------- | ---- | ------------------------ |
| subscriber | [CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md) | 是 | 表示订阅者对象。 |
| callback | AsyncCallback\<void> | 否 | 表示取消订阅的回调方法。 |
......
zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md
浏览文件 @ 6f1eac15
......@@ -20,7 +20,7 @@ import CommonEventManager from '@ohos.commonEventManager';
## CommonEventManager.publish
publish(event: string, callback: AsyncCallback<void>): void
publish(event: string, callback: AsyncCallback\<void>): void
发布公共事件，并在发布后执行相应的回调函数。
......@@ -39,7 +39,6 @@ publish(event: string, callback: AsyncCallback<void>): void
| 错误码ID | 错误信息 |
| -------- | ----------------------------------- |
| 401 | The parameter check failed. |
| 1500004 | not System services. |
| 1500007 | error sending message to Common Event Service. |
| 1500008 | Common Event Service does not complete initialization. |
......@@ -67,7 +66,7 @@ try {
## CommonEventManager.publish
publish(event: string, options: CommonEventPublishData, callback: AsyncCallback<void>): void
publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\<void>): void
以回调的形式发布公共事件。
......@@ -87,7 +86,6 @@ publish(event: string, options: CommonEventPublishData, callback: AsyncCallback<
| 错误码ID | 错误信息 |
| -------- | ----------------------------------- |
| 401 | The parameter check failed. |
| 1500004 | not System services. |
| 1500007 | error sending message to Common Event Service. |
| 1500008 | Common Event Service does not complete initialization. |
......@@ -122,7 +120,7 @@ try {
## CommonEventManager.publishAsUser<sup>
publishAsUser(event: string, userId: number, callback: AsyncCallback<void>): void
publishAsUser(event: string, userId: number, callback: AsyncCallback\<void>): void
以回调的形式向指定用户发布公共事件。
......@@ -144,8 +142,6 @@ publishAsUser(event: string, userId: number, callback: AsyncCallback<void>): voi
| 错误码ID | 错误信息 |
| -------- | ----------------------------------- |
| 202 | not system app. |
| 401 | The parameter check failed. |
| 1500004 | not System services. |
| 1500007 | error sending message to Common Event Service. |
| 1500008 | Common Event Service does not complete initialization. |
......@@ -176,7 +172,7 @@ try {
## CommonEventManager.publishAsUser
publishAsUser(event: string, userId: number, options: CommonEventPublishData, callback: AsyncCallback<void>): void
publishAsUser(event: string, userId: number, options: CommonEventPublishData, callback: AsyncCallback\<void>): void
以回调形式向指定用户发布公共事件并指定发布信息。
......@@ -199,9 +195,7 @@ publishAsUser(event: string, userId: number, options: CommonEventPublishData, ca
| 错误码ID | 错误信息 |
| -------- | ----------------------------------- |
| 202 | not system app. |
| 401 | The parameter check failed. |
| 1500004 | not System services. |
| 1500004 | not System services or System app. |
| 1500007 | error sending message to Common Event Service. |
| 1500008 | Common Event Service does not complete initialization. |
| 1500009 | error obtaining system parameters. |
......@@ -238,7 +232,7 @@ try {
## CommonEventManager.createSubscriber
createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback<CommonEventSubscriber>): void
createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback\<CommonEventSubscriber>): void
以回调形式创建订阅者。
......@@ -251,17 +245,8 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallbac
| subscribeInfo | [CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md) | 是 | 表示订阅信息。 |
| callback | AsyncCallback\<[CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md)> | 是 | 表示创建订阅者的回调方法。 |
**错误码：**
错误码介绍请参考[@ohos.commonEventManager(事件)](../errorcodes/errorcode-CommonEventService.md)
| 错误码ID | 错误信息 |
| -------- | ----------------------------------- |
| 401 | The parameter check failed. |
**示例：**
```ts
let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
......@@ -290,7 +275,7 @@ try {
## CommonEventManager.createSubscriber
createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise<CommonEventSubscriber>
createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\<CommonEventSubscriber>
以Promise形式创建订阅者。
......@@ -307,14 +292,6 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise<CommonEventSu
| --------------------------------------------------------- | ---------------- |
| Promise\<[CommonEventSubscriber](./js-apis-inner-commonEvent-commonEventSubscriber.md)> | 返回订阅者对象。 |
**错误码：**
错误码介绍请参考[@ohos.commonEventManager(事件)](../errorcodes/errorcode-CommonEventService.md)
| 错误码ID | 错误信息 |
| -------- | ----------------------------------- |
| 401 | The parameter check failed. |
**示例：**
```ts
......@@ -337,7 +314,7 @@ CommonEventManager.createSubscriber(subscribeInfo).then((commonEventSubscriber)
## CommonEventManager.subscribe
subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback<CommonEventData>): void
subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEventData>): void
以回调形式订阅公共事件。
......@@ -356,7 +333,6 @@ subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback<CommonEvent
| 错误码ID | 错误信息 |
| -------- | ----------------------------------- |
| 401 | The parameter check failed. |
| 801 | capability not supported. |
| 1500007 | error sending message to Common Event Service. |
| 1500008 | Common Event Service does not complete initialization. |
......@@ -407,7 +383,7 @@ try {
## CommonEventManager.unsubscribe
unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback<void>): void
unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>): void
以回调形式取消订阅公共事件。
......@@ -426,7 +402,6 @@ unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback<void>):
| 错误码ID | 错误信息 |
| -------- | ----------------------------------- |
| 401 | The parameter check failed. |
| 801 | capability not supported. |
| 1500007 | error sending message to Common Event Service. |
| 1500008 | Common Event Service does not complete initialization. |
......@@ -487,7 +462,7 @@ try {
## CommonEventManager.removeStickyCommonEvent<sup>10+</sup>
removeStickyCommonEvent(event: string, callback: AsyncCallback<void>): void
removeStickyCommonEvent(event: string, callback: AsyncCallback\<void>): void
以回调形式移除粘性公共事件。
......@@ -495,6 +470,8 @@ removeStickyCommonEvent(event: string, callback: AsyncCallback<void>): void
**需要权限**: ohos.permission.COMMONEVENT_STICKY
**系统API**：此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -508,12 +485,9 @@ removeStickyCommonEvent(event: string, callback: AsyncCallback<void>): void
| 错误码ID | 错误信息 |
| -------- | ----------------------------------- |
| 201 | The application dose not have permission to call the interface. |
| 202 | not system app. |
| 401 | The parameter check failed. |
| 1500004 | not system service. |
| 1500007 | The message send error. |
| 1500008 | The CEMS error. |
| 1500007 | error sending message to Common Event Service. |
| 1500008 | Common Event Service does not complete initialization. |
**示例：**
......@@ -525,13 +499,12 @@ CommonEventManager.removeStickyCommonEvent("sticky_event", (err) => {
return;
}
console.info(`Remove sticky event AsyncCallback success`);
}
});
```
## CommonEventManager.removeStickyCommonEvent<sup>10+</sup>
removeStickyCommonEvent(event: string): Promise<void>
removeStickyCommonEvent(event: string): Promise\<void>
以Promise形式移除粘性公共事件。
......@@ -539,6 +512,8 @@ removeStickyCommonEvent(event: string): Promise<void>
**需要权限**: ohos.permission.COMMONEVENT_STICKY
**系统API**：此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
......@@ -557,18 +532,15 @@ removeStickyCommonEvent(event: string): Promise<void>
| 错误码ID | 错误信息 |
| -------- | ----------------------------------- |
| 201 | The application dose not have permission to call the interface. |
| 202 | not system app. |
| 401 | The parameter check failed. |
| 1500004 | not system service. |
| 1500007 | The message send error. |
| 1500008 | The CEMS error. |
| 1500007 | error sending message to Common Event Service. |
| 1500008 | Common Event Service does not complete initialization. |
**示例：**
```ts
commonEventManager.removeStickyCommonEvent("sticky_event").then(() => {
CommonEventManager.removeStickyCommonEvent("sticky_event").then(() => {
console.info(`Remove sticky event AsyncCallback success`);
}).catch ((err) => {
console.info(`Remove sticky event AsyncCallback failed, errCode: ${err.code}, errMes: ${err.message}`);
......
zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventData.md
浏览文件 @ 6f1eac15
# CommonEventData
> **说明：**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
**系统能力：** `SystemCapability.Notification.CommonEvent`
| 名称 | 类型 | 可读 | 可写 | 说明 |
......
zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventPublishData.md
浏览文件 @ 6f1eac15
# CommonEventPublishData
> **说明：**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
**系统能力：** `SystemCapability.Notification.CommonEvent`
| 名称 | 类型 | 可读 | 可写 | 说明 |
......
zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscribeInfo.md
浏览文件 @ 6f1eac15
# CommonEventSubscribeInfo
> **说明：**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
**系统能力：** `SystemCapability.Notification.CommonEvent`
| 名称 | 类型 | 可读 | 可写 | 说明 |
......
zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscriber.md
浏览文件 @ 6f1eac15
# CommonEventSubscriber
## getCode
> **说明：**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 使用说明
在使用CommonEventSubscriber的功能前，需要通过CommonEvent.createSubscriber获取subscriber对象。
```ts
getCode(callback: AsyncCallback<number>): void
import CommonEvent from '@ohos.commonEvent';
let subscriber; // 用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
// 订阅者信息
let subscribeInfo = {
events: ["event"]
};
// 创建订阅者回调
function createCB(err, commonEventSubscriber) {
if (err.code) {
console.error(`createSubscriber failed, code is ${err.code}`);
} else {
console.info("createSubscriber");
subscriber = commonEventSubscriber;
}
}
// 创建订阅者
CommonEvent.createSubscriber(subscribeInfo, createCB);
```
## getCode
getCode(callback: AsyncCallback\<number>): void
以回调形式获取公共事件代码。
**系统能力**：`SystemCapability.Notification.CommonEvent`
......@@ -19,8 +48,6 @@ getCode(callback: AsyncCallback<number>): void
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
//获取有序公共事件代码回调
function getCodeCB(err, code) {
if (err.code) {
......@@ -34,9 +61,7 @@ subscriber.getCode(getCodeCB);
## getCode
```ts
getCode(): Promise<number>
```
getCode(): Promise\<number>
以Promise形式获取公共事件代码。
......@@ -51,8 +76,6 @@ getCode(): Promise<number>
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
subscriber.getCode().then((code) => {
console.info("getCode " + JSON.stringify(code));
}).catch((err) => {
......@@ -62,9 +85,7 @@ subscriber.getCode().then((code) => {
## setCode
```ts
setCode(code: number, callback: AsyncCallback<void>): void
```
setCode(code: number, callback: AsyncCallback\<void>): void
以回调形式设置公共事件的代码。
......@@ -80,8 +101,6 @@ setCode(code: number, callback: AsyncCallback<void>): void
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
//设置有序公共事件的代码回调
function setCodeCB(err) {
if (err.code) {
......@@ -95,9 +114,7 @@ subscriber.setCode(1, setCodeCB);
## setCode
```ts
setCode(code: number): Promise<void>
```
setCode(code: number): Promise\<void>
以Promise形式设置公共事件的代码。
......@@ -118,8 +135,6 @@ setCode(code: number): Promise<void>
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
subscriber.setCode(1).then(() => {
console.info("setCode");
}).catch((err) => {
......@@ -129,9 +144,7 @@ subscriber.setCode(1).then(() => {
## getData
```ts
getData(callback: AsyncCallback<string>): void
```
getData(callback: AsyncCallback\<string>): void
以回调形式获取公共事件的数据。
......@@ -146,8 +159,6 @@ getData(callback: AsyncCallback<string>): void
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
//获取有序公共事件代码数据回调
function getDataCB(err, data) {
if (err.code) {
......@@ -161,9 +172,7 @@ subscriber.getData(getDataCB);
## getData
```ts
getData(): Promise<string>
```
getData(): Promise\<string>
以Promise形式获取公共事件的数据。
......@@ -178,8 +187,6 @@ getData(): Promise<string>
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
subscriber.getData().then((data) => {
console.info("getData " + JSON.stringify(data));
}).catch((err) => {
......@@ -205,8 +212,6 @@ setData(data: string, callback: AsyncCallback\<void>): void
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
//设置有序公共事件的结果数据回调
function setDataCB(err) {
if (err.code) {
......@@ -220,9 +225,7 @@ subscriber.setData("publish_data_changed", setDataCB);
## setData
```ts
setData(data: string): Promise<void>
```
setData(data: string): Promise\<void>
以Promise形式设置公共事件的果数据。
......@@ -243,8 +246,6 @@ setData(data: string): Promise<void>
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
subscriber.setData("publish_data_changed").then(() => {
console.info("setData");
}).catch((err) => {
......@@ -254,9 +255,7 @@ subscriber.setData("publish_data_changed").then(() => {
## setCodeAndData
```ts
setCodeAndData(code: number, data: string, callback:AsyncCallback<void>): void
```
setCodeAndData(code: number, data: string, callback:AsyncCallback\<void>): void
以回调形式设置公共事件代码和数据。
......@@ -273,8 +272,6 @@ setCodeAndData(code: number, data: string, callback:AsyncCallback<void>): void
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
//设置有序公共事件的代码和数据回调
function setCodeDataCB(err) {
if (err.code) {
......@@ -288,9 +285,7 @@ subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCB);
## setCodeAndData
```ts
setCodeAndData(code: number, data: string): Promise<void>
```
setCodeAndData(code: number, data: string): Promise\<void>
以Promise形式设置公共事件的代码和数据。
......@@ -312,8 +307,6 @@ setCodeAndData(code: number, data: string): Promise<void>
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
subscriber.setCodeAndData(1, "publish_data_changed").then(() => {
console.info("setCodeAndData");
}).catch((err) => {
......@@ -323,9 +316,7 @@ subscriber.setCodeAndData(1, "publish_data_changed").then(() => {
## isOrderedCommonEvent
```ts
isOrderedCommonEvent(callback: AsyncCallback<boolean>): void
```
isOrderedCommonEvent(callback: AsyncCallback\<boolean>): void
以回调形式查询当前公共事件的是否为有序公共事件。
......@@ -342,8 +333,6 @@ isOrderedCommonEvent(callback: AsyncCallback<boolean>): void
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
//获取当前公共事件是否为有序事件的回调
function isOrderedCB(err, isOrdered) {
if (err.code) {
......@@ -357,9 +346,7 @@ subscriber.isOrderedCommonEvent(isOrderedCB);
## isOrderedCommonEvent
```ts
isOrderedCommonEvent(): Promise<boolean>
```
isOrderedCommonEvent(): Promise\<boolean>
以Promise形式查询当前公共事件的是否为有序公共事件。
......@@ -376,8 +363,6 @@ isOrderedCommonEvent(): Promise<boolean>
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
subscriber.isOrderedCommonEvent().then((isOrdered) => {
console.info("isOrdered " + JSON.stringify(isOrdered));
}).catch((err) => {
......@@ -387,9 +372,7 @@ subscriber.isOrderedCommonEvent().then((isOrdered) => {
## isStickyCommonEvent
```ts
isStickyCommonEvent(callback: AsyncCallback<boolean>): void
```
isStickyCommonEvent(callback: AsyncCallback\<boolean>): void
以回调形式检查当前公共事件是否为一个粘性事件。
......@@ -406,8 +389,6 @@ isStickyCommonEvent(callback: AsyncCallback<boolean>): void
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
//获取当前公共事件是否为粘性事件的回调
function isStickyCB(err, isSticky) {
if (err.code) {
......@@ -421,9 +402,7 @@ subscriber.isStickyCommonEvent(isStickyCB);
## isStickyCommonEvent
```ts
isStickyCommonEvent(): Promise<boolean>
```
isStickyCommonEvent(): Promise\<boolean>
以Promise形式检查当前公共事件是否为一个粘性事件。
......@@ -440,8 +419,6 @@ isStickyCommonEvent(): Promise<boolean>
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
subscriber.isStickyCommonEvent().then((isSticky) => {
console.info("isSticky " + JSON.stringify(isSticky));
}).catch((err) => {
......@@ -451,9 +428,7 @@ subscriber.isStickyCommonEvent().then((isSticky) => {
## abortCommonEvent
```ts
abortCommonEvent(callback: AsyncCallback<void>): void
```
abortCommonEvent(callback: AsyncCallback\<void>): void
以回调形式取消当前的有序公共事件，取消后，有序公共事件不再向下一个订阅者传递。
......@@ -468,8 +443,6 @@ abortCommonEvent(callback: AsyncCallback<void>): void
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
//取消当前有序公共事件的回调
function abortCB(err) {
if (err.code) {
......@@ -483,9 +456,7 @@ subscriber.abortCommonEvent(abortCB);
## abortCommonEvent
```ts
abortCommonEvent(): Promise<void>
```
abortCommonEvent(): Promise\<void>
以Promise形式取消当前的有序公共事件，取消后，公共事件不再向下一个订阅者传递。
......@@ -500,8 +471,6 @@ abortCommonEvent(): Promise<void>
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
subscriber.abortCommonEvent().then(() => {
console.info("abortCommonEvent");
}).catch((err) => {
......@@ -511,9 +480,7 @@ subscriber.abortCommonEvent().then(() => {
## clearAbortCommonEvent
```ts
clearAbortCommonEvent(callback: AsyncCallback<void>): void
```
clearAbortCommonEvent(callback: AsyncCallback\<void>): void
以回调形式清除当前有序公共事件。
......@@ -528,8 +495,6 @@ clearAbortCommonEvent(callback: AsyncCallback<void>): void
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
//清除当前公共事件取消状态的回调
function clearAbortCB(err) {
if (err.code) {
......@@ -543,9 +508,7 @@ subscriber.clearAbortCommonEvent(clearAbortCB);
## clearAbortCommonEvent
```ts
clearAbortCommonEvent(): Promise<void>
```
clearAbortCommonEvent(): Promise\<void>
以Promise形式清除当前有序公共事件。
......@@ -560,8 +523,6 @@ clearAbortCommonEvent(): Promise<void>
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
subscriber.clearAbortCommonEvent().then(() => {
console.info("clearAbortCommonEvent");
}).catch((err) => {
......@@ -571,9 +532,7 @@ subscriber.clearAbortCommonEvent().then(() => {
## getAbortCommonEvent
```ts
getAbortCommonEvent(callback: AsyncCallback<boolean>): void
```
getAbortCommonEvent(callback: AsyncCallback\<boolean>): void
以回调形式获取当前有序公共事件是否取消的状态。
......@@ -588,8 +547,6 @@ getAbortCommonEvent(callback: AsyncCallback<boolean>): void
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
//获取当前有序公共事件是否取消的回调
function getAbortCB(err, abortEvent) {
if (err.code) {
......@@ -603,9 +560,7 @@ subscriber.getAbortCommonEvent(getAbortCB);
## getAbortCommonEvent
```ts
getAbortCommonEvent(): Promise<boolean>
```
getAbortCommonEvent(): Promise\<boolean>
以Promise形式获取当前有序公共事件是否取消的状态。
......@@ -620,8 +575,6 @@ getAbortCommonEvent(): Promise<boolean>
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
subscriber.getAbortCommonEvent().then((abortEvent) => {
console.info("abortCommonEvent " + JSON.stringify(abortEvent));
}).catch((err) => {
......@@ -631,9 +584,7 @@ subscriber.getAbortCommonEvent().then((abortEvent) => {
## getSubscribeInfo
```ts
getSubscribeInfo(callback: AsyncCallback<CommonEventSubscribeInfo>): void
```
getSubscribeInfo(callback: AsyncCallback\<CommonEventSubscribeInfo>): void
以回调形式获取订阅者的订阅信息。
......@@ -648,8 +599,6 @@ getSubscribeInfo(callback: AsyncCallback<CommonEventSubscribeInfo>): void
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
//获取订阅者信息回调
function getCB(err, subscribeInfo) {
if (err.code) {
......@@ -663,9 +612,7 @@ subscriber.getSubscribeInfo(getCB);
## getSubscribeInfo
```ts
getSubscribeInfo(): Promise<CommonEventSubscribeInfo>
```
getSubscribeInfo(): Promise\<CommonEventSubscribeInfo>
以Promise形式获取订阅者的订阅信息。
......@@ -680,8 +627,6 @@ getSubscribeInfo(): Promise<CommonEventSubscribeInfo>
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
subscriber.getSubscribeInfo().then((subscribeInfo) => {
console.info("subscribeInfo " + JSON.stringify(subscribeInfo));
}).catch((err) => {
......@@ -691,9 +636,7 @@ subscriber.getSubscribeInfo().then((subscribeInfo) => {
## finishCommonEvent<sup>9+</sup>
```ts
finishCommonEvent(callback: AsyncCallback<void>): void
```
finishCommonEvent(callback: AsyncCallback\<void>): void
以回调形式结束当前有序公共事件。
......@@ -708,14 +651,13 @@ finishCommonEvent(callback: AsyncCallback<void>): void
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
//结束当前有序公共事件的回调
function finishCB(err) {
if (err.code) {
console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else {
} else {
console.info("FinishCommonEvent");
}
}
subscriber.finishCommonEvent(finishCB);
......@@ -723,9 +665,7 @@ subscriber.finishCommonEvent(finishCB);
## finishCommonEvent<sup>9+</sup>
```ts
finishCommonEvent(): Promise<void\>
```
finishCommonEvent(): Promise\<void>
以Promise形式结束当前有序公共事件。
......@@ -740,8 +680,6 @@ finishCommonEvent(): Promise<void\>
**示例：**
```ts
let subscriber; //创建成功的订阅者对象
subscriber.finishCommonEvent().then(() => {
console.info("FinishCommonEvent");
}).catch((err) => {
......
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationActionButton.md
浏览文件 @ 6f1eac15
......@@ -8,9 +8,9 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| --------- | ----------------------------------------------- | --- | ---- | ------------------------- |
| title | string | 是 | 是 | 按钮标题。 |
| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 是 | 是 | 点击按钮时触发的WantAgent。 |
| extras | { [key: string]: any } | 是 | 是 | 按钮扩展信息。 |
| userInput<sup>8+</sup> | [NotificationUserInput](js-apis-inner-notification-notificationUserInput.md) | 是 | 是 | 用户输入对象实例。 |
| title | string | 否 | 是 | 按钮标题。 |
| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 否 | 是 | 点击按钮时触发的WantAgent。 |
| extras | { [key: string]: any } | 否 | 否 | 按钮扩展信息。 |
| userInput<sup>8+</sup> | [NotificationUserInput](js-apis-inner-notification-notificationUserInput.md) | 否 | 否 | 用户输入对象实例。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationCommonDef.md
浏览文件 @ 6f1eac15
......@@ -10,7 +10,7 @@ BundleOption模块为指定应用的包信息。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 必填 | 说明 |
| ------ | ------ |---- | ------ |
| bundle | string | 是 | 应用的包信息。 |
| uid | number | 否 | 用户ID。 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| ------ | ------ | ---- | ---- | ------ |
| bundle | string | 否 | 是 | 应用的包信息。 |
| uid | number | 否 | 否 | 用户ID。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationContent.md
浏览文件 @ 6f1eac15
......@@ -8,13 +8,13 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| ----------- | ------------------------------------------------------------ | ---- | --- | ------------------ |
| contentType | [ContentType](./js-apis-notificationManager.md#contenttype) | 是 | 是 | 通知内容类型。 |
| normal | [NotificationBasicContent](#notificationbasiccontent) | 是 | 是 | 基本类型通知内容。 |
| longText | [NotificationLongTextContent](#notificationlongtextcontent) | 是 | 是 | 长文本类型通知内容。 |
| multiLine | [NotificationMultiLineContent](#notificationmultilinecontent) | 是 | 是 | 多行类型通知内容。 |
| picture | [NotificationPictureContent](#notificationpicturecontent) | 是 | 是 | 图片类型通知内容。 |
| contentType | [ContentType](./js-apis-notificationManager.md#contenttype) | 否 | 是 | 通知内容类型。 |
| normal | [NotificationBasicContent](#notificationbasiccontent) | 否 | 否 | 基本类型通知内容。 |
| longText | [NotificationLongTextContent](#notificationlongtextcontent) | 否 | 否 | 长文本类型通知内容。 |
| multiLine | [NotificationMultiLineContent](#notificationmultilinecontent) | 否 | 否 | 多行类型通知内容。 |
| picture | [NotificationPictureContent](#notificationpicturecontent) | 否 | 否 | 图片类型通知内容。 |
## NotificationBasicContent
......@@ -22,11 +22,11 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| -------------- | ------ | ---- | ---- | ---------------------------------- |
| title | string | 是 | 是 | 通知标题。 |
| text | string | 是 | 是 | 通知内容。 |
| additionalText | string | 是 | 是 | 通知附加内容，是对通知内容的补充。 |
| title | string | 否 | 是 | 通知标题。 |
| text | string | 否 | 是 | 通知内容。 |
| additionalText | string | 否 | 否 | 通知附加内容，是对通知内容的补充。 |
## NotificationLongTextContent
......@@ -35,14 +35,14 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| -------------- | ------ | ---- | --- | -------------------------------- |
| title | string | 是 | 是 | 通知标题。 |
| text | string | 是 | 是 | 通知内容。 |
| additionalText | string | 是 | 是 | 通知附加内容，是对通知内容的补充。 |
| longText | string | 是 | 是 | 通知的长文本。 |
| briefText | string | 是 | 是 | 通知概要内容，是对通知内容的总结。 |
| expandedTitle | string | 是 | 是 | 通知展开时的标题。 |
| title | string | 否 | 是 | 通知标题。 |
| text | string | 否 | 是 | 通知内容。 |
| additionalText | string | 否 | 否 | 通知附加内容，是对通知内容的补充。 |
| longText | string | 否 | 是 | 通知的长文本。 |
| briefText | string | 否 | 是 | 通知概要内容，是对通知内容的总结。 |
| expandedTitle | string | 否 | 是 | 通知展开时的标题。 |
## NotificationMultiLineContent
......@@ -53,12 +53,12 @@
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------- | --------------- | --- | --- | -------------------------------- |
| title | string | 是 | 是 | 通知标题。 |
| text | string | 是 | 是 | 通知内容。 |
| additionalText | string | 是 | 是 | 通知附加内容，是对通知内容的补充。 |
| briefText | string | 是 | 是 | 通知概要内容，是对通知内容的总结。 |
| longTitle | string | 是 | 是 | 通知展开时的标题。 |
| lines | Array\<string\> | 是 | 是 | 通知的多行文本。 |
| title | string | 否 | 是 | 通知标题。 |
| text | string | 否 | 是 | 通知内容。 |
| additionalText | string | 否 | 否 | 通知附加内容，是对通知内容的补充。 |
| briefText | string | 否 | 是 | 通知概要内容，是对通知内容的总结。 |
| longTitle | string | 否 | 是 | 通知展开时的标题。 |
| lines | Array\<string\> | 否 | 是 | 通知的多行文本。 |
## NotificationPictureContent
......@@ -69,9 +69,9 @@
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------- | -------------- | ---- | --- | -------------------------------- |
| title | string | 是 | 是 | 通知标题。 |
| text | string | 是 | 是 | 通知内容。 |
| additionalText | string | 是 | 是 | 通知附加内容，是对通知内容的补充。 |
| briefText | string | 是 | 是 | 通知概要内容，是对通知内容的总结。 |
| expandedTitle | string | 是 | 是 | 通知展开时的标题。 |
| picture | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | 是 | 通知的图片内容。 |
| title | string | 否 | 是 | 通知标题。 |
| text | string | 否 | 是 | 通知内容。 |
| additionalText | string | 否 | 否 | 通知附加内容，是对通知内容的补充。 |
| briefText | string | 否 | 是 | 通知概要内容，是对通知内容的总结。 |
| expandedTitle | string | 否 | 是 | 通知展开时的标题。 |
| picture | [image.PixelMap](js-apis-image.md#pixelmap7) | 否 | 是 | 通知的图片内容。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationFlags.md
浏览文件 @ 6f1eac15
......@@ -8,7 +8,7 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| ---------------- | ---------------------- | ---- | ---- | --------------------------------- |
| soundEnabled | [NotificationFlagStatus](#notificationflagstatus) | 是 | 否 | 是否启用声音提示。 |
| vibrationEnabled | [NotificationFlagStatus](#notificationflagstatus) | 是 | 否 | 是否启用振动提醒功能。 |
......
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationRequest.md
浏览文件 @ 6f1eac15
......@@ -8,45 +8,45 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| --------------------- | --------------------------------------------- | ---- | --- | -------------------------- |
| content | [NotificationContent](js-apis-inner-notification-notificationContent.md#notificationcontent) | 是 | 是 | 通知内容。 |
| id | number | 是 | 是 | 通知ID。 |
| slotType | [SlotType](js-apis-notificationManager.md#slottype) | 是 | 是 | 通道类型。 |
| isOngoing | boolean | 是 | 是 | 是否进行时通知。 |
| isUnremovable | boolean | 是 | 是 | 是否可移除。 |
| deliveryTime | number | 是 | 是 | 通知发送时间。 |
| tapDismissed | boolean | 是 | 是 | 通知是否自动清除。 |
| autoDeletedTime | number | 是 | 是 | 自动清除的时间。 |
| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 是 | 是 | WantAgent封装了应用的行为意图，点击通知时触发该行为。 |
| extraInfo | {[key: string]: any} | 是 | 是 | 扩展参数。 |
| color | number | 是 | 是 | 通知背景颜色。预留能力，暂未支持。 |
| colorEnabled | boolean | 是 | 是 | 通知背景颜色是否使能。预留能力，暂未支持。 |
| isAlertOnce | boolean | 是 | 是 | 设置是否仅有一次此通知提醒。 |
| isStopwatch | boolean | 是 | 是 | 是否显示已用时间。 |
| isCountDown | boolean | 是 | 是 | 是否显示倒计时时间。 |
| isFloatingIcon | boolean | 是 | 是 | 是否显示状态栏图标。 |
| label | string | 是 | 是 | 通知标签。 |
| badgeIconStyle | number | 是 | 是 | 通知角标类型。预留能力，暂未支持。 |
| showDeliveryTime | boolean | 是 | 是 | 是否显示分发时间。 |
| actionButtons | Array\<[NotificationActionButton](js-apis-inner-notification-notificationActionButton.md)\> | 是 | 是 | 通知按钮，最多三个按钮。 |
| smallIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | 是 | 通知小图标。可选字段，大小不超过30KB。 |
| largeIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 是 | 是 | 通知大图标。可选字段，大小不超过30KB。 |
| content | [NotificationContent](js-apis-inner-notification-notificationContent.md#notificationcontent) | 否 | 是 | 通知内容。 |
| id | number | 否 | 否 | 通知ID。 |
| slotType | [SlotType](js-apis-notificationManager.md#slottype) | 是 | 否 | 通道类型。 |
| isOngoing | boolean | 否 | 否 | 是否进行时通知。 |
| isUnremovable | boolean | 否 | 否 | 是否可移除。 |
| deliveryTime | number | 否 | 否 | 通知发送时间。 |
| tapDismissed | boolean | 否 | 否 | 通知是否自动清除。 |
| autoDeletedTime | number | 否 | 否 | 自动清除的时间。 |
| wantAgent | [WantAgent](js-apis-app-ability-wantAgent.md) | 否 | 否 | WantAgent封装了应用的行为意图，点击通知时触发该行为。 |
| extraInfo | {[key: string]: any} | 否 | 否 | 扩展参数。 |
| color | number | 否 | 否 | 通知背景颜色。预留能力，暂未支持。 |
| colorEnabled | boolean | 否 | 否 | 通知背景颜色是否使能。预留能力，暂未支持。 |
| isAlertOnce | boolean | 否 | 否 | 设置是否仅有一次此通知提醒。 |
| isStopwatch | boolean | 否 | 否 | 是否显示已用时间。 |
| isCountDown | boolean | 否 | 否 | 是否显示倒计时时间。 |
| isFloatingIcon | boolean | 否 | 否 | 是否显示状态栏图标。 |
| label | string | 否 | 否 | 通知标签。 |
| badgeIconStyle | number | 否 | 否 | 通知角标类型。预留能力，暂未支持。 |
| showDeliveryTime | boolean | 否 | 否 | 是否显示分发时间。 |
| actionButtons | Array\<[NotificationActionButton](js-apis-inner-notification-notificationActionButton.md)\> | 否 | 否 | 通知按钮，最多三个按钮。 |
| smallIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 否 | 否 | 通知小图标。可选字段，大小不超过30KB。 |
| largeIcon | [image.PixelMap](js-apis-image.md#pixelmap7) | 否 | 否 | 通知大图标。可选字段，大小不超过30KB。 |
| creatorBundleName | string | 是 | 否 | 创建通知的包名。 |
| creatorUid<sup>8+<sup> | number | 是 | 否 | 创建通知的UID。 |
| creatorPid | number | 是 | 否 | 创建通知的PID。 |
| creatorUserId| number | 是 | 否 | 创建通知的UserId。 |
| creatorUserId | number | 是 | 否 | 创建通知的UserId。 |
| hashCode | string | 是 | 否 | 通知唯一标识。 |
| classification | string | 是 | 是 | 通知分类。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| groupName<sup>8+<sup> | string | 是 | 是 | 组通知名称。 |
| template<sup>8+<sup> | [NotificationTemplate](./js-apis-inner-notification-notificationTemplate.md) | 是 | 是 | 通知模板。 |
| classification | string | 否 | 否 | 通知分类。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| groupName<sup>8+<sup> | string | 否 | 否 | 组通知名称。 |
| template<sup>8+<sup> | [NotificationTemplate](./js-apis-inner-notification-notificationTemplate.md) | 否 | 否 | 通知模板。 |
| isRemoveAllowed<sup>8+<sup> | boolean | 是 | 否 | 通知是否能被移除。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| source<sup>8+<sup> | number | 是 | 否 | 通知源。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| distributedOption<sup>8+<sup> | [DistributedOptions](#distributedoptions) | 是 | 是 | 分布式通知的选项。 |
| distributedOption<sup>8+<sup> | [DistributedOptions](#distributedoptions) | 否 | 否 | 分布式通知的选项。 |
| deviceId<sup>8+<sup> | string | 是 | 否 | 通知源的deviceId。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
| notificationFlags<sup>8+<sup> | [NotificationFlags](js-apis-inner-notification-notificationflags#notificationFlags) | 是 | 否 | 获取NotificationFlags。 |
| removalWantAgent<sup>9+<sup> | [WantAgent](js-apis-app-ability-wantAgent.md) | 是 | 是 | 当移除通知时，通知将被重定向到的WantAgent实例。 |
| badgeNumber<sup>9+<sup> | number | 是 | 是 | 应用程序图标上显示的通知数。 |
| notificationFlags<sup>8+<sup> | [NotificationFlags](js-apis-inner-notification-notificationFlags.md#notificationflags) | 是 | 否 | 获取NotificationFlags。 |
| removalWantAgent<sup>9+<sup> | [WantAgent](js-apis-app-ability-wantAgent.md) | 否 | 否 | 当移除通知时，通知将被重定向到的WantAgent实例。 |
| badgeNumber<sup>9+<sup> | number | 否 | 否 | 应用程序图标上显示的通知数。 |
## DistributedOptions
......@@ -55,9 +55,9 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| ---------------------- | -------------- | ---- | ---- | ---------------------------------- |
| isDistributed<sup>8+<sup> | boolean | 是 | 是 | 是否为分布式通知。 |
| supportDisplayDevices<sup>8+<sup> | Array\<string> | 是 | 是 | 可以同步通知到的设备列表。 |
| supportOperateDevices<sup>8+<sup> | Array\<string> | 是 | 是 | 可以打开通知的设备列表。 |
| isDistributed<sup>8+<sup> | boolean | 否 | 否 | 是否为分布式通知。 |
| supportDisplayDevices<sup>8+<sup> | Array\<string> | 否 | 否 | 可以同步通知到的设备列表。 |
| supportOperateDevices<sup>8+<sup> | Array\<string> | 否 | 否 | 可以打开通知的设备列表。 |
| remindType<sup>8+<sup> | number | 是 | 否 | 通知的提醒方式。<br>**系统API**: 此接口为系统接口，三方应用不支持调用。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSlot.md
浏览文件 @ 6f1eac15
......@@ -8,17 +8,17 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| -------------------- | --------------------- | ---- | --- | ------------------------------------------ |
| type | [SlotType](js-apis-notificationManager.md#slottype) | 是 | 是 | 通道类型。 |
| level | number | 是 | 是 | 通知级别，不设置则根据通知渠道类型有默认值。 |
| desc | string | 是 | 是 | 通知渠道描述信息。 |
| badgeFlag | boolean | 是 | 是 | 是否显示角标。 |
| bypassDnd | boolean | 是 | 是 | 置是否在系统中绕过免打扰模式。 |
| lockscreenVisibility | number | 是 | 是 | 在锁定屏幕上显示通知的模式。 |
| vibrationEnabled | boolean | 是 | 是 | 是否可振动。 |
| sound | string | 是 | 是 | 通知提示音。 |
| lightEnabled | boolean | 是 | 是 | 是否闪灯。 |
| lightColor | number | 是 | 是 | 通知灯颜色。 |
| vibrationValues | Array\<number\> | 是 | 是 | 通知振动样式。 |
| type | [SlotType](js-apis-notificationManager.md#slottype) | 否 | 是 | 通道类型。 |
| level | number | 否 | 否 | 通知级别，不设置则根据通知渠道类型有默认值。 |
| desc | string | 否 | 否 | 通知渠道描述信息。 |
| badgeFlag | boolean | 否 | 否 | 是否显示角标。 |
| bypassDnd | boolean | 否 | 否 | 置是否在系统中绕过免打扰模式。 |
| lockscreenVisibility | number | 否 | 否 | 在锁定屏幕上显示通知的模式。 |
| vibrationEnabled | boolean | 否 | 否 | 是否可振动。 |
| sound | string | 否 | 否 | 通知提示音。 |
| lightEnabled | boolean | 否 | 否 | 是否闪灯。 |
| lightColor | number | 否 | 否 | 通知灯颜色。 |
| vibrationValues | Array\<number\> | 否 | 否 | 通知振动样式。 |
| enabled<sup>9+</sup> | boolean | 是 | 否 | 此通知插槽中的启停状态。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSorting.md 0 → 100644
浏览文件 @ 6f1eac15
# NotificationSorting
提供有关活动通知的排序信息。
> **说明：**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
**系统接口**: 以下为系统接口，三方应用不支持调用。
| 名称 | 类型 | 只读 | 必填 | 说明 |
| -------------------- | --------------------- | ---- | --- | ------------------------------------------ |
| slot | [NotificationSlot](js-apis-inner-notification-notificationSlot.md) | 是 | 是 | 通道类型。 |
| level | number | 是 | 是 | 通知级别，不设置则根据通知渠道类型有默认值。 |
| desc | string | 是 | 是 | 通知渠道描述信息。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSortingMap.md 0 → 100644
浏览文件 @ 6f1eac15
# NotificationSortingMap
提供有关已订阅的所有通知中的活动通知的排序信息。
> **说明：**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
**系统接口**: 以下为系统接口，三方应用不支持调用。
| 名称 | 类型 | 只读 | 必填 | 说明 |
| -------------------- | --------------------- | ---- | --- | ------------------------------------------ |
| sortings | { [key: string]: [NotificationSorting](js-apis-inner-notification-notificationSorting.md) } | 是 | 是 | 通知排序信息。 |
| sortedHashCode | Array<string> | 是 | 是 | 通知排序的HashCode。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSubscribeInfo.md 0 → 100644
浏览文件 @ 6f1eac15
# NotificationSubscribeInfo
通知发布者的信息。
> **说明：**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
**系统接口**: 以下为系统接口，三方应用不支持调用。
| 名称 | 类型 | 只读 | 必填 | 说明 |
| -------------------- | --------------------- | ---- | --- | ------------------------------------------ |
| bundleNames | Array<string> | 否 | 否 | 应用Bundle名称。 |
| userId | number | 否 | 否 | 用户ID。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSubscriber.md 0 → 100644
浏览文件 @ 6f1eac15
## NotificationSubscriber
作为订阅通知接口[subscribe](js-apis-notificationSubscribe.md)的入参，提供订阅者接收到新通知、取消通知等的回调方法。
> **说明：**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
**系统API**：此接口为系统接口，三方应用不支持调用。
### onConsume
onConsume?: (data: [SubscribeCallbackData](js-apis-notification.md#subscribecallbackdata)) => void
接收到新通知的回调函数。
**系统能力**：SystemCapability.Notification.Notification
**系统接口**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------------ | ---- | -------------------------- |
| data | [SubscribeCallbackData](js-apis-notification.md#subscribecallbackdata) | 是 | 新接收到的通知信息。 |
**示例：**
```javascript
function subscribeCallback(err) {
if (err) {
console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("subscribeCallback");
}
};
function onConsumeCallback(data) {
console.info('===> onConsume in test');
let req = data.request;
console.info('===> onConsume callback req.id:' + req.id);
};
let subscriber = {
onConsume: onConsumeCallback
};
notificationSubscribe.subscribe(subscriber, subscribeCallback);
```
### onCancel
onCancel?:(data: [SubscribeCallbackData](js-apis-notification.md#subscribecallbackdata)) => void
取消通知的回调函数。
**系统能力**：SystemCapability.Notification.Notification
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------------ | ---- | -------------------------- |
| data | [SubscribeCallbackData](js-apis-notification.md#subscribecallbackdata) | 是 | 需要取消的通知信息。 |
**示例：**
```javascript
function subscribeCallback(err) {
if (err) {
console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("subscribeCallback");
}
};
function onCancelCallback(data) {
console.info('===> onCancel in test');
let req = data.request;
console.info('===> onCancel callback req.id:' + req.id);
}
let subscriber = {
onCancel: onCancelCallback
};
notificationSubscribe.subscribe(subscriber, subscribeCallback);
```
### onUpdate
onUpdate?:(data: [NotificationSortingMap](js-apis-notification.md#notificationsortingmap)) => void
更新通知排序的回调函数。
**系统能力**：SystemCapability.Notification.Notification
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------------ | ---- | -------------------------- |
| data | [NotificationSortingMap](js-apis-notification.md#notificationsortingmap) | 是 | 最新的通知排序列表。 |
**示例：**
```javascript
function subscribeCallback(err) {
if (err) {
console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("subscribeCallback");
}
};
function onUpdateCallback(map) {
console.info('===> onUpdateCallback map:' + JSON.stringify(map));
}
let subscriber = {
onUpdate: onUpdateCallback
};
notificationSubscribe.subscribe(subscriber, subscribeCallback);
```
### onConnect
onConnect?:() => void
订阅完成的回调函数。
**系统能力**：SystemCapability.Notification.Notification
**系统API**: 此接口为系统接口，三方应用不支持调用。
**示例：**
```javascript
function subscribeCallback(err) {
if (err) {
console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("subscribeCallback");
}
};
function onConnectCallback() {
console.info('===> onConnect in test');
}
let subscriber = {
onConnect: onConnectCallback
};
notificationSubscribe.subscribe(subscriber, subscribeCallback);
```
### onDisconnect
onDisconnect?:() => void
取消订阅的回调函数。
**系统能力**：SystemCapability.Notification.Notification
**系统API**: 此接口为系统接口，三方应用不支持调用。
**示例：**
```javascript
function subscribeCallback(err) {
if (err) {
console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("subscribeCallback");
}
};
function unsubscribeCallback(err) {
if (err.code) {
console.error(`unsubscribe failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("unsubscribeCallback");
}
};
function onConnectCallback() {
console.info('===> onConnect in test');
}
function onDisconnectCallback() {
console.info('===> onDisconnect in test');
}
let subscriber = {
onConnect: onConnectCallback,
onDisconnect: onDisconnectCallback
};
// 订阅通知后会收到onConnect回调
notificationSubscribe.subscribe(subscriber, subscribeCallback);
// 取消订阅后会收到onDisconnect回调
notificationSubscribe.unsubscribe(subscriber, unsubscribeCallback);
```
### onDestroy
onDestroy?:() => void
服务失联回调函数。
**系统能力**：SystemCapability.Notification.Notification
**系统API**: 此接口为系统接口，三方应用不支持调用。
**示例：**
```javascript
function subscribeCallback(err) {
if (err) {
console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("subscribeCallback");
}
};
function onDestroyCallback() {
console.info('===> onDestroy in test');
}
let subscriber = {
onDestroy: onDestroyCallback
};
notificationSubscribe.subscribe(subscriber, subscribeCallback);
```
### onDoNotDisturbDateChange<sup>8+</sup>
onDoNotDisturbDateChange?:(mode: notification.[DoNotDisturbDate](js-apis-notificationManager.md#donotdisturbdate)) => void
免打扰时间选项发生变更时的回调函数。
**系统能力**：SystemCapability.Notification.Notification
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------------ | ---- | -------------------------- |
| mode | notification.[DoNotDisturbDate](js-apis-notificationManager.md#DoNotDisturbDate) | 是 | 回调返回免打扰时间选项变更。 |
**示例：**
```javascript
function subscribeCallback(err) {
if (err) {
console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("subscribeCallback");
}
};
function onDoNotDisturbDateChangeCallback(mode) {
console.info('===> onDoNotDisturbDateChange:' + mode);
}
let subscriber = {
onDoNotDisturbDateChange: onDoNotDisturbDateChangeCallback
};
notificationSubscribe.subscribe(subscriber, subscribeCallback);
```
### onEnabledNotificationChanged<sup>8+</sup>
onEnabledNotificationChanged?:(callbackData: [EnabledNotificationCallbackData](js-apis-notification.md#enablednotificationcallbackdata)) => void
监听应用通知使能变化。
**系统能力**：SystemCapability.Notification.Notification
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------------------------ | ---- | -------------------------- |
| callback | AsyncCallback\<[EnabledNotificationCallbackData](js-apis-notification.md#enablednotificationcallbackdata)\> | 是 | 回调返回监听到的应用信息。 |
**示例：**
```javascript
function subscribeCallback(err) {
if (err) {
console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("subscribeCallback");
}
};
function onEnabledNotificationChangedCallback(callbackData) {
console.info("bundle: ", callbackData.bundle);
console.info("uid: ", callbackData.uid);
console.info("enable: ", callbackData.enable);
};
let subscriber = {
onEnabledNotificationChanged: onEnabledNotificationChangedCallback
};
notificationSubscribe.subscribe(subscriber, subscribeCallback);
```
### onBadgeChanged<sup>10+</sup>
onBadgeChanged?:(data: [BadgeNumberCallbackData](#badgenumbercallbackdata10)) => void
监听应用角标个数变化。
**系统能力**：SystemCapability.Notification.Notification
**系统API**: 此接口为系统接口，三方应用不支持调用。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | -------------------------- |
| callback | AsyncCallback\<[BadgeNumberCallbackData](#badgenumbercallbackdata10)\> | 是 | 回调返回监听到的应用信息。 |
**示例：**
```javascript
function subscribeCallback(err) {
if (err) {
console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
} else {
console.info("subscribeCallback");
}
};
function onBadgeChangedCallback(data) {
console.info("bundle: ", data.bundle);
console.info("uid: ", data.uid);
console.info("badgeNumber: ", data.badgeNumber);
};
let subscriber = {
onBadgeChanged: onBadgeChangedCallback
};
notificationSubscribe.subscribe(subscriber, subscribeCallback);
```
## SubscribeCallbackData
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
**系统API**：此接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 只读 | 必传 | 说明 |
| --------------- | ------------------------------------------------- | ---- | --- | -------- |
| request | [NotificationRequest](js-apis-inner-notification-notificationRequest#notificationrequest) | 是 | 是 | 通知内容。 |
| sortingMap | [NotificationSortingMap](js-apis-inner-notification-notificationSortingMap.md) | 是 | 否 | 通知排序信息。 |
| reason | number | 是 | 否 | 删除原因。 |
| sound | string | 是 | 否 | 通知声音。 |
| vibrationValues | Array\<number\> | 是 | 否 | 通知震动。 |
## EnabledNotificationCallbackData<sup>8+</sup>
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
**系统API**：此接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 只读 | 必传 | 说明 |
| ------ | ------- | ---- | --- | ---------------- |
| bundle | string | 是 | 是 | 应用的包名。 |
| uid | number | 是 | 是 | 应用的uid。 |
| enable | boolean | 是 | 是 | 应用通知使能状态。 |
## BadgeNumberCallbackData<sup>10+</sup>
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
**系统API**：此接口为系统接口，三方应用不支持调用。
| 名称 | 类型 | 只读 | 必传 | 描述 |
| ----------- | ------ | ---- | ---- | ------------ |
| bundle | string | 是 | 是 | 应用的包名。 |
| uid | number | 是 | 是 | 应用的uid。 |
| badgeNumber | number | 是 | 是 | 角标个数。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationTemplate.md
浏览文件 @ 6f1eac15
......@@ -8,7 +8,7 @@
**系统能力**：以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| ---- | ---------------------- | ---- | ---- | ---------- |
| name | string | 是 | 是 | 模板名称。 |
| data | {[key:string]: Object} | 是 | 是 | 模板数据。 |
| name | string | 否 | 是 | 模板名称。 |
| data | {[key:string]: Object} | 否 | 是 | 模板数据。 |
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationUserInput.md
浏览文件 @ 6f1eac15
......@@ -8,6 +8,6 @@
**系统能力**：SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型 | 只读 | 必填 | 说明 |
| -------- | ------ | --- | ---- | ----------------------------- |
| inputKey | string | 是 | 是 | 用户输入时用于标识此输入的key。 |
| inputKey | string | 否 | 是 | 用户输入时用于标识此输入的key。 |
zh-cn/application-dev/reference/apis/js-apis-reminderAgent.md
浏览文件 @ 6f1eac15
......@@ -18,14 +18,17 @@ import reminderAgent from'@ohos.reminderAgent';
```
## reminderAgent.publishReminder
## reminderAgent.publishReminder<sup>(deprecated)</sup>
```ts
publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number>): void
publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback\<number>): void
```
发布一个后台代理提醒，使用回调的方式实现异步调用，该方法需要申请通知弹窗权限[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.publishReminder](js-apis-reminderAgentManager.md#reminderagentmanagerpublishreminder)替代。
**需要权限**： `ohos.permission.PUBLISH_AGENT_REMINDER`
**系统能力**： `SystemCapability.Notification.ReminderAgent`
......@@ -50,14 +53,17 @@ publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number>):
```
## reminderAgent.publishReminder
## reminderAgent.publishReminder<sup>(deprecated)</sup>
```ts
publishReminder(reminderReq: ReminderRequest): Promise<number>
publishReminder(reminderReq: ReminderRequest): Promise\<number>
```
发布一个后台代理提醒，使用Promise方式实现异步调用，该方法需要申请通知弹窗权限[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.publishReminder](js-apis-reminderAgentManager.md#reminderagentmanagerpublishreminder-1)替代。
**需要权限**： `ohos.permission.PUBLISH_AGENT_REMINDER`
**系统能力**： `SystemCapability.Notification.ReminderAgent`
......@@ -85,14 +91,17 @@ publishReminder(reminderReq: ReminderRequest): Promise<number>
```
## reminderAgent.cancelReminder
## reminderAgent.cancelReminder<sup>(deprecated)</sup>
```ts
cancelReminder(reminderId: number, callback: AsyncCallback<void>): void
cancelReminder(reminderId: number, callback: AsyncCallback\<void>): void
```
取消指定id的提醒，使用回调的方式实现异步调用。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.cancelReminder](js-apis-reminderAgentManager.md#reminderagentmanagercancelreminder)替代。
**系统能力**： `SystemCapability.Notification.ReminderAgent`
**参数**：
......@@ -111,14 +120,17 @@ reminderAgent.cancelReminder(1, (err, data) => {
```
## reminderAgent.cancelReminder
## reminderAgent.cancelReminder<sup>(deprecated)</sup>
```ts
cancelReminder(reminderId: number): Promise<void>
cancelReminder(reminderId: number): Promise\<void>
```
取消指定id的提醒，使用Promise方式实现异步调用。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.cancelReminder](js-apis-reminderAgentManager.md#reminderagentmanagercancelreminder-1)替代。
**系统能力**： `SystemCapability.Notification.ReminderAgent`
**参数**：
......@@ -141,14 +153,17 @@ reminderAgent.cancelReminder(1).then(() => {
});
```
## reminderAgent.getValidReminders
## reminderAgent.getValidReminders<sup>(deprecated)</sup>
```ts
getValidReminders(callback: AsyncCallback<Array<ReminderRequest>>): void
getValidReminders(callback: AsyncCallback\<Array\<ReminderRequest>>): void
```
获取当前应用已设置的所有有效（未过期）的提醒，使用回调的方式实现异步调用。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.getValidReminders](js-apis-reminderAgentManager.md#reminderagentmanagergetvalidreminders)替代。
**系统能力**： `SystemCapability.Notification.ReminderAgent`
**参数**：
......@@ -187,14 +202,17 @@ reminderAgent.getValidReminders((err, reminders) => {
```
## reminderAgent.getValidReminders
## reminderAgent.getValidReminders<sup>(deprecated)</sup>
```ts
getValidReminders(): Promise<Array<ReminderRequest>>
getValidReminders(): Promise\<Array\<ReminderRequest>>
```
获取当前应用已设置的所有有效（未过期）的提醒，使用Promise方式实现异步调用。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.getValidReminders](js-apis-reminderAgentManager.md#reminderagentmanagergetvalidreminders-1)替代。
**系统能力**： `SystemCapability.Notification.ReminderAgent`
**返回值**：
......@@ -233,14 +251,17 @@ reminderAgent.getValidReminders().then((reminders) => {
```
## reminderAgent.cancelAllReminders
## reminderAgent.cancelAllReminders<sup>(deprecated)</sup>
```ts
cancelAllReminders(callback: AsyncCallback<void>): void
cancelAllReminders(callback: AsyncCallback\<void>): void
```
取消当前应用所有的提醒，使用回调的方式实现异步调用。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.cancelAllReminders](js-apis-reminderAgentManager.md#reminderagentmanagercancelallreminders)替代。
**系统能力**： `SystemCapability.Notification.ReminderAgent`
**参数**：
......@@ -258,14 +279,17 @@ reminderAgent.cancelAllReminders((err, data) =>{
```
## reminderAgent.cancelAllReminders
## reminderAgent.cancelAllReminders<sup>(deprecated)</sup>
```ts
cancelAllReminders(): Promise<void>
cancelAllReminders(): Promise\<void>
```
取消当前应用所有的提醒，使用Promise方式实现异步调用。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.cancelAllReminders](js-apis-reminderAgentManager.md#reminderagentmanagercancelallreminders-1)替代。
**系统能力**： `SystemCapability.Notification.ReminderAgent`
**返回值**：
......@@ -282,14 +306,17 @@ reminderAgent.cancelAllReminders().then(() => {
})
```
## reminderAgent.addNotificationSlot
## reminderAgent.addNotificationSlot<sup>(deprecated)</sup>
```ts
addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback<void>): void
addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback\<void>): void
```
添加一个NotificationSlot，使用回调的方式实现异步调用。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.addNotificationSlot](js-apis-reminderAgentManager.md#reminderagentmanageraddnotificationslot)替代。
**系统能力**： `SystemCapability.Notification.ReminderAgent`
**参数**：
......@@ -313,14 +340,17 @@ reminderAgent.addNotificationSlot(mySlot, (err, data) => {
```
## reminderAgent.addNotificationSlot
## reminderAgent.addNotificationSlot<sup>(deprecated)</sup>
```ts
addNotificationSlot(slot: NotificationSlot): Promise<void>
addNotificationSlot(slot: NotificationSlot): Promise\<void>
```
添加一个NotificationSlot，使用Promise方式实现异步调用。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.addNotificationSlot](js-apis-reminderAgentManager.md#reminderagentmanageraddnotificationslot-1)替代。
**系统能力**： `SystemCapability.Notification.ReminderAgent`
**参数**：
......@@ -349,7 +379,7 @@ reminderAgent.addNotificationSlot(mySlot).then(() => {
```
## reminderAgent.removeNotificationSlot
## reminderAgent.removeNotificationSlot<sup>(deprecated)</sup>
```ts
removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback<void>): void
......@@ -357,6 +387,9 @@ removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback<
删除目标NotificationSlot，使用callback方式实现异步调用。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.removeNotificationSlot](js-apis-reminderAgentManager.md#reminderagentmanagerremovenotificationslot)替代。
**系统能力**： `SystemCapability.Notification.ReminderAgent`
**参数**：
......@@ -377,7 +410,7 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION,
```
## reminderAgent.removeNotificationSlot
## reminderAgent.removeNotificationSlot<sup>(deprecated)</sup>
```ts
removeNotificationSlot(slotType: notification.SlotType): Promise<void>
......@@ -385,6 +418,9 @@ removeNotificationSlot(slotType: notification.SlotType): Promise<void>
删除目标NotificationSlot，使用Promise方式实现异步调用。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.removeNotificationSlot](js-apis-reminderAgentManager.md#reminderagentmanagerremovenotificationslot-1)替代。
**系统能力**： `SystemCapability.Notification.ReminderAgent`
**参数**：
......@@ -410,10 +446,13 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
```
## ActionButtonType
## ActionButtonType<sup>(deprecated)</sup>
按钮的类型。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.ActionButtonType](js-apis-reminderAgentManager.md#ActionButtonType)替代。
**系统能力**：`SystemCapability.Notification.ReminderAgent`
| 名称 | 值 | 说明 |
......@@ -422,10 +461,13 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
| ACTION_BUTTON_TYPE_SNOOZE | 1 | 表示延迟提醒的按钮。 |
## ReminderType
## ReminderType<sup>(deprecated)</sup>
提醒的类型。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.ReminderType](js-apis-reminderAgentManager.md#ReminderType)替代。
**系统能力**：`SystemCapability.Notification.ReminderAgent`
| 名称 | 值 | 说明 |
......@@ -435,10 +477,13 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
| REMINDER_TYPE_ALARM | 2 | 表示提醒类型：闹钟。 |
## ActionButton
## ActionButton<sup>(deprecated)</sup>
用于设置弹出的提醒通知信息上显示的按钮类型和标题。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.ActionButton](js-apis-reminderAgentManager.md#ActionButton)替代。
**系统能力**：`SystemCapability.Notification.ReminderAgent`
| 名称 | 类型 | 必填 | 说明 |
......@@ -447,10 +492,13 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
| type | [ActionButtonType](#actionbuttontype) | 是 | 按钮的类型。 |
## WantAgent
## WantAgent<sup>(deprecated)</sup>
点击提醒通知后跳转的目标ability信息。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.WantAgent](js-apis-reminderAgentManager.md#WantAgent)替代。
**系统能力**：`SystemCapability.Notification.ReminderAgent`
| 名称 | 类型 | 必填 | 说明 |
......@@ -459,10 +507,13 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
| abilityName | string | 是 | 指明点击提醒通知栏后跳转的目标ability名称。 |
## MaxScreenWantAgent
## MaxScreenWantAgent<sup>(deprecated)</sup>
全屏显示提醒到达时自动拉起的目标ability信息，该接口预留。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.MaxScreenWantAgent](js-apis-reminderAgentManager.md#MaxScreenWantAgent)替代。
**系统能力**：`SystemCapability.Notification.ReminderAgent`
| 名称 | 类型 | 必填 | 说明 |
......@@ -471,10 +522,13 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
| abilityName | string | 是 | 指明提醒到达时自动拉起的目标ability名（如果设备在使用中，则只弹出通知横幅框）。 |
## ReminderRequest
## ReminderRequest<sup>(deprecated)</sup>
提醒实例对象，用于设置提醒类型、响铃时长等具体信息。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.ReminderRequest](js-apis-reminderAgentManager.md#ReminderRequest)替代。
**系统能力**：`SystemCapability.Notification.ReminderAgent`
| 名称 | 类型 | 必填 | 说明 |
......@@ -494,12 +548,15 @@ reminderAgent.removeNotificationSlot(notification.SlotType.CONTENT_INFORMATION).
| slotType | [notification.SlotType](js-apis-notification.md#slottype) | 否 | 指明提醒的slot类型。 |
## ReminderRequestCalendar
## ReminderRequestCalendar<sup>(deprecated)</sup>
ReminderRequestCalendar extends ReminderRequest
日历实例对象，用于设置提醒的时间。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.ReminderRequestCalendar](js-apis-reminderAgentManager.md#ReminderRequestCalendar)替代。
**系统能力**：`SystemCapability.Notification.ReminderAgent`
| 名称 | 类型 | 必填 | 说明 |
......@@ -509,12 +566,15 @@ ReminderRequestCalendar extends ReminderRequest
| repeatDays | Array\<number\> | 否 | 指明重复提醒的日期。 |
## ReminderRequestAlarm
## ReminderRequestAlarm<sup>(deprecated)</sup>
ReminderRequestAlarm extends ReminderRequest
闹钟实例对象，用于设置提醒的时间。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.ReminderRequestAlarm](js-apis-reminderAgentManager.md#ReminderRequestAlarm)替代。
**系统能力**：`SystemCapability.Notification.ReminderAgent`
| 名称 | 类型 | 必填 | 说明 |
......@@ -524,12 +584,15 @@ ReminderRequestAlarm extends ReminderRequest
| daysOfWeek | Array\<number\> | 否 | 指明每周哪几天需要重复提醒。范围为周一到周末，对应数字为1到7。 |
## ReminderRequestTimer
## ReminderRequestTimer<sup>(deprecated)</sup>
ReminderRequestTimer extends ReminderRequest
倒计时实例对象，用于设置提醒的时间。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.ReminderRequestTimer](js-apis-reminderAgentManager.md#ReminderRequestTimer)替代。
**系统能力**：`SystemCapability.Notification.ReminderAgent`
| 名称 | 类型 | 必填 | 说明 |
......@@ -537,10 +600,13 @@ ReminderRequestTimer extends ReminderRequest
| triggerTimeInSeconds | number | 是 | 指明倒计时的秒数。 |
## LocalDateTime
## LocalDateTime<sup>(deprecated)</sup>
用于日历类提醒设置时指定时间信息。
> **说明：**
> 从 API version 7开始支持，从API version 9开始废弃。建议使用[reminderAgentManager.LocalDateTime](js-apis-reminderAgentManager.md#LocalDateTime)替代。
**系统能力**：`SystemCapability.Notification.ReminderAgent`
| 名称 | 类型 | 必填 | 说明 |
......
zh-cn/application-dev/reference/apis/js-apis-reminderAgentManager.md
浏览文件 @ 6f1eac15
......@@ -19,7 +19,7 @@ import reminderAgentManager from'@ohos.reminderAgentManager';
## reminderAgentManager.publishReminder
```ts
publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback<number>): void
publishReminder(reminderReq: ReminderRequest, callback: AsyncCallback\<number>): void
```
发布一个后台代理提醒，使用回调的方式实现异步调用，该方法需要申请通知弹窗权限[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。
......@@ -68,7 +68,7 @@ try {
## reminderAgentManager.publishReminder
```ts
publishReminder(reminderReq: ReminderRequest): Promise<number>
publishReminder(reminderReq: ReminderRequest): Promise\<number>
```
发布一个后台代理提醒，使用`Promise`的方式实现异步调用，该方法需要申请通知弹窗权限[Notification.requestEnableNotification](js-apis-notification.md#notificationrequestenablenotification8)后才能调用。
......@@ -118,7 +118,7 @@ try {
## reminderAgentManager.cancelReminder
```ts
cancelReminder(reminderId: number, callback: AsyncCallback<void>): void
cancelReminder(reminderId: number, callback: AsyncCallback\<void>): void
```
取消指定id的提醒，使用回调的方式实现异步调用。
......@@ -161,7 +161,7 @@ try {
## reminderAgentManager.cancelReminder
```ts
cancelReminder(reminderId: number): Promise<void>
cancelReminder(reminderId: number): Promise\<void>
```
取消指定id的提醒，使用`Promise`方式实现异步调用。
......@@ -206,7 +206,7 @@ try {
## reminderAgentManager.getValidReminders
```ts
getValidReminders(callback: AsyncCallback<Array<ReminderRequest>>): void
getValidReminders(callback: AsyncCallback\<Array\<ReminderRequest>>): void
```
......@@ -268,7 +268,7 @@ try {
## reminderAgentManager.getValidReminders
```ts
getValidReminders(): Promise<Array<ReminderRequest>>
getValidReminders(): Promise\<Array\<ReminderRequest>>
```
获取当前应用已设置的所有有效（未过期）的提醒，使用Promise方式实现异步调用。
......@@ -328,7 +328,7 @@ try {
## reminderAgentManager.cancelAllReminders
```ts
cancelAllReminders(callback: AsyncCallback<void>): void
cancelAllReminders(callback: AsyncCallback\<void>): void
```
取消当前应用所有的提醒，使用回调的方式实现异步调用。
......@@ -369,7 +369,7 @@ try {
## reminderAgentManager.cancelAllReminders
```ts
cancelAllReminders(): Promise<void>
cancelAllReminders(): Promise\<void>
```
取消当前应用所有的提醒，使用Promise方式实现异步调用。
......@@ -408,7 +408,7 @@ try {
## reminderAgentManager.addNotificationSlot
```ts
addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback<void>): void
addNotificationSlot(slot: NotificationSlot, callback: AsyncCallback\<void>): void
```
添加一个NotificationSlot，使用回调的方式实现异步调用。
......@@ -447,7 +447,7 @@ try {
## reminderAgentManager.addNotificationSlot
```ts
addNotificationSlot(slot: NotificationSlot): Promise<void>
addNotificationSlot(slot: NotificationSlot): Promise\<void>
```
添加一个NotificationSlot，使用Promise方式实现异步调用。
......@@ -489,7 +489,7 @@ try {
## reminderAgentManager.removeNotificationSlot
```ts
removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback<void>): void
removeNotificationSlot(slotType: notification.SlotType, callback: AsyncCallback\<void>): void
```
删除目标NotificationSlot，使用回调的方式实现异步调用。
......@@ -525,7 +525,7 @@ try {
## reminderAgentManager.removeNotificationSlot
```ts
removeNotificationSlot(slotType: notification.SlotType): Promise<void>
removeNotificationSlot(slotType: notification.SlotType): Promise\<void>
```
删除目标NotificationSlot，使用Promise方式实现异步调用。
......@@ -566,6 +566,8 @@ try {
**系统能力**：`SystemCapability.Notification.ReminderAgent`
**系统接口**: ACTION_BUTTON_TYPE_CUSTOM为系统接口，三方应用不支持调用。
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| ACTION_BUTTON_TYPE_CLOSE | 0 | 表示关闭提醒的按钮。 |
......@@ -590,6 +592,8 @@ try {
用于设置弹出的提醒通知信息上显示的按钮类型和标题。
**系统接口**: wantAgent为系统接口，三方应用不支持调用。
**系统能力**：`SystemCapability.Notification.ReminderAgent`
| 名称 | 类型 | 必填 | 说明 |
......@@ -605,11 +609,13 @@ try {
**系统能力**：`SystemCapability.Notification.ReminderAgent`
**系统接口**: uri为系统接口，三方应用不支持调用。
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| pkgName | string | 是 | 指明跳转的目标包名。 |
| abilityName | string | 是 | 指明跳转的目标ability名称。 |
| uri | string<sup>10+</sup> | 否 | 指明跳转目标的uri信息。（系统接口） |
| uri<sup>10+</sup> | string | 否 | 指明跳转目标的uri信息。（系统接口） |
## MaxScreenWantAgent
......@@ -633,7 +639,7 @@ try {
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| reminderType | [ReminderType](#remindertype) | 是 | 指明提醒类型。 |
| actionButton | [ActionButton](#actionbutton) | 否 | 弹出的提醒通知栏中显示的按钮（参数可选。普通应用：最多支持两个按钮，系统应用：API9最多支持两个按钮，API10及以后最多支持三个按钮。）。 |
| actionButton<sup>10+</sup> | [ActionButton](#actionbutton) | 否 | 弹出的提醒通知栏中显示的按钮（参数可选。普通应用：最多支持两个按钮，系统应用：API9最多支持两个按钮，API10及以后最多支持三个按钮。）。 |
| wantAgent | [WantAgent](#wantagent) | 否 | 点击通知后需要跳转的目标ability信息。 |
| maxScreenWantAgent | [MaxScreenWantAgent](#maxscreenwantagent) | 否 | 提醒到达时跳转的目标包。如果设备正在使用中，则弹出一个通知框。 |
| ringDuration | number | 否 | 指明响铃时长（单位：秒），默认1秒。 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或