1# CommonEventSubscriber 2 3## getCode 4 5```ts 6getCode(callback: AsyncCallback<number>): void 7``` 8 9以回调形式获取公共事件代码。 10 11**系统能力**：`SystemCapability.Notification.CommonEvent` 12 13**参数：** 14 15| 参数名 | 类型 | 必填 | 说明 | 16| -------- | ---------------------- | ---- | ------------------ | 17| callback | AsyncCallback\<number\> | 是 | 公共事件代码。 | 18 19**示例：** 20 21```ts 22let subscriber; //创建成功的订阅者对象 23 24//获取有序公共事件代码回调 25function getCodeCB(err, code) { 26 if (err.code) { 27 console.error(`getCode failed, code is ${err.code}, message is ${err.message}`); 28 } else { 29 console.info("getCode " + JSON.stringify(code)); 30 } 31} 32subscriber.getCode(getCodeCB); 33``` 34 35## getCode 36 37```ts 38getCode(): Promise<number> 39``` 40 41以Promise形式获取公共事件代码。 42 43**系统能力**：`SystemCapability.Notification.CommonEvent` 44 45**返回值：** 46 47| 类型 | 说明 | 48| ---------------- | -------------------- | 49| Promise\<number> | 公共事件代码。 | 50 51**示例：** 52 53```ts 54let subscriber; //创建成功的订阅者对象 55 56subscriber.getCode().then((code) => { 57 console.info("getCode " + JSON.stringify(code)); 58}).catch((err) => { 59 console.error(`getCode failed, code is ${err.code}, message is ${err.message}`); 60}); 61``` 62 63## setCode 64 65```ts 66setCode(code: number, callback: AsyncCallback<void>): void 67``` 68 69以回调形式设置公共事件的代码。 70 71**系统能力**：`SystemCapability.Notification.CommonEvent` 72 73**参数：** 74 75| 参数名 | 类型 | 必填 | 说明 | 76| -------- | -------------------- | ---- | ---------------------- | 77| code | number | 是 | 公共事件的代码。 | 78| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 79 80**示例：** 81 82```ts 83let subscriber; //创建成功的订阅者对象 84 85//设置有序公共事件的代码回调 86function setCodeCB(err) { 87 if (err.code) { 88 console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); 89 } else { 90 console.info("setCode"); 91 } 92} 93subscriber.setCode(1, setCodeCB); 94``` 95 96## setCode 97 98```ts 99setCode(code: number): Promise<void> 100``` 101 102以Promise形式设置公共事件的代码。 103 104**系统能力**：`SystemCapability.Notification.CommonEvent` 105 106**参数：** 107 108| 参数名 | 类型 | 必填 | 说明 | 109| ------ | ------ | ---- | ------------------ | 110| code | number | 是 | 公共事件的代码。 | 111 112**返回值：** 113 114| 类型 | 说明 | 115| ---------------- | -------------------- | 116| Promise\<void> | 返回一个Promise的结果。 | 117 118**示例：** 119 120```ts 121let subscriber; //创建成功的订阅者对象 122 123subscriber.setCode(1).then(() => { 124 console.info("setCode"); 125}).catch((err) => { 126 console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); 127}); 128``` 129 130## getData 131 132```ts 133getData(callback: AsyncCallback<string>): void 134``` 135 136以回调形式获取公共事件的数据。 137 138**系统能力**：`SystemCapability.Notification.CommonEvent` 139 140**参数：** 141 142| 参数名 | 类型 | 必填 | 说明 | 143| -------- | ---------------------- | ---- | -------------------- | 144| callback | AsyncCallback\<string> | 是 | 公共事件的数据。 | 145 146**示例：** 147 148```ts 149let subscriber; //创建成功的订阅者对象 150 151//获取有序公共事件代码数据回调 152function getDataCB(err, data) { 153 if (err.code) { 154 console.error(`getData failed, code is ${err.code}, message is ${err.message}`); 155 } else { 156 console.info("getData " + JSON.stringify(data)); 157 } 158} 159subscriber.getData(getDataCB); 160``` 161 162## getData 163 164```ts 165getData(): Promise<string> 166``` 167 168以Promise形式获取公共事件的数据。 169 170**系统能力**：`SystemCapability.Notification.CommonEvent` 171 172**返回值：** 173 174| 类型 | 说明 | 175| ---------------- | ------------------ | 176| Promise\<string> | 公共事件的数据。 | 177 178**示例：** 179 180```ts 181let subscriber; //创建成功的订阅者对象 182 183subscriber.getData().then((data) => { 184 console.info("getData " + JSON.stringify(data)); 185}).catch((err) => { 186 console.error(`getData failed, code is ${err.code}, message is ${err.message}`); 187}); 188``` 189 190## setData 191 192setData(data: string, callback: AsyncCallback\<void>): void 193 194以回调形式设置公共事件的数据。 195 196**系统能力**：`SystemCapability.Notification.CommonEvent` 197 198**参数：** 199 200| 参数名 | 类型 | 必填 | 说明 | 201| -------- | -------------------- | ---- | -------------------- | 202| data | string | 是 | 公共事件的数据。 | 203| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 204 205**示例：** 206 207```ts 208let subscriber; //创建成功的订阅者对象 209 210//设置有序公共事件的结果数据回调 211function setDataCB(err) { 212 if (err.code) { 213 console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); 214 } else { 215 console.info("setData"); 216 } 217} 218subscriber.setData("publish_data_changed", setDataCB); 219``` 220 221## setData 222 223```ts 224setData(data: string): Promise<void> 225``` 226 227以Promise形式设置公共事件的果数据。 228 229**系统能力**：`SystemCapability.Notification.CommonEvent` 230 231**参数：** 232 233| 参数名 | 类型 | 必填 | 说明 | 234| ------ | ------ | ---- | -------------------- | 235| data | string | 是 | 公共事件的数据。 | 236 237**返回值：** 238 239| 类型 | 说明 | 240| ---------------- | -------------------- | 241| Promise\<void> | 返回一个Promise的结果。 | 242 243**示例：** 244 245```ts 246let subscriber; //创建成功的订阅者对象 247 248subscriber.setData("publish_data_changed").then(() => { 249 console.info("setData"); 250}).catch((err) => { 251 console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); 252}); 253``` 254 255## setCodeAndData 256 257```ts 258setCodeAndData(code: number, data: string, callback:AsyncCallback<void>): void 259``` 260 261以回调形式设置公共事件代码和数据。 262 263**系统能力**：`SystemCapability.Notification.CommonEvent` 264 265**参数：** 266 267| 参数名 | 类型 | 必填 | 说明 | 268| -------- | -------------------- | ---- | ---------------------- | 269| code | number | 是 | 公共事件的代码。 | 270| data | string | 是 | 公共事件的数据。 | 271| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 272 273**示例：** 274 275```ts 276let subscriber; //创建成功的订阅者对象 277 278//设置有序公共事件的代码和数据回调 279function setCodeDataCB(err) { 280 if (err.code) { 281 console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`); 282 } else { 283 console.info("setCodeDataCallback"); 284 } 285} 286subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCB); 287``` 288 289## setCodeAndData 290 291```ts 292setCodeAndData(code: number, data: string): Promise<void> 293``` 294 295以Promise形式设置公共事件的代码和数据。 296 297**系统能力**：`SystemCapability.Notification.CommonEvent` 298 299**参数：** 300 301| 参数名 | 类型 | 必填 | 说明 | 302| ------ | ------ | ---- | -------------------- | 303| code | number | 是 | 公共事件的代码。 | 304| data | string | 是 | 公共事件的数据。 | 305 306**返回值：** 307 308| 类型 | 说明 | 309| ---------------- | -------------------- | 310| Promise\<void> | 返回一个Promise。 | 311 312**示例：** 313 314```ts 315let subscriber; //创建成功的订阅者对象 316 317subscriber.setCodeAndData(1, "publish_data_changed").then(() => { 318 console.info("setCodeAndData"); 319}).catch((err) => { 320 console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`); 321}); 322``` 323 324## isOrderedCommonEvent 325 326```ts 327isOrderedCommonEvent(callback: AsyncCallback<boolean>): void 328``` 329 330以回调形式查询当前公共事件的是否为有序公共事件。 331 332返回true代表是有序公共事件，false代表不是有序公共事件。 333 334**系统能力**：`SystemCapability.Notification.CommonEvent` 335 336**参数：** 337 338| 参数名 | 类型 | 必填 | 说明 | 339| -------- | ----------------------- | ---- | ---------------------------------- | 340| callback | AsyncCallback\<boolean> | 是 | 当前公共事件的是否为有序公共事件。 | 341 342**示例：** 343 344```ts 345let subscriber; //创建成功的订阅者对象 346 347//获取当前公共事件是否为有序事件的回调 348function isOrderedCB(err, isOrdered) { 349 if (err.code) { 350 console.error(`isOrderedCommonEvent failed, code is ${err.code}, message is ${err.message}`); 351 } else { 352 console.info("isOrdered " + JSON.stringify(isOrdered)); 353 } 354} 355subscriber.isOrderedCommonEvent(isOrderedCB); 356``` 357 358## isOrderedCommonEvent 359 360```ts 361isOrderedCommonEvent(): Promise<boolean> 362``` 363 364以Promise形式查询当前公共事件的是否为有序公共事件。 365 366返回true代表是有序公共事件，false代表不是有序公共事件。 367 368**系统能力**：`SystemCapability.Notification.CommonEvent` 369 370**返回值：** 371 372| 类型 | 说明 | 373| ----------------- | -------------------------------- | 374| Promise\<boolean> | 当前公共事件的是否为有序公共事件。 | 375 376**示例：** 377 378```ts 379let subscriber; //创建成功的订阅者对象 380 381subscriber.isOrderedCommonEvent().then((isOrdered) => { 382 console.info("isOrdered " + JSON.stringify(isOrdered)); 383}).catch((err) => { 384 console.error(`isOrdered failed, code is ${err.code}, message is ${err.message}`); 385}); 386``` 387 388## isStickyCommonEvent 389 390```ts 391isStickyCommonEvent(callback: AsyncCallback<boolean>): void 392``` 393 394以回调形式检查当前公共事件是否为一个粘性事件。 395 396返回true代表是粘性公共事件，false代表不是粘性公共事件。 397 398**系统能力**：`SystemCapability.Notification.CommonEvent` 399 400**参数：** 401 402| 参数名 | 类型 | 必填 | 说明 | 403| -------- | ----------------------- | ---- | ---------------------------------- | 404| callback | AsyncCallback\<boolean> | 是 | 当前公共事件的是否为粘性公共事件。 | 405 406**示例：** 407 408```ts 409let subscriber; //创建成功的订阅者对象 410 411//获取当前公共事件是否为粘性事件的回调 412function isStickyCB(err, isSticky) { 413 if (err.code) { 414 console.error(`isStickyCommonEvent failed, code is ${err.code}, message is ${err.message}`); 415 } else { 416 console.info("isSticky " + JSON.stringify(isSticky)); 417 } 418} 419subscriber.isStickyCommonEvent(isStickyCB); 420``` 421 422## isStickyCommonEvent 423 424```ts 425isStickyCommonEvent(): Promise<boolean> 426``` 427 428以Promise形式检查当前公共事件是否为一个粘性事件。 429 430返回true代表是粘性公共事件，false代表不是粘性公共事件。 431 432**系统能力**：`SystemCapability.Notification.CommonEvent` 433 434**返回值：** 435 436| 类型 | 说明 | 437| ----------------- | -------------------------------- | 438| Promise\<boolean> | 当前公共事件的是否为粘性公共事件。 | 439 440**示例：** 441 442```ts 443let subscriber; //创建成功的订阅者对象 444 445subscriber.isStickyCommonEvent().then((isSticky) => { 446 console.info("isSticky " + JSON.stringify(isSticky)); 447}).catch((err) => { 448 console.error(`isSticky failed, code is ${err.code}, message is ${err.message}`); 449}); 450``` 451 452## abortCommonEvent 453 454```ts 455abortCommonEvent(callback: AsyncCallback<void>): void 456``` 457 458以回调形式取消当前的有序公共事件，取消后，有序公共事件不再向下一个订阅者传递。 459 460**系统能力**：`SystemCapability.Notification.CommonEvent` 461 462**参数：** 463 464| 参数名 | 类型 | 必填 | 说明 | 465| -------- | -------------------- | ---- | -------------------- | 466| callback | AsyncCallback\<void> | 是 | 取消当前的有序公共事件。 | 467 468**示例：** 469 470```ts 471let subscriber; //创建成功的订阅者对象 472 473//取消当前有序公共事件的回调 474function abortCB(err) { 475 if (err.code) { 476 console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`); 477 } else { 478 console.info("abortCommonEvent"); 479 } 480} 481subscriber.abortCommonEvent(abortCB); 482``` 483 484## abortCommonEvent 485 486```ts 487abortCommonEvent(): Promise<void> 488``` 489 490以Promise形式取消当前的有序公共事件，取消后，公共事件不再向下一个订阅者传递。 491 492**系统能力**：`SystemCapability.Notification.CommonEvent` 493 494**返回值：** 495 496| 类型 | 说明 | 497| ---------------- | -------------------- | 498| Promise\<void> | 返回一个Promise的结果。 | 499 500**示例：** 501 502```ts 503let subscriber; //创建成功的订阅者对象 504 505subscriber.abortCommonEvent().then(() => { 506 console.info("abortCommonEvent"); 507}).catch((err) => { 508 console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`); 509}); 510``` 511 512## clearAbortCommonEvent 513 514```ts 515clearAbortCommonEvent(callback: AsyncCallback<void>): void 516``` 517 518以回调形式清除当前有序公共事件。 519 520**系统能力**：`SystemCapability.Notification.CommonEvent` 521 522**参数：** 523 524| 参数名 | 类型 | 必填 | 说明 | 525| -------- | -------------------- | ---- | -------------------- | 526| callback | AsyncCallback\<void> | 是 | 表示被指定的回调方法。 | 527 528**示例：** 529 530```ts 531let subscriber; //创建成功的订阅者对象 532 533//清除当前公共事件取消状态的回调 534function clearAbortCB(err) { 535 if (err.code) { 536 console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); 537 } else { 538 console.info("clearAbortCommonEvent"); 539 } 540} 541subscriber.clearAbortCommonEvent(clearAbortCB); 542``` 543 544## clearAbortCommonEvent 545 546```ts 547clearAbortCommonEvent(): Promise<void> 548``` 549 550以Promise形式清除当前有序公共事件。 551 552**系统能力**：`SystemCapability.Notification.CommonEvent` 553 554**返回值：** 555 556| 类型 | 说明 | 557| ---------------- | -------------------- | 558| Promise\<void> | 返回一个Promise的结果。 | 559 560**示例：** 561 562```ts 563let subscriber; //创建成功的订阅者对象 564 565subscriber.clearAbortCommonEvent().then(() => { 566 console.info("clearAbortCommonEvent"); 567}).catch((err) => { 568 console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); 569}); 570``` 571 572## getAbortCommonEvent 573 574```ts 575getAbortCommonEvent(callback: AsyncCallback<boolean>): void 576``` 577 578以回调形式获取当前有序公共事件是否取消的状态。 579 580**系统能力**：`SystemCapability.Notification.CommonEvent` 581 582**参数：** 583 584| 参数名 | 类型 | 必填 | 说明 | 585| -------- | ----------------------- | ---- | ---------------------------------- | 586| callback | AsyncCallback\<boolean> | 是 | 表示当前有序公共事件是否取消的状态。 | 587 588**示例：** 589 590```ts 591let subscriber; //创建成功的订阅者对象 592 593//获取当前有序公共事件是否取消的回调 594function getAbortCB(err, abortEvent) { 595 if (err.code) { 596 console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); 597 } else { 598 console.info("abortCommonEvent " + abortEvent) 599 } 600} 601subscriber.getAbortCommonEvent(getAbortCB); 602``` 603 604## getAbortCommonEvent 605 606```ts 607getAbortCommonEvent(): Promise<boolean> 608``` 609 610以Promise形式获取当前有序公共事件是否取消的状态。 611 612**系统能力**：`SystemCapability.Notification.CommonEvent` 613 614**返回值：** 615 616| 类型 | 说明 | 617| ----------------- | ---------------------------------- | 618| Promise\<boolean> | 表示当前有序公共事件是否取消的状态。 | 619 620**示例：** 621 622```ts 623let subscriber; //创建成功的订阅者对象 624 625subscriber.getAbortCommonEvent().then((abortEvent) => { 626 console.info("abortCommonEvent " + JSON.stringify(abortEvent)); 627}).catch((err) => { 628 console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); 629}); 630``` 631 632## getSubscribeInfo 633 634```ts 635getSubscribeInfo(callback: AsyncCallback<CommonEventSubscribeInfo>): void 636``` 637 638以回调形式获取订阅者的订阅信息。 639 640**系统能力**：`SystemCapability.Notification.CommonEvent` 641 642**参数：** 643 644| 参数名 | 类型 | 必填 | 说明 | 645| -------- | ------------------------------------------------------------ | ---- | ---------------------- | 646| callback | AsyncCallback\<[CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md)> | 是 | 表示订阅者的订阅信息。 | 647 648**示例：** 649 650```ts 651let subscriber; //创建成功的订阅者对象 652 653//获取订阅者信息回调 654function getCB(err, subscribeInfo) { 655 if (err.code) { 656 console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`); 657 } else { 658 console.info("subscribeInfo " + JSON.stringify(subscribeInfo)); 659 } 660} 661subscriber.getSubscribeInfo(getCB); 662``` 663 664## getSubscribeInfo 665 666```ts 667getSubscribeInfo(): Promise<CommonEventSubscribeInfo> 668``` 669 670以Promise形式获取订阅者的订阅信息。 671 672**系统能力**：`SystemCapability.Notification.CommonEvent` 673 674**返回值：** 675 676| 类型 | 说明 | 677| ------------------------------------------------------------ | ---------------------- | 678| Promise\<[CommonEventSubscribeInfo](./js-apis-inner-commonEvent-commonEventSubscribeInfo.md)> | 表示订阅者的订阅信息。 | 679 680**示例：** 681 682```ts 683let subscriber; //创建成功的订阅者对象 684 685subscriber.getSubscribeInfo().then((subscribeInfo) => { 686 console.info("subscribeInfo " + JSON.stringify(subscribeInfo)); 687}).catch((err) => { 688 console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`); 689}); 690``` 691 692## finishCommonEvent<sup>9+</sup> 693 694```ts 695finishCommonEvent(callback: AsyncCallback<void>): void 696``` 697 698以回调形式结束当前有序公共事件。 699 700**系统能力**：`SystemCapability.Notification.CommonEvent` 701 702**参数：** 703 704| 参数名 | 类型 | 必填 | 说明 | 705| -------- | -------------------- | ---- | -------------------------------- | 706| callback | AsyncCallback\<void> | 是 | 表示有序公共事件结束后的回调函数。 | 707 708**示例：** 709 710```ts 711let subscriber; //创建成功的订阅者对象 712 713//结束当前有序公共事件的回调 714function finishCB(err) { 715 if (err.code) { 716 console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); 717} else { 718 console.info("FinishCommonEvent"); 719} 720 721subscriber.finishCommonEvent(finishCB); 722``` 723 724## finishCommonEvent<sup>9+</sup> 725 726```ts 727finishCommonEvent(): Promise<void\> 728``` 729 730以Promise形式结束当前有序公共事件。 731 732**系统能力**：`SystemCapability.Notification.CommonEvent` 733 734**返回值：** 735 736| 类型 | 说明 | 737| ---------------- | -------------------- | 738| Promise\<void> | 返回一个Promise的结果。 | 739 740**示例：** 741 742```ts 743let subscriber; //创建成功的订阅者对象 744 745subscriber.finishCommonEvent().then(() => { 746 console.info("FinishCommonEvent"); 747}).catch((err) => { 748 console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); 749}); 750```