1# CommonEventSubscriber 2 3描述公共事件的订阅者。 4 5> **说明：** 6> 7> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 8 9## 使用说明 10 11在使用CommonEventSubscriber的功能前，需要通过commonEventManager.createSubscriber获取subscriber对象。 12 13```ts 14import { commonEventManager } from '@kit.BasicServicesKit'; 15import { BusinessError } from '@kit.BasicServicesKit'; 16 17// 定义订阅者，用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 18let subscriber:commonEventManager.CommonEventSubscriber; 19// 订阅者信息 20let subscribeInfo:commonEventManager.CommonEventSubscribeInfo = { 21 events: ["event"] 22}; 23// 创建订阅者回调 24function createCB(err: BusinessError, commonEventSubscriber:commonEventManager.CommonEventSubscriber) { 25 if (err != null) { 26 console.error(`createSubscriber failed, code is ${err.code}`); 27 } else { 28 console.info("createSubscriber success"); 29 subscriber = commonEventSubscriber; 30 } 31} 32// 创建订阅者 33commonEventManager.createSubscriber(subscribeInfo, createCB); 34``` 35 36## getCode 37 38getCode(callback: AsyncCallback\<number>): void 39 40获取有序公共事件代码。使用callback异步回调。 41 42**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 43 44**系统能力**：`SystemCapability.Notification.CommonEvent` 45 46**参数：** 47 48| 参数名 | 类型 | 必填 | 说明 | 49| -------- | ---------------------- | ---- | ------------------ | 50| callback | AsyncCallback\<number\> | 是 | 公共事件代码。 | 51 52**示例：** 53 54```ts 55// 获取有序公共事件代码回调 56function getCodeCallback(err: BusinessError, code:number) { 57 if (err != null) { 58 console.error(`getCode failed, code is ${err.code}, message is ${err.message}`); 59 } else { 60 console.info("getCode " + JSON.stringify(code)); 61 } 62} 63subscriber.getCode(getCodeCallback); 64``` 65 66## getCode 67 68getCode(): Promise\<number> 69 70获取有序公共事件代码。使用Promise异步回调。 71 72**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 73 74**系统能力**：`SystemCapability.Notification.CommonEvent` 75 76**返回值：** 77 78| 类型 | 说明 | 79| ---------------- | -------------------- | 80| Promise\<number> | Promise对象。返回公共事件代码。 | 81 82**示例：** 83 84```ts 85subscriber.getCode().then((code:number) => { 86 console.info("getCode " + JSON.stringify(code)); 87}).catch((err: BusinessError) => { 88 console.error(`getCode failed, code is ${err.code}, message is ${err.message}`); 89}); 90``` 91 92## getCodeSync<sup>10+</sup> 93 94getCodeSync(): number 95 96获取有序公共事件代码。 97 98**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 99 100**系统能力**：`SystemCapability.Notification.CommonEvent` 101 102**返回值：** 103 104| 类型 | 说明 | 105| ---------------- | -------------------- | 106| number | 公共事件代码。 | 107 108**示例：** 109 110```ts 111let code = subscriber.getCodeSync(); 112console.info("getCodeSync " + JSON.stringify(code)); 113``` 114 115## setCode 116 117setCode(code: number, callback: AsyncCallback\<void>): void 118 119设置有序公共事件的代码。使用callback异步回调。 120 121**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 122 123**系统能力**：`SystemCapability.Notification.CommonEvent` 124 125**参数：** 126 127| 参数名 | 类型 | 必填 | 说明 | 128| -------- | -------------------- | ---- | ---------------------- | 129| code | number | 是 | 公共事件的代码。 | 130| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 131 132**示例：** 133 134```ts 135// 设置有序公共事件的代码回调 136function setCodeCallback(err: BusinessError) { 137 if (err != null) { 138 console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); 139 } else { 140 console.info("setCode success"); 141 } 142} 143subscriber.setCode(1, setCodeCallback); 144``` 145 146## setCode 147 148setCode(code: number): Promise\<void> 149 150设置有序公共事件的代码。使用Promise异步回调。 151 152**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 153 154**系统能力**：`SystemCapability.Notification.CommonEvent` 155 156**参数：** 157 158| 参数名 | 类型 | 必填 | 说明 | 159| ------ | ------ | ---- | ------------------ | 160| code | number | 是 | 公共事件的代码。 | 161 162**返回值：** 163 164| 类型 | 说明 | 165| ---------------- | -------------------- | 166| Promise\<void> | Promise对象。无返回结果的Promise对象。 | 167 168**示例：** 169 170```ts 171subscriber.setCode(1).then(() => { 172 console.info("setCode success"); 173}).catch((err: BusinessError) => { 174 console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); 175}); 176``` 177 178## setCodeSync<sup>10+</sup> 179 180setCodeSync(code: number): void 181 182设置有序公共事件的代码。 183 184**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 185 186**系统能力**：`SystemCapability.Notification.CommonEvent` 187 188**参数：** 189 190| 参数名 | 类型 | 必填 | 说明 | 191| ------ | ------ | ---- | ------------------ | 192| code | number | 是 | 公共事件的代码。 | 193 194**错误码：** 195 196以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 197 198| 错误码ID | 错误信息 | 199| -------- | ----------------------------------- | 200| 401 | Parameter error. Possible causes:<br>1. Mandatory parameters are left unspecified.<br>2. Incorrect parameter types.<br>3. Parameter verification failed. | 201 202**示例：** 203 204```ts 205try { 206 subscriber.setCodeSync(1); 207} catch (error) { 208 let err: BusinessError = error as BusinessError; 209 console.error(`setCodeSync failed, code is ${err.code}, message is ${err.message}`); 210} 211``` 212 213## getData 214 215getData(callback: AsyncCallback\<string>): void 216 217获取有序公共事件的数据。使用callback异步回调。 218 219**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 220 221**系统能力**：`SystemCapability.Notification.CommonEvent` 222 223**参数：** 224 225| 参数名 | 类型 | 必填 | 说明 | 226| -------- | ---------------------- | ---- | -------------------- | 227| callback | AsyncCallback\<string> | 是 | 公共事件的数据。 | 228 229**示例：** 230 231```ts 232// 获取有序公共事件代码数据回调 233function getDataCallback(err: BusinessError, data:string) { 234 if (err != null) { 235 console.error(`getData failed, code is ${err.code}, message is ${err.message}`); 236 } else { 237 console.info("getData " + JSON.stringify(data)); 238 } 239} 240subscriber.getData(getDataCallback); 241``` 242 243## getData 244 245getData(): Promise\<string> 246 247获取有序公共事件的数据。使用Promise异步回调。 248 249**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 250 251**系统能力**：`SystemCapability.Notification.CommonEvent` 252 253**返回值：** 254 255| 类型 | 说明 | 256| ---------------- | ------------------ | 257| Promise\<string> | Promise对象。返回公共事件的数据。 | 258 259**示例：** 260 261```ts 262subscriber.getData().then((data:string) => { 263 console.info("getData " + JSON.stringify(data)); 264}).catch((err: BusinessError) => { 265 console.error(`getData failed, code is ${err.code}, message is ${err.message}`); 266}); 267``` 268 269## getDataSync<sup>10+</sup> 270 271getDataSync(): string 272 273获取有序公共事件的数据。 274 275**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 276 277**系统能力**：`SystemCapability.Notification.CommonEvent` 278 279**返回值：** 280 281| 类型 | 说明 | 282| ---------------- | ------------------ | 283| string | 公共事件的数据。 | 284 285**示例：** 286 287```ts 288let data = subscriber.getDataSync(); 289console.info("getDataSync " + JSON.stringify(data)); 290``` 291 292## setData 293 294setData(data: string, callback: AsyncCallback\<void>): void 295 296设置有序公共事件的数据。使用callback异步回调。 297 298**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 299 300**系统能力**：`SystemCapability.Notification.CommonEvent` 301 302**参数：** 303 304| 参数名 | 类型 | 必填 | 说明 | 305| -------- | -------------------- | ---- | -------------------- | 306| data | string | 是 | 公共事件的数据。 | 307| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 308 309**示例：** 310 311```ts 312// 设置有序公共事件的结果数据回调 313function setDataCallback(err: BusinessError) { 314 if (err != null) { 315 console.error(`setData failed, code is ${err.code}, message is ${err.message}`); 316 } else { 317 console.info("setData success"); 318 } 319} 320subscriber.setData("publish_data_changed", setDataCallback); 321``` 322 323## setData 324 325setData(data: string): Promise\<void> 326 327设置有序公共事件的数据。使用Promise异步回调。 328 329**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 330 331**系统能力**：`SystemCapability.Notification.CommonEvent` 332 333**参数：** 334 335| 参数名 | 类型 | 必填 | 说明 | 336| ------ | ------ | ---- | -------------------- | 337| data | string | 是 | 公共事件的数据。 | 338 339**返回值：** 340 341| 类型 | 说明 | 342| ---------------- | -------------------- | 343| Promise\<void> | Promise对象。无返回结果的Promise对象。 | 344 345**示例：** 346 347```ts 348subscriber.setData("publish_data_changed").then(() => { 349 console.info("setData success"); 350}).catch((err: BusinessError) => { 351 console.error(`setData failed, code is ${err.code}, message is ${err.message}`); 352}); 353``` 354 355## setDataSync<sup>10+</sup> 356 357setDataSync(data: string): void 358 359设置有序公共事件的数据。 360 361**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 362 363**系统能力**：`SystemCapability.Notification.CommonEvent` 364 365**参数：** 366 367| 参数名 | 类型 | 必填 | 说明 | 368| ------ | ------ | ---- | -------------------- | 369| data | string | 是 | 公共事件的数据。 | 370 371**错误码：** 372 373以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 374 375| 错误码ID | 错误信息 | 376| -------- | ----------------------------------- | 377| 401 | Parameter error. Possible causes:<br>1. Mandatory parameters are left unspecified.<br>2. Incorrect parameter types.<br>3. Parameter verification failed. | 378 379**示例：** 380 381```ts 382try { 383 subscriber.setDataSync("publish_data_changed"); 384} catch (error) { 385 let err: BusinessError = error as BusinessError; 386 console.error(`setDataSync failed, code is ${err.code}, message is ${err.message}`); 387} 388``` 389 390## setCodeAndData 391 392setCodeAndData(code: number, data: string, callback:AsyncCallback\<void>): void 393 394设置有序公共事件代码和数据。使用callback异步回调。 395 396**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 397 398**系统能力**：`SystemCapability.Notification.CommonEvent` 399 400**参数：** 401 402| 参数名 | 类型 | 必填 | 说明 | 403| -------- | -------------------- | ---- | ---------------------- | 404| code | number | 是 | 公共事件的代码。 | 405| data | string | 是 | 公共事件的数据。 | 406| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 407 408**示例：** 409 410```ts 411// 设置有序公共事件的代码和数据回调 412function setCodeAndDataCallback(err: BusinessError) { 413 if (err != null) { 414 console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`); 415 } else { 416 console.info("setCodeAndData success"); 417 } 418} 419subscriber.setCodeAndData(1, "publish_data_changed", setCodeAndDataCallback); 420``` 421 422## setCodeAndData 423 424setCodeAndData(code: number, data: string): Promise\<void> 425 426设置有序公共事件的代码和数据。使用Promise异步回调。 427 428**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 429 430**系统能力**：`SystemCapability.Notification.CommonEvent` 431 432**参数：** 433 434| 参数名 | 类型 | 必填 | 说明 | 435| ------ | ------ | ---- | -------------------- | 436| code | number | 是 | 公共事件的代码。 | 437| data | string | 是 | 公共事件的数据。 | 438 439**返回值：** 440 441| 类型 | 说明 | 442| ---------------- | -------------------- | 443| Promise\<void> | Promise对象。无返回结果的Promise对象。 | 444 445**示例：** 446 447```ts 448subscriber.setCodeAndData(1, "publish_data_changed").then(() => { 449 console.info("setCodeAndData success"); 450}).catch((err: BusinessError) => { 451 console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`); 452}); 453``` 454 455## setCodeAndDataSync<sup>10+</sup> 456 457setCodeAndDataSync(code: number, data: string): void 458 459设置有序公共事件的代码和数据。 460 461**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 462 463**系统能力**：`SystemCapability.Notification.CommonEvent` 464 465**参数：** 466 467| 参数名 | 类型 | 必填 | 说明 | 468| ------ | ------ | ---- | -------------------- | 469| code | number | 是 | 公共事件的代码。 | 470| data | string | 是 | 公共事件的数据。 | 471 472**错误码：** 473 474以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 475 476| 错误码ID | 错误信息 | 477| -------- | ----------------------------------- | 478| 401 | Parameter error. Possible causes:<br>1. Mandatory parameters are left unspecified.<br>2. Incorrect parameter types.<br>3. Parameter verification failed. | 479 480**示例：** 481 482```ts 483try { 484 subscriber.setCodeAndDataSync(1, "publish_data_changed"); 485} catch (error) { 486 let err: BusinessError = error as BusinessError; 487 console.error(`setCodeAndDataSync failed, code is ${err.code}, message is ${err.message}`); 488} 489 490``` 491 492## isOrderedCommonEvent 493 494isOrderedCommonEvent(callback: AsyncCallback\<boolean>): void 495 496查询当前公共事件是否为有序公共事件。使用callback异步回调。 497 498**系统能力**：`SystemCapability.Notification.CommonEvent` 499 500**参数：** 501 502| 参数名 | 类型 | 必填 | 说明 | 503| -------- | ----------------------- | ---- | ---------------------------------- | 504| callback | AsyncCallback\<boolean> | 是 | 回调函数。返回true表示有序公共事件；false表示无序公共事件。 | 505 506**示例：** 507 508```ts 509// 获取当前公共事件是否为有序事件的回调 510function isOrderedCommonEventCallback(err: BusinessError, isOrdered:boolean) { 511 if (err != null) { 512 console.error(`isOrderedCommonEvent failed, code is ${err.code}, message is ${err.message}`); 513 } else { 514 console.info("isOrderedCommonEvent " + JSON.stringify(isOrdered)); 515 } 516} 517subscriber.isOrderedCommonEvent(isOrderedCommonEventCallback); 518``` 519 520## isOrderedCommonEvent 521 522isOrderedCommonEvent(): Promise\<boolean> 523 524查询当前公共事件是否为有序公共事件。使用Promise异步回调。 525 526**系统能力**：`SystemCapability.Notification.CommonEvent` 527 528**返回值：** 529 530| 类型 | 说明 | 531| ----------------- | -------------------------------- | 532| Promise\<boolean> | Promise对象。返回true表示有序公共事件；false表示无序公共事件。 | 533 534**示例：** 535 536```ts 537subscriber.isOrderedCommonEvent().then((isOrdered:boolean) => { 538 console.info("isOrderedCommonEvent " + JSON.stringify(isOrdered)); 539}).catch((err: BusinessError) => { 540 console.error(`isOrderedCommonEvent failed, code is ${err.code}, message is ${err.message}`); 541}); 542``` 543 544## isOrderedCommonEventSync<sup>10+</sup> 545 546isOrderedCommonEventSync(): boolean 547 548查询当前公共事件是否为有序公共事件。 549 550**系统能力**：`SystemCapability.Notification.CommonEvent` 551 552**返回值：** 553 554| 类型 | 说明 | 555| ----------------- | -------------------------------- | 556| boolean | 返回true表示有序公共事件；false表示无序公共事件。 | 557 558**示例：** 559 560```ts 561let isOrdered = subscriber.isOrderedCommonEventSync(); 562console.info("isOrderedCommonEventSync " + JSON.stringify(isOrdered)); 563``` 564 565## isStickyCommonEvent 566 567isStickyCommonEvent(callback: AsyncCallback\<boolean>): void 568 569检查当前公共事件是否为一个粘性事件。使用callback异步回调。 570 571**系统能力**：`SystemCapability.Notification.CommonEvent` 572 573**参数：** 574 575| 参数名 | 类型 | 必填 | 说明 | 576| -------- | ----------------------- | ---- | ---------------------------------- | 577| callback | AsyncCallback\<boolean> | 是 | 回调函数。返回true表示是粘性公共事件；false表示不是粘性公共事件。 | 578 579**示例：** 580 581```ts 582// 获取当前公共事件是否为粘性事件的回调 583function isStickyCommonEventCallback(err: BusinessError, isSticky:boolean) { 584 if (err != null) { 585 console.error(`isStickyCommonEvent failed, code is ${err.code}, message is ${err.message}`); 586 } else { 587 console.info("isStickyCommonEvent " + JSON.stringify(isSticky)); 588 } 589} 590subscriber.isStickyCommonEvent(isStickyCommonEventCallback); 591``` 592 593## isStickyCommonEvent 594 595isStickyCommonEvent(): Promise\<boolean> 596 597检查当前公共事件是否为一个粘性事件。使用Promise异步回调。 598 599**系统能力**：`SystemCapability.Notification.CommonEvent` 600 601**返回值：** 602 603| 类型 | 说明 | 604| ----------------- | -------------------------------- | 605| Promise\<boolean> | Promise对象。返回true表示是粘性公共事件；false表示不是粘性公共事件。 | 606 607**示例：** 608 609```ts 610subscriber.isStickyCommonEvent().then((isSticky:boolean) => { 611 console.info("isStickyCommonEvent " + JSON.stringify(isSticky)); 612}).catch((err: BusinessError) => { 613 console.error(`isStickyCommonEvent failed, code is ${err.code}, message is ${err.message}`); 614}); 615``` 616 617## isStickyCommonEventSync<sup>10+</sup> 618 619isStickyCommonEventSync(): boolean 620 621检查当前公共事件是否为一个粘性事件。 622 623**系统能力**：`SystemCapability.Notification.CommonEvent` 624 625**返回值：** 626 627| 类型 | 说明 | 628| ----------------- | -------------------------------- | 629| boolean | 返回true表示是粘性公共事件；false表示不是粘性公共事件。 | 630 631**示例：** 632 633```ts 634let isSticky = subscriber.isStickyCommonEventSync(); 635console.info("isStickyCommonEventSync " + JSON.stringify(isSticky)); 636``` 637 638## abortCommonEvent 639 640abortCommonEvent(callback: AsyncCallback\<void>): void 641 642该接口与[finishCommonEvent](#finishcommonevent9)配合使用，可以中止当前的有序公共事件，使该公共事件不再向下一个订阅者传递。使用callback异步回调。 643 644**系统能力**：`SystemCapability.Notification.CommonEvent` 645 646**参数：** 647 648| 参数名 | 类型 | 必填 | 说明 | 649| -------- | -------------------- | ---- | -------------------- | 650| callback | AsyncCallback\<void> | 是 | 取消当前的有序公共事件。 | 651 652**示例：** 653 654```ts 655// 中止当前的有序公共事件的回调 656function abortCommonEventCallback(err: BusinessError) { 657 if (err != null) { 658 console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`); 659 } else { 660 console.info("abortCommonEvent success"); 661 } 662} 663function finishCommonEventCallback(err: BusinessError) { 664 if (err != null) { 665 console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); 666 } else { 667 console.info("finishCommonEvent success"); 668 } 669} 670subscriber.abortCommonEvent(abortCommonEventCallback); 671subscriber.finishCommonEvent(finishCommonEventCallback); 672``` 673 674## abortCommonEvent 675 676abortCommonEvent(): Promise\<void> 677 678该接口与[finishCommonEvent](#finishcommonevent9)配合使用，可以中止当前的有序公共事件，使该公共事件不再向下一个订阅者传递。使用Promise异步回调。 679 680**系统能力**：`SystemCapability.Notification.CommonEvent` 681 682**返回值：** 683 684| 类型 | 说明 | 685| ---------------- | -------------------- | 686| Promise\<void> | Promise对象。无返回结果的Promise对象。 | 687 688**示例：** 689 690```ts 691subscriber.abortCommonEvent().then(() => { 692 console.info("abortCommonEvent success"); 693}).catch((err: BusinessError) => { 694 console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`); 695}); 696subscriber.finishCommonEvent().then(() => { 697 console.info("finishCommonEvent success"); 698}).catch((err: BusinessError) => { 699 console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); 700}); 701``` 702 703## abortCommonEventSync<sup>10+</sup> 704 705abortCommonEventSync(): void 706 707该接口与[finishCommonEvent](#finishcommonevent9)配合使用，可以中止当前的有序公共事件，使该公共事件不再向下一个订阅者传递。 708 709**系统能力**：`SystemCapability.Notification.CommonEvent` 710 711**示例：** 712 713```ts 714subscriber.abortCommonEventSync(); 715subscriber.finishCommonEvent().then(() => { 716 console.info("finishCommonEvent success"); 717}).catch((err: BusinessError) => { 718 console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); 719}); 720``` 721 722## clearAbortCommonEvent 723 724clearAbortCommonEvent(callback: AsyncCallback\<void>): void 725 726该接口与[finishCommonEvent](#finishcommonevent9)配合使用，可以取消当前有序公共事件的中止状态，使该公共事件继续向下一个订阅者传递。使用callback异步回调。 727 728**系统能力**：`SystemCapability.Notification.CommonEvent` 729 730**参数：** 731 732| 参数名 | 类型 | 必填 | 说明 | 733| -------- | -------------------- | ---- | -------------------- | 734| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 735 736**示例：** 737 738```ts 739// 取消当前有序公共事件的中止状态的回调 740function clearAbortCommonEventCallback(err: BusinessError) { 741 if (err != null) { 742 console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); 743 } else { 744 console.info("clearAbortCommonEvent success"); 745 } 746} 747function finishCommonEventCallback(err: BusinessError) { 748 if (err != null) { 749 console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); 750 } else { 751 console.info("finishCommonEvent success"); 752 } 753} 754subscriber.clearAbortCommonEvent(clearAbortCommonEventCallback); 755subscriber.finishCommonEvent(finishCommonEventCallback); 756``` 757 758## clearAbortCommonEvent 759 760clearAbortCommonEvent(): Promise\<void> 761 762该接口与[finishCommonEvent](#finishcommonevent9)配合使用，可以取消当前有序公共事件的中止状态，使该公共事件继续向下一个订阅者传递。使用Promise异步回调。 763 764**系统能力**：`SystemCapability.Notification.CommonEvent` 765 766**返回值：** 767 768| 类型 | 说明 | 769| ---------------- | -------------------- | 770| Promise\<void> | Promise对象。无返回结果的Promise对象。 | 771 772**示例：** 773 774```ts 775subscriber.clearAbortCommonEvent().then(() => { 776 console.info("clearAbortCommonEvent success"); 777}).catch((err: BusinessError) => { 778 console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); 779}); 780subscriber.finishCommonEvent().then(() => { 781 console.info("finishCommonEvent success"); 782}).catch((err: BusinessError) => { 783 console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); 784}); 785``` 786 787## clearAbortCommonEventSync<sup>10+</sup> 788 789clearAbortCommonEventSync(): void 790 791该接口与[finishCommonEvent](#finishcommonevent9)配合使用，可以取消当前有序公共事件的中止状态，使该公共事件继续向下一个订阅者传递。 792 793**系统能力**：`SystemCapability.Notification.CommonEvent` 794 795**示例：** 796 797```ts 798subscriber.clearAbortCommonEventSync(); 799subscriber.finishCommonEvent().then(() => { 800 console.info("finishCommonEvent success"); 801}).catch((err: BusinessError) => { 802 console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); 803}); 804``` 805 806## getAbortCommonEvent 807 808getAbortCommonEvent(callback: AsyncCallback\<boolean>): void 809 810获取当前有序公共事件是否处于中止状态。使用callback异步回调。 811 812**系统能力**：`SystemCapability.Notification.CommonEvent` 813 814**参数：** 815 816| 参数名 | 类型 | 必填 | 说明 | 817| -------- | ----------------------- | ---- | ---------------------------------- | 818| callback | AsyncCallback\<boolean> | 是 | 回调函数。返回true表示当前有序公共事件处于中止状态；false表示当前有序公共事件没有处于中止状态。 | 819 820**示例：** 821 822```ts 823// 获取当前有序公共事件是否处于中止状态回调 824function getAbortCommonEventCallback(err: BusinessError, abortEvent:boolean) { 825 if (err != null) { 826 console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); 827 } else { 828 console.info("getAbortCommonEvent " + JSON.stringify(abortEvent)); 829 } 830} 831subscriber.getAbortCommonEvent(getAbortCommonEventCallback); 832``` 833 834## getAbortCommonEvent 835 836getAbortCommonEvent(): Promise\<boolean> 837 838获取当前有序公共事件是否处于中止状态。使用Promise异步回调。 839 840**系统能力**：`SystemCapability.Notification.CommonEvent` 841 842**返回值：** 843 844| 类型 | 说明 | 845| ----------------- | ---------------------------------- | 846| Promise\<boolean> | Promise对象。返回true表示当前有序公共事件处于中止状态；false表示当前有序公共事件没有处于中止状态。 | 847 848**示例：** 849 850```ts 851subscriber.getAbortCommonEvent().then((abortEvent:boolean) => { 852 console.info("getAbortCommonEvent " + JSON.stringify(abortEvent)); 853}).catch((err: BusinessError) => { 854 console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); 855}); 856``` 857 858## getAbortCommonEventSync<sup>10+</sup> 859 860getAbortCommonEventSync(): boolean 861 862获取当前有序公共事件是否处于中止状态。 863 864**系统能力**：`SystemCapability.Notification.CommonEvent` 865 866**返回值：** 867 868| 类型 | 说明 | 869| ----------------- | ---------------------------------- | 870| boolean | 表示当前有序公共事件是否取消的状态。 | 871 872**示例：** 873 874```ts 875let abortEvent = subscriber.getAbortCommonEventSync(); 876console.info("getAbortCommonEventSync " + JSON.stringify(abortEvent)); 877``` 878 879## getSubscribeInfo 880 881getSubscribeInfo(callback: AsyncCallback\<CommonEventSubscribeInfo>): void 882 883获取订阅者的订阅信息。使用callback异步回调。 884 885**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 886 887**系统能力**：`SystemCapability.Notification.CommonEvent` 888 889**参数：** 890 891| 参数名 | 类型 | 必填 | 说明 | 892| -------- | ------------------------------------------------------------ | ---- | ---------------------- | 893| callback | AsyncCallback\<[CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md)> | 是 | 表示订阅者的订阅信息。 | 894 895**示例：** 896 897```ts 898// 获取订阅者信息回调 899function getSubscribeInfoCallback(err: BusinessError, subscribeInfo:commonEventManager.CommonEventSubscribeInfo) { 900 if (err != null) { 901 console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`); 902 } else { 903 console.info("getSubscribeInfo " + JSON.stringify(subscribeInfo)); 904 } 905} 906subscriber.getSubscribeInfo(getSubscribeInfoCallback); 907``` 908 909## getSubscribeInfo 910 911getSubscribeInfo(): Promise\<CommonEventSubscribeInfo> 912 913获取订阅者的订阅信息。使用Promise异步回调。 914 915**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 916 917**系统能力**：`SystemCapability.Notification.CommonEvent` 918 919**返回值：** 920 921| 类型 | 说明 | 922| ------------------------------------------------------------ | ---------------------- | 923| Promise\<[CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md)> | Promise对象。返回订阅者的订阅信息。 | 924 925**示例：** 926 927```ts 928subscriber.getSubscribeInfo().then((subscribeInfo:commonEventManager.CommonEventSubscribeInfo) => { 929 console.info("getSubscribeInfo " + JSON.stringify(subscribeInfo)); 930}).catch((err: BusinessError) => { 931 console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`); 932}); 933``` 934 935## getSubscribeInfoSync<sup>10+</sup> 936 937getSubscribeInfoSync(): CommonEventSubscribeInfo 938 939获取订阅者的订阅信息。 940 941**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 942 943**系统能力**：`SystemCapability.Notification.CommonEvent` 944 945**返回值：** 946 947| 类型 | 说明 | 948| ------------------------------------------------------------ | ---------------------- | 949| [CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md) | 表示订阅者的订阅信息。 | 950 951**示例：** 952 953```ts 954let subscribeInfo = subscriber.getSubscribeInfoSync(); 955console.info("getSubscribeInfoSync " + JSON.stringify(subscribeInfo)); 956``` 957 958## finishCommonEvent<sup>9+</sup> 959 960finishCommonEvent(callback: AsyncCallback\<void>): void 961 962用于订阅者结束对当前有序公共事件的处理。使用callback异步回调。 963 964**系统能力**：`SystemCapability.Notification.CommonEvent` 965 966**参数：** 967 968| 参数名 | 类型 | 必填 | 说明 | 969| -------- | -------------------- | ---- | -------------------------------- | 970| callback | AsyncCallback\<void> | 是 | 表示有序公共事件结束后的回调函数。 | 971 972**示例：** 973 974```ts 975// 结束订阅者对当前有序公共事件处理的回调 976function finishCommonEventCallback(err: BusinessError) { 977 if (err != null) { 978 console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); 979 } else { 980 console.info("finishCommonEvent success"); 981 } 982} 983subscriber.finishCommonEvent(finishCommonEventCallback); 984``` 985 986## finishCommonEvent<sup>9+</sup> 987 988finishCommonEvent(): Promise\<void> 989 990用于订阅者结束对当前有序公共事件的处理。使用Promise异步回调。 991 992**系统能力**：`SystemCapability.Notification.CommonEvent` 993 994**返回值：** 995 996| 类型 | 说明 | 997| ---------------- | -------------------- | 998| Promise\<void> | Promise对象。无返回结果的Promise对象。 | 999 1000**示例：** 1001 1002```ts 1003subscriber.finishCommonEvent().then(() => { 1004 console.info("finishCommonEvent success"); 1005}).catch((err: BusinessError) => { 1006 console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); 1007}); 1008```