Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

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

!13215 更新事件通知文档 

Merge pull request !13215 from yangliang36/yl0104
上级 0953f840 d8b288b9
隐藏空白更改
内联 并排
Showing with 156 addition and 155 deletion
zh-cn/application-dev/reference/apis/js-apis-commonEvent.md
浏览文件 @ 91b73876
......@@ -40,7 +40,7 @@ publish(event: string, callback: AsyncCallback<void>): void
```ts
//发布公共事件回调
function publishCallBack(err) {
function publishCB(err) {
if (err.code) {
console.error("publish failed " + JSON.stringify(err));
} else {
......@@ -49,7 +49,7 @@ function publishCallBack(err) {
}
//发布公共事件
CommonEvent.publish("event", publishCallBack);
CommonEvent.publish("event", publishCB);
```
## CommonEvent.publish
......@@ -82,7 +82,7 @@ let options = {
}
//发布公共事件回调
function publishCallBack(err) {
function publishCB(err) {
if (err.code) {
console.error("publish failed " + JSON.stringify(err));
} else {
......@@ -91,7 +91,7 @@ function publishCallBack(err) {
}
//发布公共事件
CommonEvent.publish("event", options, publishCallBack);
CommonEvent.publish("event", options, publishCB);
```
## CommonEvent.publishAsUser<sup>8+</sup>
......@@ -118,7 +118,7 @@ publishAsUser(event: string, userId: number, callback: AsyncCallback<void>): voi
```ts
//发布公共事件回调
function publishAsUserCallBack(err) {
function publishCB(err) {
if (err.code) {
console.error("publishAsUser failed " + JSON.stringify(err));
} else {
......@@ -130,7 +130,7 @@ function publishAsUserCallBack(err) {
let userId = 100;
//发布公共事件
CommonEvent.publishAsUser("event", userId, publishAsUserCallBack);
CommonEvent.publishAsUser("event", userId, publishCB);
```
## CommonEvent.publishAsUser<sup>8+</sup>
......@@ -165,7 +165,7 @@ let options = {
}
//发布公共事件回调
function publishAsUserCallBack(err) {
function publishCB(err) {
if (err.code) {
console.error("publishAsUser failed " + JSON.stringify(err));
} else {
......@@ -177,7 +177,7 @@ function publishAsUserCallBack(err) {
let userId = 100;
//发布公共事件
CommonEvent.publishAsUser("event", userId, options, publishAsUserCallBack);
CommonEvent.publishAsUser("event", userId, options, publishCB);
```
## CommonEvent.createSubscriber
......@@ -209,7 +209,7 @@ let subscribeInfo = {
};
//创建订阅者回调
function createSubscriberCallBack(err, commonEventSubscriber) {
function createCB(err, commonEventSubscriber) {
if (err.code) {
console.error("createSubscriber failed " + JSON.stringify(err));
} else {
......@@ -219,7 +219,7 @@ function createSubscriberCallBack(err, commonEventSubscriber) {
}
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, createSubscriberCallBack);
CommonEvent.createSubscriber(subscribeInfo, createCB);
```
## CommonEvent.createSubscriber
......@@ -290,7 +290,7 @@ let subscribeInfo = {
};
//订阅公共事件回调
function subscribeCallBack(err, data) {
function subscribeCB(err, data) {
if (err.code) {
console.error("subscribe failed " + JSON.stringify(err));
} else {
......@@ -299,19 +299,18 @@ function subscribeCallBack(err, data) {
}
//创建订阅者回调
function createSubscriberCallBack(err, commonEventSubscriber) {
function createCB(err, subscriber) {
if (err.code) {
console.error("createSubscriber failed " + JSON.stringify(err));
} else {
console.info("createSubscriber");
subscriber = commonEventSubscriber;
//订阅公共事件
CommonEvent.subscribe(subscriber, subscribeCallBack);
CommonEvent.subscribe(subscriber, subscribeCB);
}
}
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, createSubscriberCallBack);
CommonEvent.createSubscriber(subscribeInfo, createCB);
```
## CommonEvent.unsubscribe
......@@ -342,7 +341,7 @@ let subscribeInfo = {
};
//订阅公共事件回调
function subscribeCallBack(err, data) {
function subscribeCB(err, data) {
if (err.code) {
console.info("subscribe failed " + JSON.stringify(err));
} else {
......@@ -351,19 +350,19 @@ function subscribeCallBack(err, data) {
}
//创建订阅者回调
function createSubscriberCallBack(err, commonEventSubscriber) {
function createCB(err, commonEventSubscriber) {
if (err.code) {
console.info("createSubscriber failed " + JSON.stringify(err));
} else {
console.info("createSubscriber");
subscriber = commonEventSubscriber;
//订阅公共事件
CommonEvent.subscribe(subscriber, subscribeCallBack);
CommonEvent.subscribe(subscriber, subscribeCB);
}
}
//取消订阅公共事件回调
function unsubscribeCallBack(err) {
function unsubscribeCB(err) {
if (err.code) {
console.info("unsubscribe failed " + JSON.stringify(err));
} else {
......@@ -372,10 +371,10 @@ function unsubscribeCallBack(err) {
}
//创建订阅者
CommonEvent.createSubscriber(subscribeInfo, createSubscriberCallBack);
CommonEvent.createSubscriber(subscribeInfo, createCB);
//取消订阅公共事件
CommonEvent.unsubscribe(subscriber, unsubscribeCallBack);
CommonEvent.unsubscribe(subscriber, unsubscribeCB);
```
## CommonEventSubscriber
......@@ -402,14 +401,14 @@ getCode(callback: AsyncCallback<number>): void
let subscriber; //创建成功的订阅者对象
//获取有序公共事件的结果代码回调
function getCodeCallback(err, Code) {
function getCodeCB(err, Code) {
if (err.code) {
console.error("getCode failed " + JSON.stringify(err));
} else {
console.info("getCode " + JSON.stringify(Code));
}
}
subscriber.getCode(getCodeCallback);
subscriber.getCode(getCodeCB);
```
### getCode
......@@ -433,8 +432,8 @@ getCode(): Promise<number>
```ts
let subscriber; //创建成功的订阅者对象
subscriber.getCode().then((Code) => {
console.info("getCode " + JSON.stringify(Code));
subscriber.getCode().then((code) => {
console.info("getCode " + JSON.stringify(code));
}).catch((err) => {
console.error("getCode failed " + JSON.stringify(err));
});
......@@ -463,14 +462,14 @@ setCode(code: number, callback: AsyncCallback<void>): void
let subscriber; //创建成功的订阅者对象
//设置有序公共事件的结果代码回调
function setCodeCallback(err) {
function setCodeCB(err) {
if (err.code) {
console.error("setCode failed " + JSON.stringify(err));
} else {
console.info("setCode");
}
}
subscriber.setCode(1, setCodeCallback);
subscriber.setCode(1, setCodeCB);
```
### setCode
......@@ -529,15 +528,15 @@ getData(callback: AsyncCallback<string>): void
let subscriber; //创建成功的订阅者对象
//获取有序公共事件的结果数据回调
function getDataCallback(err, Data) {
function getDataCB(err, data) {
if (err.code) {
console.error("getData failed " + JSON.stringify(err));
} else {
console.info("getData " + JSON.stringify(Data));
console.info("getData " + JSON.stringify(data));
}
}
subscriber.getData(getDataCallback);
subscriber.getData(getDataCB);
```
### getData
......@@ -561,8 +560,8 @@ getData(): Promise<string>
```ts
let subscriber; //创建成功的订阅者对象
subscriber.getData().then((Data) => {
console.info("getData " + JSON.stringify(Data));
subscriber.getData().then((data) => {
console.info("getData " + JSON.stringify(data));
}).catch((err) => {
console.error("getData failed " + JSON.stringify(err));
});
......@@ -591,14 +590,14 @@ setData(data: string, callback: AsyncCallback<void>): void
let subscriber; //创建成功的订阅者对象
//设置有序公共事件的结果数据回调
function setDataCallback(err) {
function setDataCB(err) {
if (err.code) {
console.error("setData failed " + JSON.stringify(err));
} else {
console.info("setData");
}
}
subscriber.setData("publish_data_changed", setDataCallback);
subscriber.setData("publish_data_changed", setDataCB);
```
### setData
......@@ -659,7 +658,7 @@ setCodeAndData(code: number, data: string, callback:AsyncCallback<void>): void
let subscriber; //创建成功的订阅者对象
//设置有序公共事件的结果代码和结果数据回调
function setCodeDataCallback(err) {
function setCodeDataCB(err) {
if (err.code) {
console.error("setCodeAndData failed " + JSON.stringify(err));
} else {
......@@ -667,7 +666,7 @@ function setCodeDataCallback(err) {
}
}
subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCallback);
subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCB);
```
### setCodeAndData
......@@ -729,14 +728,14 @@ isOrderedCommonEvent(callback: AsyncCallback<boolean>): void
let subscriber; //创建成功的订阅者对象
//获取当前公共事件是否为有序事件的回调
function isOrderedCallback(err, isOrdered) {
function isOrderedCB(err, isOrdered) {
if (err.code) {
console.error("isOrderedCommonEvent failed " + JSON.stringify(err));
} else {
console.info("isOrdered " + JSON.stringify(isOrdered));
}
}
subscriber.isOrderedCommonEvent(isOrderedCallback);
subscriber.isOrderedCommonEvent(isOrderedCB);
```
### isOrderedCommonEvent
......@@ -793,14 +792,14 @@ isStickyCommonEvent(callback: AsyncCallback<boolean>): void
let subscriber; //创建成功的订阅者对象
//获取当前公共事件是否为粘性事件的回调
function isStickyCallback(err, isSticky) {
function isStickyCB(err, isSticky) {
if (err.code) {
console.error("isStickyCommonEvent failed " + JSON.stringify(err));
} else {
console.info("isSticky " + JSON.stringify(isSticky));
}
}
subscriber.isStickyCommonEvent(isStickyCallback);
subscriber.isStickyCommonEvent(isStickyCB);
```
### isStickyCommonEvent
......@@ -855,7 +854,7 @@ abortCommonEvent(callback: AsyncCallback<void>): void
let subscriber; //创建成功的订阅者对象
//取消当前有序公共事件的回调
function abortCallback(err) {
function abortCB(err) {
if (err.code) {
console.error("abortCommonEvent failed " + JSON.stringify(err));
} else {
......@@ -863,7 +862,7 @@ function abortCallback(err) {
}
}
subscriber.abortCommonEvent(abortCallback);
subscriber.abortCommonEvent(abortCB);
```
### abortCommonEvent
......@@ -916,7 +915,7 @@ clearAbortCommonEvent(callback: AsyncCallback<void>): void
let subscriber; //创建成功的订阅者对象
//清除当前公共事件取消状态的回调
function clearAbortCallback(err) {
function clearAbortCB(err) {
if (err.code) {
console.error("clearAbortCommonEvent failed " + JSON.stringify(err));
} else {
......@@ -924,7 +923,7 @@ function clearAbortCallback(err) {
}
}
subscriber.clearAbortCommonEvent(clearAbortCallback);
subscriber.clearAbortCommonEvent(clearAbortCB);
```
### clearAbortCommonEvent
......@@ -977,15 +976,15 @@ getAbortCommonEvent(callback: AsyncCallback<boolean>): void
let subscriber; //创建成功的订阅者对象
//获取当前有序公共事件是否取消的回调
function getAbortCallback(err, AbortCommonEvent) {
function getAbortCB(err, abortEvent) {
if (err.code) {
console.error("getAbortCommonEvent failed " + JSON.stringify(err));
} else {
console.info("AbortCommonEvent " + AbortCommonEvent)
console.info("abortEvent " + abortEvent)
}
}
subscriber.getAbortCommonEvent(getAbortCallback);
subscriber.getAbortCommonEvent(getAbortCB);
```
### getAbortCommonEvent
......@@ -1009,8 +1008,8 @@ getAbortCommonEvent(): Promise<boolean>
```ts
let subscriber; //创建成功的订阅者对象
subscriber.getAbortCommonEvent().then((AbortCommonEvent) => {
console.info("AbortCommonEvent " + JSON.stringify(AbortCommonEvent));
subscriber.getAbortCommonEvent().then((abortCommonEvent) => {
console.info("abortCommonEvent " + JSON.stringify(abortCommonEvent));
}).catch((err) => {
console.error("getAbortCommonEvent failed " + JSON.stringify(err));
});
......@@ -1038,15 +1037,15 @@ getSubscribeInfo(callback: AsyncCallback<CommonEventSubscribeInfo>): void
let subscriber; //创建成功的订阅者对象
//获取订阅者信息回调
function getSubscribeInfoCallback(err, SubscribeInfo) {
function getCB(err, subscribeInfo) {
if (err.code) {
console.error("getSubscribeInfo failed " + JSON.stringify(err));
} else {
console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo));
console.info("SubscribeInfo " + JSON.stringify(subscribeInfo));
}
}
subscriber.getSubscribeInfo(getSubscribeInfoCallback);
subscriber.getSubscribeInfo(getCB);
```
### getSubscribeInfo
......@@ -1070,8 +1069,8 @@ getSubscribeInfo(): Promise<CommonEventSubscribeInfo>
```ts
let subscriber; //创建成功的订阅者对象
subscriber.getSubscribeInfo().then((SubscribeInfo) => {
console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo));
subscriber.getSubscribeInfo().then((subscribeInfo) => {
console.info("subscribeInfo " + JSON.stringify(subscribeInfo));
}).catch((err) => {
console.error("getSubscribeInfo failed " + JSON.stringify(err));
});
......@@ -1099,7 +1098,7 @@ finishCommonEvent(callback: AsyncCallback<void>): void
let subscriber; //创建成功的订阅者对象
//结束当前有序公共事件的回调
function finishCommonEventCallback(err) {
function finishCB(err) {
if (err.code) {
console.error("finishCommonEvent failed " + JSON.stringify(err));
} else {
......@@ -1107,7 +1106,7 @@ function finishCommonEventCallback(err) {
}
}
subscriber.finishCommonEvent(finishCommonEventCallback);
subscriber.finishCommonEvent(finishCB);
```
### finishCommonEvent<sup>9+</sup>
......
zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md
浏览文件 @ 91b73876
......@@ -43,7 +43,7 @@ publish(event: string, callback: AsyncCallback<void>): void
```ts
//发布公共事件回调
function publishCallBack(err) {
function publishCB(err) {
if (err) {
console.error("publish failed " + JSON.stringify(err));
} else {
......@@ -53,7 +53,7 @@ function publishCallBack(err) {
//发布公共事件
try {
CommonEventManager.publish("event", publishCallBack);
CommonEventManager.publish("event", publishCB);
} catch(err) {
console.error('publish failed, catch error' + JSON.stringify(err));
}
......@@ -92,7 +92,7 @@ let options = {
}
//发布公共事件回调
function publishCallBack(err) {
function publishCB(err) {
if (err) {
console.error("publish failed " + JSON.stringify(err));
} else {
......@@ -102,7 +102,7 @@ function publishCallBack(err) {
//发布公共事件
try {
CommonEventManager.publish("event", options, publishCallBack);
CommonEventManager.publish("event", options, publishCB);
} catch (err) {
console.error('publish failed, catch error' + JSON.stringify(err));
}
......@@ -136,7 +136,7 @@ publishAsUser(event: string, userId: number, callback: AsyncCallback<void>): voi
```ts
//发布公共事件回调
function publishAsUserCallBack(err) {
function publishCB(err) {
if (err) {
console.error("publishAsUser failed " + JSON.stringify(err));
} else {
......@@ -149,7 +149,7 @@ let userId = 100;
//发布公共事件
try {
CommonEventManager.publishAsUser("event", userId, publishAsUserCallBack);
CommonEventManager.publishAsUser("event", userId, publishCB);
} catch (err) {
console.error('publishAsUser failed, catch error' + JSON.stringify(err));
}
......@@ -191,7 +191,7 @@ let options = {
}
//发布公共事件回调
function publishAsUserCallBack(err) {
function publishCB(err) {
if (err) {
console.error("publishAsUser failed " + JSON.stringify(err));
} else {
......@@ -204,7 +204,7 @@ let userId = 100;
//发布公共事件
try {
CommonEventManager.publishAsUser("event", userId, options, publishAsUserCallBack);
CommonEventManager.publishAsUser("event", userId, options, publishCB);
} catch (err) {
console.error('publishAsUser failed, catch error' + JSON.stringify(err));
}
......@@ -239,7 +239,7 @@ let subscribeInfo = {
};
//创建订阅者回调
function createSubscriberCallBack(err, commonEventSubscriber) {
function createCB(err, commonEventSubscriber) {
if(!err) {
console.info("createSubscriber");
subscriber = commonEventSubscriber;
......@@ -250,7 +250,7 @@ function createSubscriberCallBack(err, commonEventSubscriber) {
//创建订阅者
try {
CommonEventManager.createSubscriber(subscribeInfo, createSubscriberCallBack);
CommonEventManager.createSubscriber(subscribeInfo, createCB);
} catch (err) {
console.error('createSubscriber failed, catch error' + JSON.stringify(err));
}
......@@ -326,7 +326,7 @@ let subscribeInfo = {
};
//订阅公共事件回调
function SubscribeCallBack(err, data) {
function SubscribeCB(err, data) {
if (err.code) {
console.error("subscribe failed " + JSON.stringify(err));
} else {
......@@ -335,13 +335,12 @@ function SubscribeCallBack(err, data) {
}
//创建订阅者回调
function createSubscriberCallBack(err, commonEventSubscriber) {
function createCB(err, subscriber) {
if(!err) {
console.info("createSubscriber");
subscriber = commonEventSubscriber;
//订阅公共事件
try {
CommonEventManager.subscribe(subscriber, SubscribeCallBack);
CommonEventManager.subscribe(subscriber, SubscribeCB);
} catch (err) {
console.error("createSubscriber failed " + JSON.stringify(err));
}
......@@ -352,7 +351,7 @@ function createSubscriberCallBack(err, commonEventSubscriber) {
//创建订阅者
try {
CommonEventManager.createSubscriber(subscribeInfo, createSubscriberCallBack);
CommonEventManager.createSubscriber(subscribeInfo, createCB);
} catch (err) {
console.error('createSubscriber failed, catch error' + JSON.stringify(err));
}
......@@ -384,7 +383,7 @@ let subscribeInfo = {
events: ["event"]
};
//订阅公共事件回调
function subscribeCallBack(err, data) {
function subscribeCB(err, data) {
if (err) {
console.info("subscribe failed " + JSON.stringify(err));
} else {
......@@ -392,22 +391,21 @@ function subscribeCallBack(err, data) {
}
}
//创建订阅者回调
function createSubscriberCallBack(err, commonEventSubscriber) {
function createCB(err, subscriber) {
if (err) {
console.info("createSubscriber failed " + JSON.stringify(err));
} else {
console.info("createSubscriber");
subscriber = commonEventSubscriber;
//订阅公共事件
try {
CommonEventManager.subscribe(subscriber, subscribeCallBack);
CommonEventManager.subscribe(subscriber, subscribeCB);
} catch(err) {
console.info("subscribe failed " + JSON.stringify(err));
}
}
}
//取消订阅公共事件回调
function unsubscribeCallBack(err) {
function unsubscribeCB(err) {
if (err) {
console.info("unsubscribe failed " + JSON.stringify(err));
} else {
......@@ -416,14 +414,14 @@ function unsubscribeCallBack(err) {
}
//创建订阅者
try {
CommonEventManager.createSubscriber(subscribeInfo, createSubscriberCallBack);
CommonEventManager.createSubscriber(subscribeInfo, createCB);
} catch (err) {
console.info("createSubscriber failed " + JSON.stringify(err));
}
//取消订阅公共事件
try {
CommonEventManager.unsubscribe(subscriber, unsubscribeCallBack);
CommonEventManager.unsubscribe(subscriber, unsubscribeCB);
} catch (err) {
console.info("unsubscribe failed " + JSON.stringify(err));
}
......@@ -453,14 +451,14 @@ getCode(callback: AsyncCallback<number>): void
let subscriber; //创建成功的订阅者对象
//获取有序公共事件代码回调
function getCodeCallback(err, Code) {
function getCodeCB(err, code) {
if (err.code) {
console.error("getCode failed " + JSON.stringify(err));
} else {
console.info("getCode " + JSON.stringify(Code));
console.info("getCode " + JSON.stringify(code));
}
}
subscriber.getCode(getCodeCallback);
subscriber.getCode(getCodeCB);
```
### getCode
......@@ -484,8 +482,8 @@ getCode(): Promise<number>
```ts
let subscriber; //创建成功的订阅者对象
subscriber.getCode().then((Code) => {
console.info("getCode " + JSON.stringify(Code));
subscriber.getCode().then((code) => {
console.info("getCode " + JSON.stringify(code));
}).catch((err) => {
console.error("getCode failed " + JSON.stringify(err));
});
......@@ -493,7 +491,9 @@ subscriber.getCode().then((Code) => {
### setCode
setCode(code: number, callback: AsyncCallback\<void>): void
```ts
setCode(code: number, callback: AsyncCallback<void>): void
```
以回调形式设置公共事件的代码。
......@@ -512,14 +512,14 @@ setCode(code: number, callback: AsyncCallback\<void>): void
let subscriber; //创建成功的订阅者对象
//设置有序公共事件的代码回调
function setCodeCallback(err) {
function setCodeCB(err) {
if (err.code) {
console.error("setCode failed " + JSON.stringify(err));
} else {
console.info("setCode");
}
}
subscriber.setCode(1, setCodeCallback);
subscriber.setCode(1, setCodeCB);
```
### setCode
......@@ -578,14 +578,14 @@ getData(callback: AsyncCallback<string>): void
let subscriber; //创建成功的订阅者对象
//获取有序公共事件代码数据回调
function getDataCallback(err, Data) {
function getDataCB(err, data) {
if (err.code) {
console.error("getData failed " + JSON.stringify(err));
} else {
console.info("getData " + JSON.stringify(Data));
console.info("getData " + JSON.stringify(data));
}
}
subscriber.getData(getDataCallback);
subscriber.getData(getDataCB);
```
### getData
......@@ -609,8 +609,8 @@ getData(): Promise<string>
```ts
let subscriber; //创建成功的订阅者对象
subscriber.getData().then((Data) => {
console.info("getData " + JSON.stringify(Data));
subscriber.getData().then((data) => {
console.info("getData " + JSON.stringify(data));
}).catch((err) => {
console.error("getData failed " + JSON.stringify(err));
});
......@@ -637,14 +637,14 @@ setData(data: string, callback: AsyncCallback\<void>): void
let subscriber; //创建成功的订阅者对象
//设置有序公共事件的结果数据回调
function setDataCallback(err) {
function setDataCB(err) {
if (err.code) {
console.error("setData failed " + JSON.stringify(err));
} else {
console.info("setData");
}
}
subscriber.setData("publish_data_changed", setDataCallback);
subscriber.setData("publish_data_changed", setDataCB);
```
### setData
......@@ -705,14 +705,14 @@ setCodeAndData(code: number, data: string, callback:AsyncCallback<void>): void
let subscriber; //创建成功的订阅者对象
//设置有序公共事件的代码和数据回调
function setCodeDataCallback(err) {
function setCodeDataCB(err) {
if (err.code) {
console.error("setCodeAndData failed " + JSON.stringify(err));
} else {
console.info("setCodeDataCallback");
}
}
subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCallback);
subscriber.setCodeAndData(1, "publish_data_changed", setCodeDataCB);
```
### setCodeAndData
......@@ -774,20 +774,20 @@ isOrderedCommonEvent(callback: AsyncCallback<boolean>): void
let subscriber; //创建成功的订阅者对象
//获取当前公共事件是否为有序事件的回调
function isOrderedCallback(err, isOrdered) {
function isOrderedCB(err, isOrdered) {
if (err.code) {
console.error("isOrderedCommonEvent failed " + JSON.stringify(err));
} else {
console.info("isOrdered " + JSON.stringify(isOrdered));
}
}
subscriber.isOrderedCommonEvent(isOrderedCallback);
subscriber.isOrderedCommonEvent(isOrderedCB);
```
### isOrderedCommonEvent
```ts
isOrderedCommonEvent(): Promise\<boolean>
isOrderedCommonEvent(): Promise<boolean>
```
以Promise形式查询当前公共事件的是否为有序公共事件。
......@@ -838,14 +838,14 @@ isStickyCommonEvent(callback: AsyncCallback<boolean>): void
let subscriber; //创建成功的订阅者对象
//获取当前公共事件是否为粘性事件的回调
function isStickyCallback(err, isSticky) {
function isStickyCB(err, isSticky) {
if (err.code) {
console.error("isStickyCommonEvent failed " + JSON.stringify(err));
} else {
console.info("isSticky " + JSON.stringify(isSticky));
}
}
subscriber.isStickyCommonEvent(isStickyCallback);
subscriber.isStickyCommonEvent(isStickyCB);
```
### isStickyCommonEvent
......@@ -900,14 +900,14 @@ abortCommonEvent(callback: AsyncCallback<void>): void
let subscriber; //创建成功的订阅者对象
//取消当前有序公共事件的回调
function abortCallback(err) {
function abortCB(err) {
if (err.code) {
console.error("abortCommonEvent failed " + JSON.stringify(err));
} else {
console.info("abortCommonEvent");
}
}
subscriber.abortCommonEvent(abortCallback);
subscriber.abortCommonEvent(abortCB);
```
### abortCommonEvent
......@@ -960,14 +960,14 @@ clearAbortCommonEvent(callback: AsyncCallback<void>): void
let subscriber; //创建成功的订阅者对象
//清除当前公共事件取消状态的回调
function clearAbortCallback(err) {
function clearAbortCB(err) {
if (err.code) {
console.error("clearAbortCommonEvent failed " + JSON.stringify(err));
} else {
console.info("clearAbortCommonEvent");
}
}
subscriber.clearAbortCommonEvent(clearAbortCallback);
subscriber.clearAbortCommonEvent(clearAbortCB);
```
### clearAbortCommonEvent
......@@ -1020,14 +1020,14 @@ getAbortCommonEvent(callback: AsyncCallback<boolean>): void
let subscriber; //创建成功的订阅者对象
//获取当前有序公共事件是否取消的回调
function getAbortCallback(err, AbortCommonEvent) {
function getAbortCB(err, abortEvent) {
if (err.code) {
console.error("getAbortCommonEvent failed " + JSON.stringify(err));
} else {
console.info("AbortCommonEvent " + AbortCommonEvent)
console.info("abortCommonEvent " + abortEvent)
}
}
subscriber.getAbortCommonEvent(getAbortCallback);
subscriber.getAbortCommonEvent(getAbortCB);
```
### getAbortCommonEvent
......@@ -1051,8 +1051,8 @@ getAbortCommonEvent(): Promise<boolean>
```ts
let subscriber; //创建成功的订阅者对象
subscriber.getAbortCommonEvent().then((AbortCommonEvent) => {
console.info("AbortCommonEvent " + JSON.stringify(AbortCommonEvent));
subscriber.getAbortCommonEvent().then((abortEvent) => {
console.info("abortCommonEvent " + JSON.stringify(abortEvent));
}).catch((err) => {
console.error("getAbortCommonEvent failed " + JSON.stringify(err));
});
......@@ -1060,7 +1060,9 @@ subscriber.getAbortCommonEvent().then((AbortCommonEvent) => {
### getSubscribeInfo
getSubscribeInfo(callback: AsyncCallback\<CommonEventSubscribeInfo>): void
```ts
getSubscribeInfo(callback: AsyncCallback<CommonEventSubscribeInfo>): void
```
以回调形式获取订阅者的订阅信息。
......@@ -1078,14 +1080,14 @@ getSubscribeInfo(callback: AsyncCallback\<CommonEventSubscribeInfo>): void
let subscriber; //创建成功的订阅者对象
//获取订阅者信息回调
function getSubscribeInfoCallback(err, SubscribeInfo) {
function getCB(err, subscribeInfo) {
if (err.code) {
console.error("getSubscribeInfo failed " + JSON.stringify(err));
} else {
console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo));
console.info("subscribeInfo " + JSON.stringify(subscribeInfo));
}
}
subscriber.getSubscribeInfo(getSubscribeInfoCallback);
subscriber.getSubscribeInfo(getCB);
```
### getSubscribeInfo
......@@ -1109,8 +1111,8 @@ getSubscribeInfo(): Promise<CommonEventSubscribeInfo>
```ts
let subscriber; //创建成功的订阅者对象
subscriber.getSubscribeInfo().then((SubscribeInfo) => {
console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo));
subscriber.getSubscribeInfo().then((subscribeInfo) => {
console.info("subscribeInfo " + JSON.stringify(subscribeInfo));
}).catch((err) => {
console.error("getSubscribeInfo failed " + JSON.stringify(err));
});
......@@ -1138,14 +1140,14 @@ finishCommonEvent(callback: AsyncCallback<void>): void
let subscriber; //创建成功的订阅者对象
//结束当前有序公共事件的回调
function finishCommonEventCallback(err) {
function finishCB(err) {
if (err.code) {
console.error("finishCommonEvent failed " + JSON.stringify(err));
} else {
console.info("FinishCommonEvent");
}
}
subscriber.finishCommonEvent(finishCommonEventCallback);
subscriber.finishCommonEvent(finishCB);
```
### finishCommonEvent<sup>9+</sup>
......
zh-cn/application-dev/reference/apis/js-apis-emitter.md
浏览文件 @ 91b73876
......@@ -60,7 +60,7 @@ once(event: [InnerEvent](#innerevent), callback: Callback\<[EventData](#eventdat
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------------------------------------------------------------ |
| event | [InnerEvent](#innerevent) | 是 | 单次订阅的事件，其中[EventPriority](#eventpriority)，在订阅事件时无需指定，也不生效 |
| callback | Callback\<[EventData](#innerevent)\> | 是 | 接收到该事件时需要执行的回调处理函数 |
| callback | Callback\<[EventData](#eventdata)\> | 是 | 接收到该事件时需要执行的回调处理函数 |
**示例：**
......
zh-cn/application-dev/reference/errorcodes/errorcode-CommonEventService.md
浏览文件 @ 91b73876
......@@ -3,125 +3,125 @@
## 1500001 want中Action为空
**错误信息**
Want action is null
> Want action is null
**错误描述**
发送事件的`want`中的`Action`属性为空时系统会产生此错误码。
> 发送事件的`want`中的`Action`属性为空时系统会产生此错误码。
**可能原因**
发送事件的`want`中的`Action`属性为空。
> 发送事件的`want`中的`Action`属性为空。
**处理步骤**
检查传入`want`的`Action`属性是否为空。
> 检查传入`want`的`Action`属性是否为空。
## 1500002 沙箱应用无法发送公共事件
**错误信息**
sandbox application can not send common event
> sandbox application can not send common event
**错误描述**
沙箱应用无法发送公共事件。
> 沙箱应用无法发送公共事件。
**可能原因**
事件发送方应用为沙箱应用，发送事件会被拦截。
> 事件发送方应用为沙箱应用，发送事件会被拦截。
**处理步骤**
沙箱应用无法发送公共事件，发送公共事件前确认是否为沙箱应用。
> 沙箱应用无法发送公共事件，发送公共事件前确认是否为沙箱应用。
## 1500003 事件发送频率过高
**错误信息**
common event send frequency too high
> common event send frequency too high
**错误描述**
应用发送事件过于频繁。
> 应用发送事件过于频繁。
**可能原因**
短时间内应用发送过多事件。
> 短时间内应用发送过多事件。
**处理步骤**
检查应用是否过于频繁地发送事件。
> 检查应用是否过于频繁地发送事件。
## 1500004 无法发送系统公共事件
**错误信息**
not System services or System app
> not System services or System app
**错误描述**
当前应用无法发送系统公共事件。
> 当前应用无法发送系统公共事件。
**可能原因**
非系统应用或非系统服务发送系统公共事件。
> 非系统应用或非系统服务发送系统公共事件。
**处理步骤**
确认当前应用是否为系统应用，或当前服务是否为系统服务。
> 确认当前应用是否为系统应用，或当前服务是否为系统服务。
## 1500005 未找到订阅者
**错误信息**
subscriber can not found
> subscriber can not found
**错误描述**
找不到订阅者。
> 找不到订阅者。
**可能原因**
订阅者被删除。
> 订阅者被删除。
**处理步骤**
检查是否有重复取消订阅。
> 检查是否有重复取消订阅。
## 1500006 无效userId
**错误信息**
userId is invalid
> userId is invalid
**错误描述**
无效的userId。
> 无效的userId。
**可能原因**
和系统`userId`不一致或不是系统应用或系统服务进程。
> 和系统`userId`不一致或不是系统应用或系统服务进程。
**处理步骤**
1. 检查当前`userId`是否和系统`userId`一致。
2. 检查当前应用是否为系统应用或系统服务。
> 1. 检查当前`userId`是否和系统`userId`一致。
> 2. 检查当前应用是否为系统应用或系统服务。
## 1500007 IPC请求发送失败
**错误信息**
message send error
> message send error
**错误描述**
`IPC`发送请求失败。
> `IPC`发送请求失败。
**可能原因**
没有成功创建连接对象。
> 没有成功创建连接对象。
**处理步骤**
请勿频繁建立链接，稍后重新尝试。
> 请勿频繁建立链接，稍后重新尝试。
## 1500008 读取数据失败
**错误信息**
CEMS error
> CEMS error
**错误描述**
服务端发生错误。
> 服务端发生错误。
**可能原因**
服务端处理数据时发现业务异常。
> 服务端处理数据时发现业务异常。
**处理步骤**
稍后重新尝试。
> 稍后重新尝试。
## 1500009 system error
**错误信息**
system error
> system error
**错误描述**
处理业务时系统发生异常，如获取系统当前时间失败。
> 处理业务时系统发生异常，如获取系统当前时间失败。
**可能原因**
系统故障，获取系统当前时间发生异常。
> 系统故障，获取系统当前时间发生异常。
**处理步骤**
稍后重新尝试。
> 稍后重新尝试。
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或