Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 b97e8fd9 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!10216 事件通知和IDL文档更新 

Merge pull request !10216 from FangJinliang/pr_0929
上级 7ecfa77b d330ca60
展开全部 隐藏空白更改
内联 并排
Showing with 383 addition and 174 deletion
zh-cn/application-dev/IDL/idl-guidelines.md
浏览文件 @ b97e8fd9
......@@ -433,7 +433,7 @@ export default {
console.log('ServiceAbility want:' + JSON.stringify(want));
console.log('ServiceAbility want name:' + want.bundleName)
} catch(err) {
console.log("ServiceAbility error:" + err)
console.log('ServiceAbility error:' + err)
}
console.info('ServiceAbility onConnect end');
return new IdlTestImp('connect');
......@@ -455,13 +455,13 @@ import featureAbility from '@ohos.ability.featureAbility';
function callbackTestIntTransaction(result: number, ret: number): void {
if (result == 0 && ret == 124) {
console.log("case 1 success ");
console.log('case 1 success');
}
}
function callbackTestStringTransaction(result: number): void {
if (result == 0) {
console.log("case 2 success ");
console.log('case 2 success');
}
}
......@@ -472,17 +472,17 @@ var onAbilityConnectDone = {
testProxy.testStringTransaction('hello', callbackTestStringTransaction);
},
onDisconnect:function (elementName) {
console.log("onDisconnectService onDisconnect");
console.log('onDisconnectService onDisconnect');
},
onFailed:function (code) {
console.log("onDisconnectService onFailed");
console.log('onDisconnectService onFailed');
}
};
function connectAbility: void {
let want = {
"bundleName":"com.example.myapplicationidl",
"abilityName": "com.example.myapplicationidl.ServiceAbility"
bundleName: 'com.example.myapplicationidl',
abilityName: 'com.example.myapplicationidl.ServiceAbility'
};
let connectionId = -1;
connectionId = featureAbility.connectAbility(want, onAbilityConnectDone);
......@@ -595,7 +595,7 @@ export default class IdlTestServiceProxy implements IIdlTestService {
let _reply = new rpc.MessageParcel();
_data.writeInt(data);
this.proxy.sendRequest(IdlTestServiceProxy.COMMAND_TEST_INT_TRANSACTION, _data, _reply, _option).then(function(result) {
if (result.errCode === 0) {
if (result.errCode == 0) {
let _errCode = result.reply.readInt();
if (_errCode != 0) {
let _returnValue = undefined;
......@@ -605,7 +605,7 @@ export default class IdlTestServiceProxy implements IIdlTestService {
let _returnValue = result.reply.readInt();
callback(_errCode, _returnValue);
} else {
console.log("sendRequest failed, errCode: " + result.errCode);
console.log('sendRequest failed, errCode: ' + result.errCode);
}
})
}
......@@ -617,11 +617,11 @@ export default class IdlTestServiceProxy implements IIdlTestService {
let _reply = new rpc.MessageParcel();
_data.writeString(data);
this.proxy.sendRequest(IdlTestServiceProxy.COMMAND_TEST_STRING_TRANSACTION, _data, _reply, _option).then(function(result) {
if (result.errCode === 0) {
if (result.errCode == 0) {
let _errCode = result.reply.readInt();
callback(_errCode);
} else {
console.log("sendRequest failed, errCode: " + result.errCode);
console.log('sendRequest failed, errCode: ' + result.errCode);
}
})
}
......@@ -644,12 +644,12 @@ import nativeMgr from 'nativeManager';
function testIntTransactionCallback(errCode: number, returnValue: number)
{
console.log("errCode: " + errCode + " returnValue: " + returnValue);
console.log('errCode: ' + errCode + ' returnValue: ' + returnValue);
}
function testStringTransactionCallback(errCode: number)
{
console.log("errCode: " + errCode);
console.log('errCode: ' + errCode);
}
function jsProxyTriggerCppStub()
......@@ -660,6 +660,6 @@ function jsProxyTriggerCppStub()
tsProxy.testIntTransaction(10, testIntTransactionCallback);
// invoke testStringTransaction
tsProxy.testStringTransaction("test", testIntTransactionCallback);
tsProxy.testStringTransaction('test', testIntTransactionCallback);
}
```
zh-cn/application-dev/notification/common-event.md
浏览文件 @ b97e8fd9
......@@ -32,7 +32,8 @@ import commonEvent from '@ohos.commonEvent';
2. 创建订阅者信息，详细的订阅者信息数据类型及包含的参数请见[CommonEventSubscribeInfo文档](../reference/apis/js-apis-commonEvent.md#commoneventsubscribeinfo)介绍。
```js
private subscriber = null //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
private subscriber = null
//订阅者信息
var subscribeInfo = {
......
zh-cn/application-dev/notification/notification-brief.md
浏览文件 @ b97e8fd9
# 公共事件与通知开发概述
公共事件与通知提供了应用程序向系统其他应用程序发布消息、接收来自系统或其他应用特定消息的能力，这些消息可以是新闻推送、广告通知或者预警信息。
公共事件与通知提供了应用程序向系统其他应用程序发布消息、接收来自系统或其他应用特定消息的能力，这些消息可以是新闻推送、广告通知或者预警信息等。
CES（Common Event Service, 即公共事件服务）为应用程序提供发布、订阅及退订公共事件的能力。公共事件根据事件发送方不同可分为系统公共事件和自定义公共事件。
......@@ -9,7 +9,7 @@ CES（Common Event Service, 即公共事件服务）为应用程序提供发布
- 系统公共事件：系统将收集到的事件信息，根据系统策略发送给订阅该事件的用户程序。 公共事件包括：终端设备用户可感知的亮灭屏事件，以及系统关键服务发布的系统事件（例如：USB插拔，网络连接，系统升级）等。
- 自定义公共事件：由应用自身定义的期望特定订阅者可以接收到的公共事件，这些公共事件往往与应用自身的业务逻辑相关。
ANS（Advanced Notification Service，即通知增强服务）为应用程序提供发布通知的能力。这些通知常见的使用场景如下：
ANS（Advanced Notification Service，即通知系统服务）为应用程序提供发布通知的能力。这些通知常见的使用场景如下：
- 显示接收到的短消息、即时通讯消息等；
- 显示应用的推送消息，如广告、版本更新、新闻通知等；
......
zh-cn/application-dev/reference/apis/js-apis-commonEvent.md
浏览文件 @ b97e8fd9
......@@ -227,7 +227,7 @@ publish(event: string, options: CommonEventPublishData, callback: AsyncCallback\
```js
//公共事件相关信息
var options = {
let options = {
code: 0, //公共事件的初始代码
data: "initial data",//公共事件的初始数据
isOrdered: true //有序公共事件
......@@ -279,7 +279,7 @@ function PublishAsUserCallBack(err) {
}
//指定发送的用户
var userId = 100;
let userId = 100;
//发布公共事件
CommonEvent.publishAsUser("event", userId, PublishAsUserCallBack);
......@@ -311,7 +311,7 @@ publishAsUser(event: string, userId: number, options: CommonEventPublishData, ca
```js
//公共事件相关信息
var options = {
let options = {
code: 0, //公共事件的初始代码
data: "initial data",//公共事件的初始数据
}
......@@ -326,7 +326,7 @@ function PublishAsUserCallBack(err) {
}
//指定发送的用户
var userId = 100;
let userId = 100;
//发布公共事件
CommonEvent.publishAsUser("event", userId, options, PublishAsUserCallBack);
......@@ -353,10 +353,10 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallbac
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
let subscribeInfo = {
events: ["event"]
};
......@@ -398,10 +398,10 @@ createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise\<CommonEventS
**示例：**
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
let subscribeInfo = {
events: ["event"]
};
......@@ -434,10 +434,10 @@ subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback\<CommonEven
**示例：**
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
let subscribeInfo = {
events: ["event"]
};
......@@ -486,10 +486,10 @@ unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback\<void>):
**示例：**
```js
var subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
let subscriber; //用于保存创建成功的订阅者对象，后续使用其完成订阅及退订的动作
//订阅者信息
var subscribeInfo = {
let subscribeInfo = {
events: ["event"]
};
......@@ -549,7 +549,7 @@ getCode(callback: AsyncCallback\<number>): void
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
//获取有序公共事件的结果代码回调
function getCodeCallback(err, Code) {
......@@ -579,7 +579,7 @@ getCode(): Promise\<number>
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
subscriber.getCode().then((Code) => {
console.info("getCode " + JSON.stringify(Code));
......@@ -606,7 +606,7 @@ setCode(code: number, callback: AsyncCallback\<void>): void
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
//设置有序公共事件的结果代码回调
function setCodeCallback(err) {
......@@ -642,7 +642,7 @@ setCode(code: number): Promise\<void>
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
subscriber.setCode(1).then(() => {
console.info("setCode");
......@@ -668,7 +668,7 @@ getData(callback: AsyncCallback\<string>): void
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
//获取有序公共事件的结果数据回调
function getDataCallback(err, Data) {
......@@ -698,7 +698,7 @@ getData(): Promise\<string>
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
subscriber.getData().then((Data) => {
console.info("getData " + JSON.stringify(Data));
......@@ -725,7 +725,7 @@ setData(data: string, callback: AsyncCallback\<void>): void
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
//设置有序公共事件的结果数据回调
function setDataCallback(err) {
......@@ -761,7 +761,7 @@ setData(data: string): Promise\<void>
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
subscriber.setData("publish_data_changed").then(() => {
console.info("setData");
......@@ -789,7 +789,7 @@ setCodeAndData(code: number, data: string, callback:AsyncCallback\<void>): void
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
//设置有序公共事件的结果代码和结果数据回调
function setCodeDataCallback(err) {
......@@ -826,7 +826,7 @@ setCodeAndData(code: number, data: string): Promise\<void>
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
subscriber.setCodeAndData(1, "publish_data_changed").then(() => {
console.info("setCodeAndData");
......@@ -854,7 +854,7 @@ isOrderedCommonEvent(callback: AsyncCallback\<boolean>): void
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
//获取当前公共事件是否为有序事件的回调
function isOrderedCallback(err, isOrdered) {
......@@ -886,7 +886,7 @@ isOrderedCommonEvent(): Promise\<boolean>
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
subscriber.isOrderedCommonEvent().then((isOrdered) => {
console.info("isOrdered " + JSON.stringify(isOrdered));
......@@ -914,7 +914,7 @@ isStickyCommonEvent(callback: AsyncCallback\<boolean>): void
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
//获取当前公共事件是否为粘性事件的回调
function isStickyCallback(err, isSticky) {
......@@ -946,7 +946,7 @@ isStickyCommonEvent(): Promise\<boolean>
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
subscriber.isStickyCommonEvent().then((isSticky) => {
console.info("isSticky " + JSON.stringify(isSticky));
......@@ -972,7 +972,7 @@ abortCommonEvent(callback: AsyncCallback\<void>): void
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
//取消当前有序公共事件的回调
function abortCallback(err) {
......@@ -1002,7 +1002,7 @@ abortCommonEvent(): Promise\<void>
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
subscriber.abortCommonEvent().then(() => {
console.info("abortCommonEvent");
......@@ -1028,7 +1028,7 @@ clearAbortCommonEvent(callback: AsyncCallback\<void>): void
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
//清除当前公共事件取消状态的回调
function clearAbortCallback(err) {
......@@ -1058,7 +1058,7 @@ clearAbortCommonEvent(): Promise\<void>
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
subscriber.clearAbortCommonEvent().then(() => {
console.info("clearAbortCommonEvent");
......@@ -1084,7 +1084,7 @@ getAbortCommonEvent(callback: AsyncCallback\<boolean>): void
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
//获取当前有序公共事件是否取消的回调
function getAbortCallback(err, AbortCommonEvent) {
......@@ -1114,7 +1114,7 @@ getAbortCommonEvent(): Promise\<boolean>
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
subscriber.getAbortCommonEvent().then((AbortCommonEvent) => {
console.info("AbortCommonEvent " + JSON.stringify(AbortCommonEvent));
......@@ -1140,7 +1140,7 @@ getSubscribeInfo(callback: AsyncCallback\<CommonEventSubscribeInfo>): void
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
//获取订阅者信息回调
function getSubscribeInfoCallback(err, SubscribeInfo) {
......@@ -1170,7 +1170,7 @@ getSubscribeInfo(): Promise\<CommonEventSubscribeInfo>
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
subscriber.getSubscribeInfo().then((SubscribeInfo) => {
console.info("SubscribeInfo " + JSON.stringify(SubscribeInfo));
......@@ -1196,7 +1196,7 @@ finishCommonEvent(callback: AsyncCallback\<void\>): void
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
//结束当前有序公共事件的回调
function finishCommonEventCallback(err) {
......@@ -1226,7 +1226,7 @@ finishCommonEvent(): Promise\<void\>
**示例：**
```js
var subscriber; //创建成功的订阅者对象
let subscriber; //创建成功的订阅者对象
subscriber.finishCommonEvent().then(() => {
console.info("FinishCommonEvent");
......
zh-cn/application-dev/reference/apis/js-apis-emitter.md
浏览文件 @ b97e8fd9
......@@ -26,10 +26,10 @@ on(event: [InnerEvent](#innerevent), callback: Callback\<[EventData](#eventdata)
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------ |
| event | [InnerEvent](#innerevent) | 是 | 持续订阅的事件 |
| callback | Callback\<[EventData](#eventdata)\> | 是 | 接收订阅事件时的回调处理 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | --------------------------------------- |
| event | [InnerEvent](#innerevent) | 是 | 持续订阅的事件，其中EventPriority不生效 |
| callback | Callback\<[EventData](#eventdata)\> | 是 | 接收订阅事件时的回调处理 |
**示例：**
......@@ -53,10 +53,10 @@ once(event: [InnerEvent](#innerevent), callback: Callback\<[EventData](#eventdat
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | ------------------------ |
| event | [InnerEvent](#innerevent) | 是 | 单次订阅的事件 |
| callback | Callback\<[EventData](#eventdata)\> | 是 | 接收订阅事件时的回调处理 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------- | ---- | --------------------------------------- |
| event | [InnerEvent](#innerevent) | 是 | 单次订阅的事件，其中EventPriority不生效 |
| callback | Callback\<[EventData](#eventdata)\> | 是 | 接收订阅事件时的回调处理 |
**示例：**
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或