Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
42deec46
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
42deec46
编写于
3月 04, 2022
作者:
E
ester.zhou
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update doc
Signed-off-by:
N
ester.zhou
<
ester.zhou@huawei.com
>
上级
9ab15dc0
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
77 addition
and
4 deletion
+77
-4
en/application-dev/reference/apis/js-apis-commonEvent.md
en/application-dev/reference/apis/js-apis-commonEvent.md
+77
-4
未找到文件。
en/application-dev/reference/apis/js-apis-commonEvent.md
浏览文件 @
42deec46
...
...
@@ -113,7 +113,7 @@
## Modules to Import
```
js
import
CommonEvent
from
'
@ohos.common
e
vent
'
;
import
CommonEvent
from
'
@ohos.common
E
vent
'
;
```
## System Capabilities
...
...
@@ -183,6 +183,79 @@ CommonEvent.publish("publish_event", options, PublishCallBack);
## CommonEvent.publishAsUser
publishAsUser(event: string, userId: number, callback: AsyncCallback
\<
void>): void
Publishes a common event to a specific user. This method uses a callback to return the result.
**Parameters**
| Name| Readable/Writable| Type| Mandatory| Description|
| -------- | -------- | -------------------- | ---- | ---------------------------------- |
| event | Read-only| string | Yes| Name of the common event to publish.|
| userId | Read-only| number | Yes| User ID.|
| callback | Read-only| AsyncCallback
\<
void> | Yes| Callback used to return the result.|
**Example**
```
js
// Callback for common event publication
function
PublishAsUserCallBack
(
err
)
{
if
(
err
.
code
)
{
console
.
info
(
"
publishAsUser failed
"
+
JSON
.
stringify
(
err
));
}
else
{
console
.
info
(
"
publishAsUser
"
);
}
}
// Specify the user to whom the common event will be published.
var
userId
=
100
;
// Publish a common event.
CommonEvent
.
publish
(
"
publish_event
"
,
userId
,
PublishAsUserCallBack
);
```
## CommonEvent.publishAsUser
publishAsUser(event: string, userId: number, options: CommonEventPublishData, callback: AsyncCallback
\<
void>): void
Publishes a common event with given attributes to a specific user. This method uses a callback to return the result.
**Parameters**
| Name| Readable/Writable| Type| Mandatory| Description|
| -------- | -------- | ---------------------- | ---- | ---------------------- |
| event | Read-only| string | Yes| Name of the common event to publish.|
| userId | Read-only| number | Yes| User ID.|
| options | Read-only|
[
CommonEventPublishData
](
#commoneventpublishdata
)
| Yes| Attributes of the common event to publish.|
| callback | Read-only| AsyncCallback
\<
void> | Yes| Callback used to return the result.|
**Example**
```
js
// Attributes of a common event.
var
options
=
{
code
:
0
;
// Result code of the common event
data
:
"
initial data
"
;
// Result data of the common event
}
// Callback for common event publication
function
PublishAsUserCallBack
(
err
)
{
if
(
err
.
code
)
{
console
.
info
(
"
publishAsUser failed
"
+
JSON
.
stringify
(
err
));
}
else
{
console
.
info
(
"
publishAsUser
"
);
}
}
// Specify the user to whom the common event will be published.
var
userId
=
100
;
// Publish a common event.
CommonEvent
.
publish
(
"
publish_event
"
,
userId
,
options
,
PublishAsUserCallBack
);
```
## CommonEvent.createSubscriber
createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback
\<
CommonEventSubscriber>): void
...
...
@@ -491,7 +564,7 @@ Sets the result code for this common event. This method uses a promise to return
| Name| Type| Mandatory| Description|
| ------ | ------ | ---- | ------------------ |
| code | number | Yes|
Result code of the common event
.|
| code | number | Yes|
Callback used to return the result code
.|
**Example**
...
...
@@ -584,7 +657,7 @@ Sets the result data for this common event. This method uses a promise to return
| Name| Type| Mandatory| Description|
| ------ | ------ | ---- | -------------------- |
| data | string | Yes|
Result data of the common event
.|
| data | string | Yes|
Callback used to return the result data
.|
**Example**
...
...
@@ -632,7 +705,7 @@ Sets the result code and result data for this common event. This method uses a p
| Name| Type| Mandatory| Description|
| ------ | ------ | ---- | -------------------- |
| code | number | Yes| Result code of the common event.|
| data | string | Yes|
Result data of the common event
.|
| data | string | Yes|
Callback used to return the result data
.|
**Example**
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录