Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
d9b2c727
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看板
未验证
提交
d9b2c727
编写于
4月 07, 2023
作者:
O
openharmony_ci
提交者:
Gitee
4月 07, 2023
浏览文件
操作
浏览文件
下载
差异文件
!16854 新增removeStickyCommonEvent接口文档
Merge pull request !16854 from FangJinliang/pr_0404
上级
003b8445
e0f0d81c
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
74 addition
and
25 deletion
+74
-25
zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md
...lication-dev/reference/apis/js-apis-commonEventManager.md
+74
-25
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-commonEventManager.md
浏览文件 @
d9b2c727
...
...
@@ -20,13 +20,11 @@ import CommonEventManager from '@ohos.commonEventManager';
## CommonEventManager.publish
```
ts
publish(event: string, callback: AsyncCallback
<void>
): void
```
发布公共事件,并在发布后执行相应的回调函数。
**系统能力:**
`SystemCapability.Notification.CommonEvent`
**系统能力:**
SystemCapability.Notification.CommonEvent
**参数:**
...
...
@@ -61,13 +59,11 @@ try {
## CommonEventManager.publish
```
ts
publish(event: string, options: CommonEventPublishData, callback: AsyncCallback
<void>
): void
```
以回调的形式发布公共事件。
**系统能力:**
`SystemCapability.Notification.CommonEvent`
**系统能力:**
SystemCapability.Notification.CommonEvent
**参数:**
...
...
@@ -110,13 +106,11 @@ try {
## CommonEventManager.publishAsUser<sup>
```
ts
publishAsUser(event: string, userId: number, callback: AsyncCallback
<void>
): void
```
以回调的形式向指定用户发布公共事件。
**系统能力:**
`SystemCapability.Notification.CommonEvent`
**系统能力:**
SystemCapability.Notification.CommonEvent
**系统API**
:此接口为系统接口,三方应用不支持调用。
...
...
@@ -157,13 +151,11 @@ try {
## CommonEventManager.publishAsUser
```
ts
publishAsUser(event: string, userId: number, options: CommonEventPublishData, callback: AsyncCallback
<void>
): void
```
以回调形式向指定用户发布公共事件并指定发布信息。
**系统能力:**
`SystemCapability.Notification.CommonEvent`
**系统能力:**
SystemCapability.Notification.CommonEvent
**系统API**
:此接口为系统接口,三方应用不支持调用。
...
...
@@ -212,13 +204,11 @@ try {
## CommonEventManager.createSubscriber
```
ts
createSubscriber(subscribeInfo: CommonEventSubscribeInfo, callback: AsyncCallback
<CommonEventSubscriber>
): void
```
以回调形式创建订阅者。
**系统能力:**
`SystemCapability.Notification.CommonEvent`
**系统能力:**
SystemCapability.Notification.CommonEvent
**参数:**
...
...
@@ -258,13 +248,11 @@ try {
## CommonEventManager.createSubscriber
```
ts
createSubscriber(subscribeInfo: CommonEventSubscribeInfo): Promise
<CommonEventSubscriber>
```
以Promise形式创建订阅者。
**系统能力:**
`SystemCapability.Notification.CommonEvent`
**系统能力:**
SystemCapability.Notification.CommonEvent
**参数:**
...
...
@@ -299,13 +287,11 @@ CommonEventManager.createSubscriber(subscribeInfo).then((commonEventSubscriber)
## CommonEventManager.subscribe
```
ts
subscribe(subscriber: CommonEventSubscriber, callback: AsyncCallback
<CommonEventData>
): void
```
以回调形式订阅公共事件。
**系统能力:**
`SystemCapability.Notification.CommonEvent`
**系统能力:**
SystemCapability.Notification.CommonEvent
**参数:**
...
...
@@ -360,13 +346,11 @@ try {
## CommonEventManager.unsubscribe
```
ts
unsubscribe(subscriber: CommonEventSubscriber, callback?: AsyncCallback
<void>
): void
```
以回调形式取消订阅公共事件。
**系统能力:**
`SystemCapability.Notification.CommonEvent`
**系统能力:**
SystemCapability.Notification.CommonEvent
**参数:**
...
...
@@ -427,4 +411,69 @@ try {
}
catch
(
err
)
{
console
.
error
(
`unsubscribe failed, code is
${
err
.
code
}
, message is
${
err
.
message
}
`
);
}
```
\ No newline at end of file
```
## CommonEventManager.removeStickyCommonEvent<sup>10+</sup>
removeStickyCommonEvent(event: string, callback: AsyncCallback
<void>
): void
以回调形式移除粘性公共事件。
**系统能力:**
SystemCapability.Notification.CommonEvent
**需要权限**
: ohos.permission.COMMONEVENT_STICKY
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------- | ---- | -------------------------------- |
| event | string | 是 | 表示被移除的粘性公共事件。 |
| callback | AsyncCallback
\<
void> | 是 | 表示移除粘性公共事件的回调方法。 |
**示例:**
```
ts
CommonEventManager
.
removeStickyCommonEvent
(
"
sticky_event
"
,
(
err
)
=>
{
if
(
err
)
{
console
.
info
(
`Remove sticky event AsyncCallback failed, errCode:
${
err
.
code
}
, errMes:
${
err
.
message
}
`
);
return
;
}
console
.
info
(
`Remove sticky event AsyncCallback success`
);
}
});
```
## CommonEventManager.removeStickyCommonEvent<sup>10+</sup>
removeStickyCommonEvent(event: string): Promise
<void>
以Promise形式移除粘性公共事件。
**系统能力:**
SystemCapability.Notification.CommonEvent
**需要权限**
: ohos.permission.COMMONEVENT_STICKY
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | -------------------------- |
| event | string | 是 | 表示被移除的粘性公共事件。 |
**返回值:**
| 类型 | 说明 |
| -------------- | ---------------------------- |
| Promise
\<
void> | 表示移除粘性公共事件的对象。 |
**示例:**
```
ts
commonEventManager
.
removeStickyCommonEvent
(
"
sticky_event
"
).
then
(()
=>
{
console
.
info
(
`Remove sticky event AsyncCallback success`
);
}).
catch
((
err
)
=>
{
console
.
info
(
`Remove sticky event AsyncCallback failed, errCode:
${
err
.
code
}
, errMes:
${
err
.
message
}
`
);
});
```
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录