Skip to content

D
Docs

OpenHarmony / Docs
10 个月 前同步成功

通知 158
Star 292
Fork 28
D
Docs

前往新版Gitcode，体验更适合开发者的 AI 搜索 >>

未验证 提交 467386e6 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!22778 ArkTs适配 

Merge pull request !22778 from XKK/0823
上级 694a4f1c 77ab2b72
显示空白变更内容
内联 并排
Showing with 182 addition and 172 deletion
en/application-dev/reference/apis/js-apis-commonEvent.md
浏览文件 @ 467386e6
...@@ -12,6 +12,8 @@ The **CommonEvent** module provides common event capabilities, including the cap ...@@ -12,6 +12,8 @@ The **CommonEvent** module provides common event capabilities, including the cap
```ts ```ts
import CommonEvent from '@ohos.commonEvent'; import CommonEvent from '@ohos.commonEvent';
import CommonEventManager from '@ohos.commonEventManager';
import Base from '@ohos.base';
``` ```
## Support ## Support
...@@ -43,7 +45,7 @@ Publishes a common event. This API uses an asynchronous callback to return the r ...@@ -43,7 +45,7 @@ Publishes a common event. This API uses an asynchronous callback to return the r
```ts ```ts
// Callback for common event publication // Callback for common event publication
function publishCB(err) { function publishCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`publish failed, code is ${err.code}`); console.error(`publish failed, code is ${err.code}`);
} else { } else {
...@@ -80,14 +82,14 @@ Publishes a common event with given attributes. This API uses an asynchronous ca ...@@ -80,14 +82,14 @@ Publishes a common event with given attributes. This API uses an asynchronous ca
```ts ```ts
// Attributes of a common event. // Attributes of a common event.
let options = { let options:CommonEventManager.CommonEventPublishData = {
code: 0, // Result code of the common event. code: 0, // Result code of the common event.
data: "initial data";// Result data of the common event. data: "initial data",// Result data of the common event.
isOrdered: true // The common event is an ordered one. isOrdered: true // The common event is an ordered one.
} }
// Callback for common event publication // Callback for common event publication
function publishCB(err) { function publishCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`publish failed, code is ${err.code}`); console.error(`publish failed, code is ${err.code}`);
} else { } else {
...@@ -125,7 +127,7 @@ Publishes a common event to a specific user. This API uses an asynchronous callb ...@@ -125,7 +127,7 @@ Publishes a common event to a specific user. This API uses an asynchronous callb
```ts ```ts
// Callback for common event publication // Callback for common event publication
function publishCB(err) { function publishCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`publishAsUser failed, code is ${err.code}`); console.error(`publishAsUser failed, code is ${err.code}`);
} else { } else {
...@@ -168,13 +170,13 @@ Publishes a common event with given attributes to a specific user. This API uses ...@@ -168,13 +170,13 @@ Publishes a common event with given attributes to a specific user. This API uses
```ts ```ts
// Attributes of a common event. // Attributes of a common event.
let options = { let options:CommonEventManager.CommonEventPublishData = {
code: 0, // Result code of the common event. code: 0, // Result code of the common event.
data: "initial data",// Result data of the common event. data: "initial data",// Result data of the common event.
} }
// Callback for common event publication // Callback for common event publication
function publishCB(err) { function publishCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`publishAsUser failed, code is ${err.code}`); console.error(`publishAsUser failed, code is ${err.code}`);
} else { } else {
...@@ -212,15 +214,15 @@ Creates a subscriber. This API uses an asynchronous callback to return the resul ...@@ -212,15 +214,15 @@ Creates a subscriber. This API uses an asynchronous callback to return the resul
```ts ```ts
let subscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription. let subscriber:CommonEventManager.CommonEventSubscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription.
// Subscriber information. // Subscriber information.
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
// Callback for subscriber creation. // Callback for subscriber creation.
function createCB(err, commonEventSubscriber) { function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) {
if (err.code) { if (err.code) {
console.error(`createSubscriber failed, code is ${err.code}`); console.error(`createSubscriber failed, code is ${err.code}`);
} else { } else {
...@@ -259,18 +261,18 @@ Creates a subscriber. This API uses a promise to return the result. ...@@ -259,18 +261,18 @@ Creates a subscriber. This API uses a promise to return the result.
**Example** **Example**
```ts ```ts
let subscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription. let subscriber:CommonEventManager.CommonEventSubscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription.
// Subscriber information. // Subscriber information.
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
// Create a subscriber. // Create a subscriber.
CommonEvent.createSubscriber(subscribeInfo).then((commonEventSubscriber) => { CommonEvent.createSubscriber(subscribeInfo).then((commonEventSubscriber:CommonEventManager.CommonEventSubscriber) => {
console.info("createSubscriber"); console.info("createSubscriber");
subscriber = commonEventSubscriber; subscriber = commonEventSubscriber;
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`createSubscriber failed, code is ${err.code}`); console.error(`createSubscriber failed, code is ${err.code}`);
}); });
``` ```
...@@ -297,15 +299,15 @@ Subscribes to common events. This API uses an asynchronous callback to return th ...@@ -297,15 +299,15 @@ Subscribes to common events. This API uses an asynchronous callback to return th
**Example** **Example**
```ts ```ts
let subscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription. let subscriber:CommonEventManager.CommonEventSubscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription.
// Subscriber information. // Subscriber information.
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
// Callback for common event subscription. // Callback for common event subscription.
function subscribeCB(err, data) { function subscribeCB(err:Base.BusinessError, data:CommonEventManager.CommonEventData) {
if (err.code) { if (err.code) {
console.error(`subscribe failed, code is ${err.code}`); console.error(`subscribe failed, code is ${err.code}`);
} else { } else {
...@@ -314,7 +316,7 @@ function subscribeCB(err, data) { ...@@ -314,7 +316,7 @@ function subscribeCB(err, data) {
} }
// Callback for subscriber creation. // Callback for subscriber creation.
function createCB(err, commonEventSubscriber) { function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) {
if (err.code) { if (err.code) {
console.error(`createSubscriber failed, code is ${err.code}`); console.error(`createSubscriber failed, code is ${err.code}`);
} else { } else {
...@@ -351,15 +353,15 @@ Unsubscribes from common events. This API uses an asynchronous callback to retur ...@@ -351,15 +353,15 @@ Unsubscribes from common events. This API uses an asynchronous callback to retur
**Example** **Example**
```ts ```ts
let subscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription. let subscriber:CommonEventManager.CommonEventSubscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription.
// Subscriber information. // Subscriber information.
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
// Callback for common event subscription. // Callback for common event subscription.
function subscribeCB(err, data) { function subscribeCB(err:Base.BusinessError, data:CommonEventManager.CommonEventData) {
if (err.code) { if (err.code) {
console.error(`subscribe failed, code is ${err.code}`); console.error(`subscribe failed, code is ${err.code}`);
} else { } else {
...@@ -368,7 +370,7 @@ function subscribeCB(err, data) { ...@@ -368,7 +370,7 @@ function subscribeCB(err, data) {
} }
// Callback for subscriber creation. // Callback for subscriber creation.
function createCB(err, commonEventSubscriber) { function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) {
if (err.code) { if (err.code) {
console.error(`createSubscriber failed, code is ${err.code}`); console.error(`createSubscriber failed, code is ${err.code}`);
} else { } else {
...@@ -380,7 +382,7 @@ function createCB(err, commonEventSubscriber) { ...@@ -380,7 +382,7 @@ function createCB(err, commonEventSubscriber) {
} }
// Callback for common event unsubscription. // Callback for common event unsubscription.
function unsubscribeCB(err) { function unsubscribeCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`unsubscribe failed, code is ${err.code}`); console.error(`unsubscribe failed, code is ${err.code}`);
} else { } else {
......
en/application-dev/reference/apis/js-apis-commonEventManager.md
浏览文件 @ 467386e6
...@@ -10,6 +10,7 @@ The **CommonEventManager** module provides common event capabilities, including ...@@ -10,6 +10,7 @@ The **CommonEventManager** module provides common event capabilities, including
```ts ```ts
import CommonEventManager from '@ohos.commonEventManager'; import CommonEventManager from '@ohos.commonEventManager';
import Base from '@ohos.base';
``` ```
## Support ## Support
...@@ -48,7 +49,7 @@ Publishes a common event and executes an asynchronous callback after the event i ...@@ -48,7 +49,7 @@ Publishes a common event and executes an asynchronous callback after the event i
```ts ```ts
// Callback for common event publication // Callback for common event publication
function publishCB(err) { function publishCB(err:Base.BusinessError) {
if (err) { if (err) {
console.error(`publish failed, code is ${err.code}, message is ${err.message}`); console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -95,14 +96,14 @@ Publishes a common event with given attributes. This API uses an asynchronous ca ...@@ -95,14 +96,14 @@ Publishes a common event with given attributes. This API uses an asynchronous ca
```ts ```ts
// Attributes of a common event. // Attributes of a common event.
let options = { let options:CommonEventManager.CommonEventPublishData = {
code: 0, // Result code of the common event. code: 0, // Result code of the common event.
data: "initial data",// Result data of the common event. data: "initial data",// Result data of the common event.
isOrdered: true // The common event is an ordered one. isOrdered: true // The common event is an ordered one.
} }
// Callback for common event publication // Callback for common event publication
function publishCB(err) { function publishCB(err:Base.BusinessError) {
if (err) { if (err) {
console.error(`publish failed, code is ${err.code}, message is ${err.message}`); console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -151,7 +152,7 @@ Publishes a common event to a specific user. This API uses an asynchronous callb ...@@ -151,7 +152,7 @@ Publishes a common event to a specific user. This API uses an asynchronous callb
```ts ```ts
// Callback for common event publication // Callback for common event publication
function publishCB(err) { function publishCB(err:Base.BusinessError) {
if (err) { if (err) {
console.error(`publishAsUser failed, code is ${err.code}, message is ${err.message}`); console.error(`publishAsUser failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -205,13 +206,13 @@ Publishes a common event with given attributes to a specific user. This API uses ...@@ -205,13 +206,13 @@ Publishes a common event with given attributes to a specific user. This API uses
```ts ```ts
// Attributes of a common event. // Attributes of a common event.
let options = { let options:CommonEventManager.CommonEventPublishData = {
code: 0, // Result code of the common event. code: 0, // Result code of the common event.
data: "initial data",// Result data of the common event. data: "initial data",// Result data of the common event.
} }
// Callback for common event publication. // Callback for common event publication.
function publishCB(err) { function publishCB(err:Base.BusinessError) {
if (err) { if (err) {
console.error(`publishAsUser failed, code is ${err.code}, message is ${err.message}`); console.error(`publishAsUser failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -248,15 +249,15 @@ Creates a subscriber. This API uses an asynchronous callback to return the resul ...@@ -248,15 +249,15 @@ Creates a subscriber. This API uses an asynchronous callback to return the resul
**Example** **Example**
```ts ```ts
let subscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription. let subscriber:CommonEventManager.CommonEventSubscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription.
// Subscriber information. // Subscriber information.
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
// Callback for subscriber creation. // Callback for subscriber creation.
function createCB(err, commonEventSubscriber) { function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) {
if(!err) { if(!err) {
console.info("createSubscriber"); console.info("createSubscriber");
subscriber = commonEventSubscriber; subscriber = commonEventSubscriber;
...@@ -295,18 +296,18 @@ Creates a subscriber. This API uses a promise to return the result. ...@@ -295,18 +296,18 @@ Creates a subscriber. This API uses a promise to return the result.
**Example** **Example**
```ts ```ts
let subscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription. let subscriber:CommonEventManager.CommonEventSubscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription.
// Subscriber information. // Subscriber information.
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
// Create a subscriber. // Create a subscriber.
CommonEventManager.createSubscriber(subscribeInfo).then((commonEventSubscriber) => { CommonEventManager.createSubscriber(subscribeInfo).then((commonEventSubscriber:CommonEventManager.CommonEventSubscriber) => {
console.info("createSubscriber"); console.info("createSubscriber");
subscriber = commonEventSubscriber; subscriber = commonEventSubscriber;
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`); console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`);
}); });
...@@ -341,15 +342,15 @@ Subscribes to common events. This API uses an asynchronous callback to return th ...@@ -341,15 +342,15 @@ Subscribes to common events. This API uses an asynchronous callback to return th
```ts ```ts
// Subscriber information. // Subscriber information.
let subscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription. let subscriber:CommonEventManager.CommonEventSubscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription.
// Subscriber information. // Subscriber information.
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
// Callback for common event subscription. // Callback for common event subscription.
function SubscribeCB(err, data) { function SubscribeCB(err:Base.BusinessError, data:CommonEventManager.CommonEventData) {
if (err) { if (err) {
console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`); console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -358,7 +359,7 @@ function SubscribeCB(err, data) { ...@@ -358,7 +359,7 @@ function SubscribeCB(err, data) {
} }
// Callback for subscriber creation. // Callback for subscriber creation.
function createCB(err, commonEventSubscriber) { function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) {
if(!err) { if(!err) {
console.info("createSubscriber"); console.info("createSubscriber");
subscriber = commonEventSubscriber; subscriber = commonEventSubscriber;
...@@ -409,13 +410,13 @@ Unsubscribes from common events. This API uses an asynchronous callback to retur ...@@ -409,13 +410,13 @@ Unsubscribes from common events. This API uses an asynchronous callback to retur
**Example** **Example**
```ts ```ts
let subscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription. let subscriber:CommonEventManager.CommonEventSubscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription.
// Subscriber information. // Subscriber information.
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
// Callback for common event subscription. // Callback for common event subscription.
function subscribeCB(err, data) { function subscribeCB(err:Base.BusinessError, data:CommonEventManager.CommonEventData) {
if (err) { if (err) {
console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`); console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -423,7 +424,7 @@ function subscribeCB(err, data) { ...@@ -423,7 +424,7 @@ function subscribeCB(err, data) {
} }
} }
// Callback for subscriber creation. // Callback for subscriber creation.
function createCB(err, commonEventSubscriber) { function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) {
if (err) { if (err) {
console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`); console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -438,7 +439,7 @@ function createCB(err, commonEventSubscriber) { ...@@ -438,7 +439,7 @@ function createCB(err, commonEventSubscriber) {
} }
} }
// Callback for common event unsubscription. // Callback for common event unsubscription.
function unsubscribeCB(err) { function unsubscribeCB(err:Base.BusinessError) {
if (err) { if (err) {
console.error(`unsubscribe failed, code is ${err.code}, message is ${err.message}`); console.error(`unsubscribe failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -493,7 +494,7 @@ Removes a sticky common event. This API uses an asynchronous callback to return ...@@ -493,7 +494,7 @@ Removes a sticky common event. This API uses an asynchronous callback to return
```ts ```ts
CommonEventManager.removeStickyCommonEvent("sticky_event", (err) => { CommonEventManager.removeStickyCommonEvent("sticky_event", (err:Base.BusinessError) => {
if (err) { if (err) {
console.info(`Remove sticky event AsyncCallback failed, errCode: ${err.code}, errMes: ${err.message}`); console.info(`Remove sticky event AsyncCallback failed, errCode: ${err.code}, errMes: ${err.message}`);
return; return;
...@@ -542,7 +543,7 @@ Removes a sticky common event. This API uses a promise to return the result. ...@@ -542,7 +543,7 @@ Removes a sticky common event. This API uses a promise to return the result.
```ts ```ts
CommonEventManager.removeStickyCommonEvent("sticky_event").then(() => { CommonEventManager.removeStickyCommonEvent("sticky_event").then(() => {
console.info(`Remove sticky event AsyncCallback success`); console.info(`Remove sticky event AsyncCallback success`);
}).catch ((err) => { }).catch ((err:Base.BusinessError) => {
console.info(`Remove sticky event AsyncCallback failed, errCode: ${err.code}, errMes: ${err.message}`); console.info(`Remove sticky event AsyncCallback failed, errCode: ${err.code}, errMes: ${err.message}`);
}); });
``` ```
...@@ -577,7 +578,7 @@ Enables or disables static subscription for the current application. This API us ...@@ -577,7 +578,7 @@ Enables or disables static subscription for the current application. This API us
```ts ```ts
CommonEventManager.setStaticSubscriberState(true, (err) => { CommonEventManager.setStaticSubscriberState(true, (err:Base.BusinessError) => {
if (!err) { if (!err) {
console.info(`Set static subscriber state callback failed, err is null.`); console.info(`Set static subscriber state callback failed, err is null.`);
return; return;
...@@ -627,7 +628,7 @@ Enables or disables static subscription for the current application. This API us ...@@ -627,7 +628,7 @@ Enables or disables static subscription for the current application. This API us
```ts ```ts
CommonEventManager.setStaticSubscriberState(false).then(() => { CommonEventManager.setStaticSubscriberState(false).then(() => {
console.info(`Set static subscriber state promise success`); console.info(`Set static subscriber state promise success`);
}).catch ((err) => { }).catch ((err:Base.BusinessError) => {
console.info(`Set static subscriber state promise failed, errCode: ${err.code}, errMes: ${err.message}`); console.info(`Set static subscriber state promise failed, errCode: ${err.code}, errMes: ${err.message}`);
}); });
``` ```
en/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscriber.md
浏览文件 @ 467386e6
...@@ -10,15 +10,17 @@ Before using the **CommonEventSubscriber** module, you must obtain a **subscribe ...@@ -10,15 +10,17 @@ Before using the **CommonEventSubscriber** module, you must obtain a **subscribe
```ts ```ts
import CommonEvent from '@ohos.commonEvent'; import CommonEvent from '@ohos.commonEvent';
let subscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription. import CommonEventManager from '@ohos.commonEventManager';
import Base from '@ohos.base';
let subscriber:CommonEventManager.CommonEventSubscriber; // Used to save the created subscriber object for subsequent subscription and unsubscription.
// Subscriber information. // Subscriber information.
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
// Callback for subscriber creation. // Callback for subscriber creation.
function createCB(err, commonEventSubscriber) { function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) {
if (err.code) { if (err.code) {
console.error(`createSubscriber failed, code is ${err.code}`); console.error(`createSubscriber failed, code is ${err.code}`);
} else { } else {
...@@ -49,7 +51,7 @@ Obtains the code of this common event. This API uses an asynchronous callback to ...@@ -49,7 +51,7 @@ Obtains the code of this common event. This API uses an asynchronous callback to
```ts ```ts
// Callback for result code obtaining of an ordered common event. // Callback for result code obtaining of an ordered common event.
function getCodeCB(err, code) { function getCodeCB(err:Base.BusinessError, code:number) {
if (err.code) { if (err.code) {
console.error(`getCode failed, code is ${err.code}, message is ${err.message}`); console.error(`getCode failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -76,9 +78,9 @@ Obtains the code of this common event. This API uses a promise to return the res ...@@ -76,9 +78,9 @@ Obtains the code of this common event. This API uses a promise to return the res
**Example** **Example**
```ts ```ts
subscriber.getCode().then((code) => { subscriber.getCode().then((code:number) => {
console.info("getCode " + JSON.stringify(code)); console.info("getCode " + JSON.stringify(code));
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`getCode failed, code is ${err.code}, message is ${err.message}`); console.error(`getCode failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -102,7 +104,7 @@ Sets the code for this common event. This API uses an asynchronous callback to r ...@@ -102,7 +104,7 @@ Sets the code for this common event. This API uses an asynchronous callback to r
```ts ```ts
// Callback for result code setting of an ordered common event. // Callback for result code setting of an ordered common event.
function setCodeCB(err) { function setCodeCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); console.error(`setCode failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -137,7 +139,7 @@ Sets the code for this common event. This API uses a promise to return the resul ...@@ -137,7 +139,7 @@ Sets the code for this common event. This API uses a promise to return the resul
```ts ```ts
subscriber.setCode(1).then(() => { subscriber.setCode(1).then(() => {
console.info("setCode"); console.info("setCode");
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); console.error(`setCode failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -160,7 +162,7 @@ Obtains the data of this common event. This API uses an asynchronous callback to ...@@ -160,7 +162,7 @@ Obtains the data of this common event. This API uses an asynchronous callback to
```ts ```ts
// Callback for result data obtaining of an ordered common event. // Callback for result data obtaining of an ordered common event.
function getDataCB(err, data) { function getDataCB(err:Base.BusinessError, data:string) {
if (err.code) { if (err.code) {
console.error(`getData failed, code is ${err.code}, message is ${err.message}`); console.error(`getData failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -187,9 +189,9 @@ Obtains the data of this common event. This API uses a promise to return the res ...@@ -187,9 +189,9 @@ Obtains the data of this common event. This API uses a promise to return the res
**Example** **Example**
```ts ```ts
subscriber.getData().then((data) => { subscriber.getData().then((data:string) => {
console.info("getData " + JSON.stringify(data)); console.info("getData " + JSON.stringify(data));
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`getData failed, code is ${err.code}, message is ${err.message}`); console.error(`getData failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -213,7 +215,7 @@ Sets the data for this common event. This API uses an asynchronous callback to r ...@@ -213,7 +215,7 @@ Sets the data for this common event. This API uses an asynchronous callback to r
```ts ```ts
// Callback for result data setting of an ordered common event // Callback for result data setting of an ordered common event
function setDataCB(err) { function setDataCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); console.error(`setCode failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -248,7 +250,7 @@ Sets the data for this common event. This API uses a promise to return the resul ...@@ -248,7 +250,7 @@ Sets the data for this common event. This API uses a promise to return the resul
```ts ```ts
subscriber.setData("publish_data_changed").then(() => { subscriber.setData("publish_data_changed").then(() => {
console.info("setData"); console.info("setData");
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); console.error(`setCode failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -273,7 +275,7 @@ Sets the code and data for this common event. This API uses an asynchronous call ...@@ -273,7 +275,7 @@ Sets the code and data for this common event. This API uses an asynchronous call
```ts ```ts
// Callback for code and data setting of an ordered common event. // Callback for code and data setting of an ordered common event.
function setCodeDataCB(err) { function setCodeDataCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`); console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -309,7 +311,7 @@ Sets the code and data for this common event. This API uses a promise to return ...@@ -309,7 +311,7 @@ Sets the code and data for this common event. This API uses a promise to return
```ts ```ts
subscriber.setCodeAndData(1, "publish_data_changed").then(() => { subscriber.setCodeAndData(1, "publish_data_changed").then(() => {
console.info("setCodeAndData"); console.info("setCodeAndData");
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`); console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -332,7 +334,7 @@ Checks whether this common event is an ordered one. This API uses an asynchronou ...@@ -332,7 +334,7 @@ Checks whether this common event is an ordered one. This API uses an asynchronou
```ts ```ts
// Callback for checking whether the current common event is an ordered one. // Callback for checking whether the current common event is an ordered one.
function isOrderedCB(err, isOrdered) { function isOrderedCB(err:Base.BusinessError, isOrdered:boolean) {
if (err.code) { if (err.code) {
console.error(`isOrderedCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`isOrderedCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -359,9 +361,9 @@ Checks whether this common event is an ordered one. This API uses a promise to r ...@@ -359,9 +361,9 @@ Checks whether this common event is an ordered one. This API uses a promise to r
**Example** **Example**
```ts ```ts
subscriber.isOrderedCommonEvent().then((isOrdered) => { subscriber.isOrderedCommonEvent().then((isOrdered:boolean) => {
console.info("isOrdered " + JSON.stringify(isOrdered)); console.info("isOrdered " + JSON.stringify(isOrdered));
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`isOrdered failed, code is ${err.code}, message is ${err.message}`); console.error(`isOrdered failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -384,7 +386,7 @@ Checks whether this common event is a sticky one. This API uses an asynchronous ...@@ -384,7 +386,7 @@ Checks whether this common event is a sticky one. This API uses an asynchronous
```ts ```ts
// Callback for checking whether the current common event is a sticky one. // Callback for checking whether the current common event is a sticky one.
function isStickyCB(err, isSticky) { function isStickyCB(err:Base.BusinessError, isSticky:boolean) {
if (err.code) { if (err.code) {
console.error(`isStickyCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`isStickyCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -411,9 +413,9 @@ Checks whether this common event is a sticky one. This API uses a promise to ret ...@@ -411,9 +413,9 @@ Checks whether this common event is a sticky one. This API uses a promise to ret
**Example** **Example**
```ts ```ts
subscriber.isStickyCommonEvent().then((isSticky) => { subscriber.isStickyCommonEvent().then((isSticky:boolean) => {
console.info("isSticky " + JSON.stringify(isSticky)); console.info("isSticky " + JSON.stringify(isSticky));
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`isSticky failed, code is ${err.code}, message is ${err.message}`); console.error(`isSticky failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -436,7 +438,7 @@ Aborts this common event. After the abort, the common event is not sent to the n ...@@ -436,7 +438,7 @@ Aborts this common event. After the abort, the common event is not sent to the n
```ts ```ts
// Callback for common event aborting. // Callback for common event aborting.
function abortCB(err) { function abortCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -465,7 +467,7 @@ Aborts this common event. After the abort, the common event is not sent to the n ...@@ -465,7 +467,7 @@ Aborts this common event. After the abort, the common event is not sent to the n
```ts ```ts
subscriber.abortCommonEvent().then(() => { subscriber.abortCommonEvent().then(() => {
console.info("abortCommonEvent"); console.info("abortCommonEvent");
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -488,7 +490,7 @@ Clears the aborted state of this common event. This API takes effect only for or ...@@ -488,7 +490,7 @@ Clears the aborted state of this common event. This API takes effect only for or
```ts ```ts
// Callback for clearing the aborted state of the current common event. // Callback for clearing the aborted state of the current common event.
function clearAbortCB(err) { function clearAbortCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -517,7 +519,7 @@ Clears the aborted state of this common event. This API takes effect only for or ...@@ -517,7 +519,7 @@ Clears the aborted state of this common event. This API takes effect only for or
```ts ```ts
subscriber.clearAbortCommonEvent().then(() => { subscriber.clearAbortCommonEvent().then(() => {
console.info("clearAbortCommonEvent"); console.info("clearAbortCommonEvent");
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -540,7 +542,7 @@ Checks whether this common event is in the aborted state. This API takes effect ...@@ -540,7 +542,7 @@ Checks whether this common event is in the aborted state. This API takes effect
```ts ```ts
// Callback for checking whether the current common event is in the aborted state. // Callback for checking whether the current common event is in the aborted state.
function getAbortCB(err, abortEvent) { function getAbortCB(err:Base.BusinessError, abortEvent:boolean) {
if (err.code) { if (err.code) {
console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -567,9 +569,9 @@ Checks whether this common event is in the aborted state. This API takes effect ...@@ -567,9 +569,9 @@ Checks whether this common event is in the aborted state. This API takes effect
**Example** **Example**
```ts ```ts
subscriber.getAbortCommonEvent().then((abortEvent) => { subscriber.getAbortCommonEvent().then((abortEvent:boolean) => {
console.info("abortCommonEvent " + JSON.stringify(abortEvent)); console.info("abortCommonEvent " + JSON.stringify(abortEvent));
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -592,7 +594,7 @@ Obtains the subscriber information. This API uses an asynchronous callback to re ...@@ -592,7 +594,7 @@ Obtains the subscriber information. This API uses an asynchronous callback to re
```ts ```ts
// Callback for subscriber information obtaining. // Callback for subscriber information obtaining.
function getCB(err, subscribeInfo) { function getCB(err:Base.BusinessError, subscribeInfo:CommonEventManager.CommonEventSubscribeInfo) {
if (err.code) { if (err.code) {
console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`); console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -619,9 +621,9 @@ Obtains the subscriber information. This API uses a promise to return the result ...@@ -619,9 +621,9 @@ Obtains the subscriber information. This API uses a promise to return the result
**Example** **Example**
```ts ```ts
subscriber.getSubscribeInfo().then((subscribeInfo) => { subscriber.getSubscribeInfo().then((subscribeInfo:CommonEventManager.CommonEventSubscribeInfo) => {
console.info("subscribeInfo " + JSON.stringify(subscribeInfo)); console.info("subscribeInfo " + JSON.stringify(subscribeInfo));
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`); console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -644,7 +646,7 @@ Finishes this common event. This API takes effect only for ordered common events ...@@ -644,7 +646,7 @@ Finishes this common event. This API takes effect only for ordered common events
```ts ```ts
// Callback for ordered common event finishing. // Callback for ordered common event finishing.
function finishCB(err) { function finishCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -674,7 +676,7 @@ Finishes this common event. This API takes effect only for ordered common events ...@@ -674,7 +676,7 @@ Finishes this common event. This API takes effect only for ordered common events
```ts ```ts
subscriber.finishCommonEvent().then(() => { subscriber.finishCommonEvent().then(() => {
console.info("FinishCommonEvent"); console.info("FinishCommonEvent");
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
zh-cn/application-dev/reference/apis/js-apis-commonEvent.md
浏览文件 @ 467386e6
...@@ -11,6 +11,8 @@ ...@@ -11,6 +11,8 @@
```ts ```ts
import CommonEvent from '@ohos.commonEvent'; import CommonEvent from '@ohos.commonEvent';
import CommonEventManager from '@ohos.commonEventManager';
import Base from '@ohos.base';
``` ```
## Support ## Support
...@@ -41,7 +43,7 @@ publish(event: string, callback: AsyncCallback\<void>): void ...@@ -41,7 +43,7 @@ publish(event: string, callback: AsyncCallback\<void>): void
```ts ```ts
//发布公共事件回调 //发布公共事件回调
function publishCB(err) { function publishCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`publish failed, code is ${err.code}`); console.error(`publish failed, code is ${err.code}`);
} else { } else {
...@@ -77,14 +79,14 @@ publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\ ...@@ -77,14 +79,14 @@ publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\
```ts ```ts
//公共事件相关信息 //公共事件相关信息
let options = { let options:CommonEventManager.CommonEventPublishData = {
code: 0, //公共事件的初始代码 code: 0, //公共事件的初始代码
data: "initial data",//公共事件的初始数据 data: "initial data",//公共事件的初始数据
isOrdered: true //有序公共事件 isOrdered: true //有序公共事件
} }
//发布公共事件回调 //发布公共事件回调
function publishCB(err) { function publishCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`publish failed, code is ${err.code}`); console.error(`publish failed, code is ${err.code}`);
} else { } else {
...@@ -121,7 +123,7 @@ publishAsUser(event: string, userId: number, callback: AsyncCallback\<void>): vo ...@@ -121,7 +123,7 @@ publishAsUser(event: string, userId: number, callback: AsyncCallback\<void>): vo
```ts ```ts
// 发布公共事件回调 // 发布公共事件回调
function publishCB(err) { function publishCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`publishAsUser failed, code is ${err.code}`); console.error(`publishAsUser failed, code is ${err.code}`);
} else { } else {
...@@ -163,13 +165,13 @@ publishAsUser(event: string, userId: number, options: CommonEventPublishData, ca ...@@ -163,13 +165,13 @@ publishAsUser(event: string, userId: number, options: CommonEventPublishData, ca
```ts ```ts
// 公共事件相关信息 // 公共事件相关信息
let options = { let options:CommonEventManager.CommonEventPublishData = {
code: 0, // 公共事件的初始代码 code: 0, // 公共事件的初始代码
data: "initial data",// 公共事件的初始数据 data: "initial data",// 公共事件的初始数据
} }
// 发布公共事件回调 // 发布公共事件回调
function publishCB(err) { function publishCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`publishAsUser failed, code is ${err.code}`); console.error(`publishAsUser failed, code is ${err.code}`);
} else { } else {
...@@ -206,15 +208,15 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallbac ...@@ -206,15 +208,15 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallbac
```ts ```ts
let subscriber; // 用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 let subscriber:CommonEventManager.CommonEventSubscriber; // 用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
// 订阅者信息 // 订阅者信息
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
// 创建订阅者回调 // 创建订阅者回调
function createCB(err, commonEventSubscriber) { function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) {
if (err.code) { if (err.code) {
console.error(`createSubscriber failed, code is ${err.code}`); console.error(`createSubscriber failed, code is ${err.code}`);
} else { } else {
...@@ -252,18 +254,18 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\<CommonEventS ...@@ -252,18 +254,18 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\<CommonEventS
**示例：** **示例：**
```ts ```ts
let subscriber; // 用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 let subscriber:CommonEventManager.CommonEventSubscriber; // 用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
// 订阅者信息 // 订阅者信息
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
// 创建订阅者 // 创建订阅者
CommonEvent.createSubscriber(subscribeInfo).then((commonEventSubscriber) => { CommonEvent.createSubscriber(subscribeInfo).then((commonEventSubscriber:CommonEventManager.CommonEventSubscriber) => {
console.info("createSubscriber"); console.info("createSubscriber");
subscriber = commonEventSubscriber; subscriber = commonEventSubscriber;
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`createSubscriber failed, code is ${err.code}`); console.error(`createSubscriber failed, code is ${err.code}`);
}); });
``` ```
...@@ -289,15 +291,15 @@ subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEven ...@@ -289,15 +291,15 @@ subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEven
**示例：** **示例：**
```ts ```ts
let subscriber; // 用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 let subscriber:CommonEventManager.CommonEventSubscriber;// 用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
// 订阅者信息 // 订阅者信息
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
// 订阅公共事件回调 // 订阅公共事件回调
function subscribeCB(err, data) { function subscribeCB(err:Base.BusinessError, data:CommonEventManager.CommonEventData) {
if (err.code) { if (err.code) {
console.error(`subscribe failed, code is ${err.code}`); console.error(`subscribe failed, code is ${err.code}`);
} else { } else {
...@@ -306,13 +308,13 @@ function subscribeCB(err, data) { ...@@ -306,13 +308,13 @@ function subscribeCB(err, data) {
} }
// 创建订阅者回调 // 创建订阅者回调
function createCB(err, commonEventSubscriber) { function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) {
if (err.code) { if (err.code) {
console.error(`createSubscriber failed, code is ${err.code}`); console.error(`createSubscriber failed, code is ${err.code}`);
} else { } else {
console.info("createSubscriber"); console.info("createSubscriber");
subscriber = commonEventSubscriber; subscriber = commonEventSubscriber;
// 订阅公共事件 // Subscribe to a common event.
CommonEvent.subscribe(subscriber, subscribeCB); CommonEvent.subscribe(subscriber, subscribeCB);
} }
} }
...@@ -342,15 +344,15 @@ unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>): ...@@ -342,15 +344,15 @@ unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>):
**示例：** **示例：**
```ts ```ts
let subscriber; // 用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 let subscriber:CommonEventManager.CommonEventSubscriber; // 用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
// 订阅者信息 // 订阅者信息
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
// 订阅公共事件回调 // 订阅公共事件回调
function subscribeCB(err, data) { function subscribeCB(err:Base.BusinessError, data:CommonEventManager.CommonEventData) {
if (err.code) { if (err.code) {
console.error(`subscribe failed, code is ${err.code}`); console.error(`subscribe failed, code is ${err.code}`);
} else { } else {
...@@ -359,19 +361,19 @@ function subscribeCB(err, data) { ...@@ -359,19 +361,19 @@ function subscribeCB(err, data) {
} }
// 创建订阅者回调 // 创建订阅者回调
function createCB(err, commonEventSubscriber) { function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) {
if (err.code) { if (err.code) {
console.error(`createSubscriber failed, code is ${err.code}`); console.error(`createSubscriber failed, code is ${err.code}`);
} else { } else {
console.info("createSubscriber"); console.info("createSubscriber");
subscriber = commonEventSubscriber; subscriber = commonEventSubscriber;
// 订阅公共事件 // Subscribe to a common event.
CommonEvent.subscribe(subscriber, subscribeCB); CommonEvent.subscribe(subscriber, subscribeCB);
} }
} }
// 取消订阅公共事件回调 // 取消订阅公共事件回调
function unsubscribeCB(err) { function unsubscribeCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`unsubscribe failed, code is ${err.code}`); console.error(`unsubscribe failed, code is ${err.code}`);
} else { } else {
......
zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md
浏览文件 @ 467386e6
...@@ -10,6 +10,7 @@ ...@@ -10,6 +10,7 @@
```ts ```ts
import CommonEventManager from '@ohos.commonEventManager'; import CommonEventManager from '@ohos.commonEventManager';
import Base from '@ohos.base';
``` ```
## Support ## Support
...@@ -48,7 +49,7 @@ publish(event: string, callback: AsyncCallback\<void>): void ...@@ -48,7 +49,7 @@ publish(event: string, callback: AsyncCallback\<void>): void
```ts ```ts
//发布公共事件回调 //发布公共事件回调
function publishCB(err) { function publishCB(err:Base.BusinessError) {
if (err) { if (err) {
console.error(`publish failed, code is ${err.code}, message is ${err.message}`); console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -95,14 +96,14 @@ publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\ ...@@ -95,14 +96,14 @@ publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\
```ts ```ts
//公共事件相关信息 //公共事件相关信息
let options = { let options:CommonEventManager.CommonEventPublishData = {
code: 0, //公共事件的初始代码 code: 0, //公共事件的初始代码
data: "initial data",//公共事件的初始数据 data: "initial data",//公共事件的初始数据
isOrdered: true //有序公共事件 isOrdered: true //有序公共事件
} }
//发布公共事件回调 //发布公共事件回调
function publishCB(err) { function publishCB(err:Base.BusinessError) {
if (err) { if (err) {
console.error(`publish failed, code is ${err.code}, message is ${err.message}`); console.error(`publish failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -151,7 +152,7 @@ publishAsUser(event: string, userId: number, callback: AsyncCallback\<void>): vo ...@@ -151,7 +152,7 @@ publishAsUser(event: string, userId: number, callback: AsyncCallback\<void>): vo
```ts ```ts
//发布公共事件回调 //发布公共事件回调
function publishCB(err) { function publishCB(err:Base.BusinessError) {
if (err) { if (err) {
console.error(`publishAsUser failed, code is ${err.code}, message is ${err.message}`); console.error(`publishAsUser failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -205,13 +206,13 @@ publishAsUser(event: string, userId: number, options: CommonEventPublishData, ca ...@@ -205,13 +206,13 @@ publishAsUser(event: string, userId: number, options: CommonEventPublishData, ca
```ts ```ts
//公共事件相关信息 //公共事件相关信息
let options = { let options:CommonEventManager.CommonEventPublishData = {
code: 0, //公共事件的初始代码 code: 0, //公共事件的初始代码
data: "initial data",//公共事件的初始数据 data: "initial data",//公共事件的初始数据
} }
//发布公共事件回调 //发布公共事件回调
function publishCB(err) { function publishCB(err:Base.BusinessError) {
if (err) { if (err) {
console.error(`publishAsUser failed, code is ${err.code}, message is ${err.message}`); console.error(`publishAsUser failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -248,15 +249,15 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallbac ...@@ -248,15 +249,15 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallbac
**示例：** **示例：**
```ts ```ts
let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 let subscriber:CommonEventManager.CommonEventSubscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//订阅者信息 //订阅者信息
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
//创建订阅者回调 //创建订阅者回调
function createCB(err, commonEventSubscriber) { function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) {
if(!err) { if(!err) {
console.info("createSubscriber"); console.info("createSubscriber");
subscriber = commonEventSubscriber; subscriber = commonEventSubscriber;
...@@ -295,18 +296,18 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\<CommonEventS ...@@ -295,18 +296,18 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\<CommonEventS
**示例：** **示例：**
```ts ```ts
let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 let subscriber:CommonEventManager.CommonEventSubscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//订阅者信息 //订阅者信息
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
//创建订阅者 //创建订阅者
CommonEventManager.createSubscriber(subscribeInfo).then((commonEventSubscriber) => { CommonEventManager.createSubscriber(subscribeInfo).then((commonEventSubscriber:CommonEventManager.CommonEventSubscriber) => {
console.info("createSubscriber"); console.info("createSubscriber");
subscriber = commonEventSubscriber; subscriber = commonEventSubscriber;
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`); console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`);
}); });
...@@ -341,15 +342,15 @@ subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEven ...@@ -341,15 +342,15 @@ subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEven
```ts ```ts
//订阅者信息 //订阅者信息
let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 let subscriber:CommonEventManager.CommonEventSubscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//订阅者信息 //订阅者信息
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
//订阅公共事件回调 //订阅公共事件回调
function SubscribeCB(err, data) { function SubscribeCB(err:Base.BusinessError, data:CommonEventManager.CommonEventData) {
if (err) { if (err) {
console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`); console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -358,7 +359,7 @@ function SubscribeCB(err, data) { ...@@ -358,7 +359,7 @@ function SubscribeCB(err, data) {
} }
//创建订阅者回调 //创建订阅者回调
function createCB(err, commonEventSubscriber) { function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) {
if(!err) { if(!err) {
console.info("createSubscriber"); console.info("createSubscriber");
subscriber = commonEventSubscriber; subscriber = commonEventSubscriber;
...@@ -409,13 +410,13 @@ unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>): ...@@ -409,13 +410,13 @@ unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>):
**示例：** **示例：**
```ts ```ts
let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 let subscriber:CommonEventManager.CommonEventSubscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//订阅者信息 //订阅者信息
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
//订阅公共事件回调 //订阅公共事件回调
function subscribeCB(err, data) { function subscribeCB(err:Base.BusinessError, data:CommonEventManager.CommonEventData) {
if (err) { if (err) {
console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`); console.error(`subscribe failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -423,7 +424,7 @@ function subscribeCB(err, data) { ...@@ -423,7 +424,7 @@ function subscribeCB(err, data) {
} }
} }
//创建订阅者回调 //创建订阅者回调
function createCB(err, commonEventSubscriber) { function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) {
if (err) { if (err) {
console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`); console.error(`createSubscriber failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -438,7 +439,7 @@ function createCB(err, commonEventSubscriber) { ...@@ -438,7 +439,7 @@ function createCB(err, commonEventSubscriber) {
} }
} }
//取消订阅公共事件回调 //取消订阅公共事件回调
function unsubscribeCB(err) { function unsubscribeCB(err:Base.BusinessError) {
if (err) { if (err) {
console.error(`unsubscribe failed, code is ${err.code}, message is ${err.message}`); console.error(`unsubscribe failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -493,7 +494,7 @@ removeStickyCommonEvent(event: string, callback: AsyncCallback\<void>): void ...@@ -493,7 +494,7 @@ removeStickyCommonEvent(event: string, callback: AsyncCallback\<void>): void
```ts ```ts
CommonEventManager.removeStickyCommonEvent("sticky_event", (err) => { CommonEventManager.removeStickyCommonEvent("sticky_event", (err:Base.BusinessError) => {
if (err) { if (err) {
console.info(`Remove sticky event AsyncCallback failed, errCode: ${err.code}, errMes: ${err.message}`); console.info(`Remove sticky event AsyncCallback failed, errCode: ${err.code}, errMes: ${err.message}`);
return; return;
...@@ -542,7 +543,7 @@ removeStickyCommonEvent(event: string): Promise\<void> ...@@ -542,7 +543,7 @@ removeStickyCommonEvent(event: string): Promise\<void>
```ts ```ts
CommonEventManager.removeStickyCommonEvent("sticky_event").then(() => { CommonEventManager.removeStickyCommonEvent("sticky_event").then(() => {
console.info(`Remove sticky event AsyncCallback success`); console.info(`Remove sticky event AsyncCallback success`);
}).catch ((err) => { }).catch ((err:Base.BusinessError) => {
console.info(`Remove sticky event AsyncCallback failed, errCode: ${err.code}, errMes: ${err.message}`); console.info(`Remove sticky event AsyncCallback failed, errCode: ${err.code}, errMes: ${err.message}`);
}); });
``` ```
...@@ -577,7 +578,7 @@ setStaticSubscriberState(enable: boolean, callback: AsyncCallback\<void>): void; ...@@ -577,7 +578,7 @@ setStaticSubscriberState(enable: boolean, callback: AsyncCallback\<void>): void;
```ts ```ts
CommonEventManager.setStaticSubscriberState(true, (err) => { CommonEventManager.setStaticSubscriberState(true, (err:Base.BusinessError) => {
if (!err) { if (!err) {
console.info(`Set static subscriber state callback failed, err is null.`); console.info(`Set static subscriber state callback failed, err is null.`);
return; return;
...@@ -627,7 +628,7 @@ setStaticSubscriberState(enable: boolean): Promise\<void>; ...@@ -627,7 +628,7 @@ setStaticSubscriberState(enable: boolean): Promise\<void>;
```ts ```ts
CommonEventManager.setStaticSubscriberState(false).then(() => { CommonEventManager.setStaticSubscriberState(false).then(() => {
console.info(`Set static subscriber state promise success`); console.info(`Set static subscriber state promise success`);
}).catch ((err) => { }).catch ((err:Base.BusinessError) => {
console.info(`Set static subscriber state promise failed, errCode: ${err.code}, errMes: ${err.message}`); console.info(`Set static subscriber state promise failed, errCode: ${err.code}, errMes: ${err.message}`);
}); });
``` ```
zh-cn/application-dev/reference/apis/js-apis-inner-commonEvent-commonEventSubscriber.md
浏览文件 @ 467386e6
...@@ -10,15 +10,17 @@ ...@@ -10,15 +10,17 @@
```ts ```ts
import CommonEvent from '@ohos.commonEvent'; import CommonEvent from '@ohos.commonEvent';
let subscriber; // 用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作 import CommonEventManager from '@ohos.commonEventManager';
import Base from '@ohos.base';
let subscriber:CommonEventManager.CommonEventSubscriber; // 用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
// 订阅者信息 // 订阅者信息
let subscribeInfo = { let subscribeInfo:CommonEventManager.CommonEventSubscribeInfo = {
events: ["event"] events: ["event"]
}; };
// 创建订阅者回调 // 创建订阅者回调
function createCB(err, commonEventSubscriber) { function createCB(err:Base.BusinessError, commonEventSubscriber:CommonEventManager.CommonEventSubscriber) {
if (err.code) { if (err.code) {
console.error(`createSubscriber failed, code is ${err.code}`); console.error(`createSubscriber failed, code is ${err.code}`);
} else { } else {
...@@ -49,7 +51,7 @@ getCode(callback: AsyncCallback\<number>): void ...@@ -49,7 +51,7 @@ getCode(callback: AsyncCallback\<number>): void
```ts ```ts
//获取有序公共事件代码回调 //获取有序公共事件代码回调
function getCodeCB(err, code) { function getCodeCB(err:Base.BusinessError, code:number) {
if (err.code) { if (err.code) {
console.error(`getCode failed, code is ${err.code}, message is ${err.message}`); console.error(`getCode failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -76,9 +78,9 @@ getCode(): Promise\<number> ...@@ -76,9 +78,9 @@ getCode(): Promise\<number>
**示例：** **示例：**
```ts ```ts
subscriber.getCode().then((code) => { subscriber.getCode().then((code:number) => {
console.info("getCode " + JSON.stringify(code)); console.info("getCode " + JSON.stringify(code));
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`getCode failed, code is ${err.code}, message is ${err.message}`); console.error(`getCode failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -102,7 +104,7 @@ setCode(code: number, callback: AsyncCallback\<void>): void ...@@ -102,7 +104,7 @@ setCode(code: number, callback: AsyncCallback\<void>): void
```ts ```ts
//设置有序公共事件的代码回调 //设置有序公共事件的代码回调
function setCodeCB(err) { function setCodeCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); console.error(`setCode failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -137,7 +139,7 @@ setCode(code: number): Promise\<void> ...@@ -137,7 +139,7 @@ setCode(code: number): Promise\<void>
```ts ```ts
subscriber.setCode(1).then(() => { subscriber.setCode(1).then(() => {
console.info("setCode"); console.info("setCode");
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); console.error(`setCode failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -160,7 +162,7 @@ getData(callback: AsyncCallback\<string>): void ...@@ -160,7 +162,7 @@ getData(callback: AsyncCallback\<string>): void
```ts ```ts
//获取有序公共事件代码数据回调 //获取有序公共事件代码数据回调
function getDataCB(err, data) { function getDataCB(err:Base.BusinessError, data:string) {
if (err.code) { if (err.code) {
console.error(`getData failed, code is ${err.code}, message is ${err.message}`); console.error(`getData failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -187,9 +189,9 @@ getData(): Promise\<string> ...@@ -187,9 +189,9 @@ getData(): Promise\<string>
**示例：** **示例：**
```ts ```ts
subscriber.getData().then((data) => { subscriber.getData().then((data:string) => {
console.info("getData " + JSON.stringify(data)); console.info("getData " + JSON.stringify(data));
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`getData failed, code is ${err.code}, message is ${err.message}`); console.error(`getData failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -213,7 +215,7 @@ setData(data: string, callback: AsyncCallback\<void>): void ...@@ -213,7 +215,7 @@ setData(data: string, callback: AsyncCallback\<void>): void
```ts ```ts
//设置有序公共事件的结果数据回调 //设置有序公共事件的结果数据回调
function setDataCB(err) { function setDataCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); console.error(`setCode failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -248,7 +250,7 @@ setData(data: string): Promise\<void> ...@@ -248,7 +250,7 @@ setData(data: string): Promise\<void>
```ts ```ts
subscriber.setData("publish_data_changed").then(() => { subscriber.setData("publish_data_changed").then(() => {
console.info("setData"); console.info("setData");
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`setCode failed, code is ${err.code}, message is ${err.message}`); console.error(`setCode failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -273,7 +275,7 @@ setCodeAndData(code: number, data: string, callback:AsyncCallback\<void>): void ...@@ -273,7 +275,7 @@ setCodeAndData(code: number, data: string, callback:AsyncCallback\<void>): void
```ts ```ts
//设置有序公共事件的代码和数据回调 //设置有序公共事件的代码和数据回调
function setCodeDataCB(err) { function setCodeDataCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`); console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -309,7 +311,7 @@ setCodeAndData(code: number, data: string): Promise\<void> ...@@ -309,7 +311,7 @@ setCodeAndData(code: number, data: string): Promise\<void>
```ts ```ts
subscriber.setCodeAndData(1, "publish_data_changed").then(() => { subscriber.setCodeAndData(1, "publish_data_changed").then(() => {
console.info("setCodeAndData"); console.info("setCodeAndData");
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`); console.error(`setCodeAndData failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -334,7 +336,7 @@ isOrderedCommonEvent(callback: AsyncCallback\<boolean>): void ...@@ -334,7 +336,7 @@ isOrderedCommonEvent(callback: AsyncCallback\<boolean>): void
```ts ```ts
//获取当前公共事件是否为有序事件的回调 //获取当前公共事件是否为有序事件的回调
function isOrderedCB(err, isOrdered) { function isOrderedCB(err:Base.BusinessError, isOrdered:boolean) {
if (err.code) { if (err.code) {
console.error(`isOrderedCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`isOrderedCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -363,9 +365,9 @@ isOrderedCommonEvent(): Promise\<boolean> ...@@ -363,9 +365,9 @@ isOrderedCommonEvent(): Promise\<boolean>
**示例：** **示例：**
```ts ```ts
subscriber.isOrderedCommonEvent().then((isOrdered) => { subscriber.isOrderedCommonEvent().then((isOrdered:boolean) => {
console.info("isOrdered " + JSON.stringify(isOrdered)); console.info("isOrdered " + JSON.stringify(isOrdered));
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`isOrdered failed, code is ${err.code}, message is ${err.message}`); console.error(`isOrdered failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -390,7 +392,7 @@ isStickyCommonEvent(callback: AsyncCallback\<boolean>): void ...@@ -390,7 +392,7 @@ isStickyCommonEvent(callback: AsyncCallback\<boolean>): void
```ts ```ts
//获取当前公共事件是否为粘性事件的回调 //获取当前公共事件是否为粘性事件的回调
function isStickyCB(err, isSticky) { function isStickyCB(err:Base.BusinessError, isSticky:boolean) {
if (err.code) { if (err.code) {
console.error(`isStickyCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`isStickyCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -419,9 +421,9 @@ isStickyCommonEvent(): Promise\<boolean> ...@@ -419,9 +421,9 @@ isStickyCommonEvent(): Promise\<boolean>
**示例：** **示例：**
```ts ```ts
subscriber.isStickyCommonEvent().then((isSticky) => { subscriber.isStickyCommonEvent().then((isSticky:boolean) => {
console.info("isSticky " + JSON.stringify(isSticky)); console.info("isSticky " + JSON.stringify(isSticky));
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`isSticky failed, code is ${err.code}, message is ${err.message}`); console.error(`isSticky failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -444,7 +446,7 @@ abortCommonEvent(callback: AsyncCallback\<void>): void ...@@ -444,7 +446,7 @@ abortCommonEvent(callback: AsyncCallback\<void>): void
```ts ```ts
//取消当前有序公共事件的回调 //取消当前有序公共事件的回调
function abortCB(err) { function abortCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -473,7 +475,7 @@ abortCommonEvent(): Promise\<void> ...@@ -473,7 +475,7 @@ abortCommonEvent(): Promise\<void>
```ts ```ts
subscriber.abortCommonEvent().then(() => { subscriber.abortCommonEvent().then(() => {
console.info("abortCommonEvent"); console.info("abortCommonEvent");
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`abortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -496,7 +498,7 @@ clearAbortCommonEvent(callback: AsyncCallback\<void>): void ...@@ -496,7 +498,7 @@ clearAbortCommonEvent(callback: AsyncCallback\<void>): void
```ts ```ts
//清除当前公共事件取消状态的回调 //清除当前公共事件取消状态的回调
function clearAbortCB(err) { function clearAbortCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -525,7 +527,7 @@ clearAbortCommonEvent(): Promise\<void> ...@@ -525,7 +527,7 @@ clearAbortCommonEvent(): Promise\<void>
```ts ```ts
subscriber.clearAbortCommonEvent().then(() => { subscriber.clearAbortCommonEvent().then(() => {
console.info("clearAbortCommonEvent"); console.info("clearAbortCommonEvent");
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`clearAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -548,7 +550,7 @@ getAbortCommonEvent(callback: AsyncCallback\<boolean>): void ...@@ -548,7 +550,7 @@ getAbortCommonEvent(callback: AsyncCallback\<boolean>): void
```ts ```ts
//获取当前有序公共事件是否取消的回调 //获取当前有序公共事件是否取消的回调
function getAbortCB(err, abortEvent) { function getAbortCB(err:Base.BusinessError, abortEvent:boolean) {
if (err.code) { if (err.code) {
console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -575,9 +577,9 @@ getAbortCommonEvent(): Promise\<boolean> ...@@ -575,9 +577,9 @@ getAbortCommonEvent(): Promise\<boolean>
**示例：** **示例：**
```ts ```ts
subscriber.getAbortCommonEvent().then((abortEvent) => { subscriber.getAbortCommonEvent().then((abortEvent:boolean) => {
console.info("abortCommonEvent " + JSON.stringify(abortEvent)); console.info("abortCommonEvent " + JSON.stringify(abortEvent));
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`getAbortCommonEvent failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -600,7 +602,7 @@ getSubscribeInfo(callback: AsyncCallback\<CommonEventSubscribeInfo>): void ...@@ -600,7 +602,7 @@ getSubscribeInfo(callback: AsyncCallback\<CommonEventSubscribeInfo>): void
```ts ```ts
//获取订阅者信息回调 //获取订阅者信息回调
function getCB(err, subscribeInfo) { function getCB(err:Base.BusinessError, subscribeInfo:CommonEventManager.CommonEventSubscribeInfo) {
if (err.code) { if (err.code) {
console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`); console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -627,9 +629,9 @@ getSubscribeInfo(): Promise\<CommonEventSubscribeInfo> ...@@ -627,9 +629,9 @@ getSubscribeInfo(): Promise\<CommonEventSubscribeInfo>
**示例：** **示例：**
```ts ```ts
subscriber.getSubscribeInfo().then((subscribeInfo) => { subscriber.getSubscribeInfo().then((subscribeInfo:CommonEventManager.CommonEventSubscribeInfo) => {
console.info("subscribeInfo " + JSON.stringify(subscribeInfo)); console.info("subscribeInfo " + JSON.stringify(subscribeInfo));
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`); console.error(`getSubscribeInfo failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
...@@ -652,7 +654,7 @@ finishCommonEvent(callback: AsyncCallback\<void>): void ...@@ -652,7 +654,7 @@ finishCommonEvent(callback: AsyncCallback\<void>): void
```ts ```ts
//结束当前有序公共事件的回调 //结束当前有序公共事件的回调
function finishCB(err) { function finishCB(err:Base.BusinessError) {
if (err.code) { if (err.code) {
console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`);
} else { } else {
...@@ -682,7 +684,7 @@ finishCommonEvent(): Promise\<void> ...@@ -682,7 +684,7 @@ finishCommonEvent(): Promise\<void>
```ts ```ts
subscriber.finishCommonEvent().then(() => { subscriber.finishCommonEvent().then(() => {
console.info("FinishCommonEvent"); console.info("FinishCommonEvent");
}).catch((err) => { }).catch((err:Base.BusinessError) => {
console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`); console.error(`finishCommonEvent failed, code is ${err.code}, message is ${err.message}`);
}); });
``` ```
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或