Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
5792198c
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,发现更多精彩内容 >>
未验证
提交
5792198c
编写于
3月 30, 2022
作者:
O
openharmony_ci
提交者:
Gitee
3月 30, 2022
浏览文件
操作
浏览文件
下载
差异文件
!2824 修改注释和标记api9接口
Merge pull request !2824 from zengsiyu/dev
上级
4c0ec361
439d4bc3
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
26 addition
and
21 deletion
+26
-21
zh-cn/application-dev/reference/apis/js-apis-commonEvent.md
zh-cn/application-dev/reference/apis/js-apis-commonEvent.md
+26
-21
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-commonEvent.md
浏览文件 @
5792198c
...
@@ -537,7 +537,7 @@ getCode(callback: AsyncCallback\<number>): void
...
@@ -537,7 +537,7 @@ getCode(callback: AsyncCallback\<number>): void
```
js
```
js
var
subscriber
;
//创建成功的订阅者对象
var
subscriber
;
//创建成功的订阅者对象
//
设置有序公共事件的结果数据
回调
//
获取有序公共事件的结果代码
回调
function
getCodeCallback
(
err
,
Code
)
{
function
getCodeCallback
(
err
,
Code
)
{
if
(
err
.
code
)
{
if
(
err
.
code
)
{
console
.
error
(
"
getCode failed
"
+
JSON
.
stringify
(
err
));
console
.
error
(
"
getCode failed
"
+
JSON
.
stringify
(
err
));
...
@@ -594,7 +594,7 @@ setCode(code: number, callback: AsyncCallback\<void>): void
...
@@ -594,7 +594,7 @@ setCode(code: number, callback: AsyncCallback\<void>): void
```
js
```
js
var
subscriber
;
//创建成功的订阅者对象
var
subscriber
;
//创建成功的订阅者对象
//设置有序公共事件的结果
数据
回调
//设置有序公共事件的结果
代码
回调
function
setCodeCallback
(
err
)
{
function
setCodeCallback
(
err
)
{
if
(
err
.
code
)
{
if
(
err
.
code
)
{
console
.
error
(
"
setCode failed
"
+
JSON
.
stringify
(
err
));
console
.
error
(
"
setCode failed
"
+
JSON
.
stringify
(
err
));
...
@@ -656,7 +656,7 @@ getData(callback: AsyncCallback\<string>): void
...
@@ -656,7 +656,7 @@ getData(callback: AsyncCallback\<string>): void
```
js
```
js
var
subscriber
;
//创建成功的订阅者对象
var
subscriber
;
//创建成功的订阅者对象
//
设置
有序公共事件的结果数据回调
//
获取
有序公共事件的结果数据回调
function
getDataCallback
(
err
,
Data
)
{
function
getDataCallback
(
err
,
Data
)
{
if
(
err
.
code
)
{
if
(
err
.
code
)
{
console
.
error
(
"
getData failed
"
+
JSON
.
stringify
(
err
));
console
.
error
(
"
getData failed
"
+
JSON
.
stringify
(
err
));
...
@@ -777,7 +777,7 @@ setCodeAndData(code: number, data: string, callback:AsyncCallback\<void>): void
...
@@ -777,7 +777,7 @@ setCodeAndData(code: number, data: string, callback:AsyncCallback\<void>): void
```
js
```
js
var
subscriber
;
//创建成功的订阅者对象
var
subscriber
;
//创建成功的订阅者对象
//设置有序公共事件的结果数据回调
//设置有序公共事件的结果
代码和结果
数据回调
function
setCodeDataCallback
(
err
)
{
function
setCodeDataCallback
(
err
)
{
if
(
err
.
code
)
{
if
(
err
.
code
)
{
console
.
error
(
"
setCodeAndData failed
"
+
JSON
.
stringify
(
err
));
console
.
error
(
"
setCodeAndData failed
"
+
JSON
.
stringify
(
err
));
...
@@ -842,7 +842,7 @@ isOrderedCommonEvent(callback: AsyncCallback\<boolean>): void
...
@@ -842,7 +842,7 @@ isOrderedCommonEvent(callback: AsyncCallback\<boolean>): void
```
js
```
js
var
subscriber
;
//创建成功的订阅者对象
var
subscriber
;
//创建成功的订阅者对象
//
设置有序公共事件的结果数据
回调
//
获取当前公共事件是否为有序事件的
回调
function
isOrderedCallback
(
err
,
isOrdered
)
{
function
isOrderedCallback
(
err
,
isOrdered
)
{
if
(
err
.
code
)
{
if
(
err
.
code
)
{
console
.
error
(
"
isOrderedCommonEvent failed
"
+
JSON
.
stringify
(
err
));
console
.
error
(
"
isOrderedCommonEvent failed
"
+
JSON
.
stringify
(
err
));
...
@@ -902,7 +902,7 @@ isStickyCommonEvent(callback: AsyncCallback\<boolean>): void
...
@@ -902,7 +902,7 @@ isStickyCommonEvent(callback: AsyncCallback\<boolean>): void
```
js
```
js
var
subscriber
;
//创建成功的订阅者对象
var
subscriber
;
//创建成功的订阅者对象
//
设置有序公共事件的结果数据
回调
//
获取当前公共事件是否为粘性事件的
回调
function
isStickyCallback
(
err
,
isSticky
)
{
function
isStickyCallback
(
err
,
isSticky
)
{
if
(
err
.
code
)
{
if
(
err
.
code
)
{
console
.
error
(
"
isStickyCommonEvent failed
"
+
JSON
.
stringify
(
err
));
console
.
error
(
"
isStickyCommonEvent failed
"
+
JSON
.
stringify
(
err
));
...
@@ -960,7 +960,7 @@ abortCommonEvent(callback: AsyncCallback\<void>): void
...
@@ -960,7 +960,7 @@ abortCommonEvent(callback: AsyncCallback\<void>): void
```
js
```
js
var
subscriber
;
//创建成功的订阅者对象
var
subscriber
;
//创建成功的订阅者对象
//
设置有序公共事件的结果数据
回调
//
取消当前有序公共事件的
回调
function
abortCallback
(
err
)
{
function
abortCallback
(
err
)
{
if
(
err
.
code
)
{
if
(
err
.
code
)
{
console
.
error
(
"
abortCommonEvent failed
"
+
JSON
.
stringify
(
err
));
console
.
error
(
"
abortCommonEvent failed
"
+
JSON
.
stringify
(
err
));
...
@@ -1016,7 +1016,7 @@ clearAbortCommonEvent(callback: AsyncCallback\<void>): void
...
@@ -1016,7 +1016,7 @@ clearAbortCommonEvent(callback: AsyncCallback\<void>): void
```
js
```
js
var
subscriber
;
//创建成功的订阅者对象
var
subscriber
;
//创建成功的订阅者对象
//
设置有序公共事件的结果数据
回调
//
清除当前公共事件取消状态的
回调
function
clearAbortCallback
(
err
)
{
function
clearAbortCallback
(
err
)
{
if
(
err
.
code
)
{
if
(
err
.
code
)
{
console
.
error
(
"
clearAbortCommonEvent failed
"
+
JSON
.
stringify
(
err
));
console
.
error
(
"
clearAbortCommonEvent failed
"
+
JSON
.
stringify
(
err
));
...
@@ -1072,7 +1072,7 @@ getAbortCommonEvent(callback: AsyncCallback\<boolean>): void
...
@@ -1072,7 +1072,7 @@ getAbortCommonEvent(callback: AsyncCallback\<boolean>): void
```
js
```
js
var
subscriber
;
//创建成功的订阅者对象
var
subscriber
;
//创建成功的订阅者对象
//
设置有序公共事件的结果数据
回调
//
获取当前有序公共事件是否取消的
回调
function
getAbortCallback
(
err
,
AbortCommonEvent
)
{
function
getAbortCallback
(
err
,
AbortCommonEvent
)
{
if
(
err
.
code
)
{
if
(
err
.
code
)
{
console
.
error
(
"
getAbortCommonEvent failed
"
+
JSON
.
stringify
(
err
));
console
.
error
(
"
getAbortCommonEvent failed
"
+
JSON
.
stringify
(
err
));
...
@@ -1128,7 +1128,7 @@ getSubscribeInfo(callback: AsyncCallback\<CommonEventSubscribeInfo>): void
...
@@ -1128,7 +1128,7 @@ getSubscribeInfo(callback: AsyncCallback\<CommonEventSubscribeInfo>): void
```
js
```
js
var
subscriber
;
//创建成功的订阅者对象
var
subscriber
;
//创建成功的订阅者对象
//
设置有序公共事件的结果数据
回调
//
获取订阅者信息
回调
function
getSubscribeInfoCallback
(
err
,
SubscribeInfo
)
{
function
getSubscribeInfoCallback
(
err
,
SubscribeInfo
)
{
if
(
err
.
code
)
{
if
(
err
.
code
)
{
console
.
error
(
"
getSubscribeInfo failed
"
+
JSON
.
stringify
(
err
));
console
.
error
(
"
getSubscribeInfo failed
"
+
JSON
.
stringify
(
err
));
...
@@ -1165,11 +1165,11 @@ subscriber.getSubscribeInfo().then((SubscribeInfo) => {
...
@@ -1165,11 +1165,11 @@ subscriber.getSubscribeInfo().then((SubscribeInfo) => {
});
});
```
```
### finishCommonEvent
### finishCommonEvent
<sup>9+</sup>
finishCommonEvent(callback: AsyncCallback
\<
void
\>
): void
finishCommonEvent(callback: AsyncCallback
\<
void
\>
): void
结束当前
已排序的
公共事件(callback形式)。
结束当前
有序
公共事件(callback形式)。
**系统能力**
:SystemCapability.Notification.CommonEvent
**系统能力**
:SystemCapability.Notification.CommonEvent
...
@@ -1177,25 +1177,29 @@ finishCommonEvent(callback: AsyncCallback\<void\>): void
...
@@ -1177,25 +1177,29 @@ finishCommonEvent(callback: AsyncCallback\<void\>): void
| 参数名 | 类型 | 必填 | 描述 |
| 参数名 | 类型 | 必填 | 描述 |
| -------- | -------------------- | ---- | -------------------------------- |
| -------- | -------------------- | ---- | -------------------------------- |
| callback | AsyncCallback
\<
void> | 是 | 表示
排序的
公共事件结束后的回调函数。 |
| callback | AsyncCallback
\<
void> | 是 | 表示
有序
公共事件结束后的回调函数。 |
**示例:**
**示例:**
```
js
```
js
var
subscriber
;
//创建成功的订阅者对象
var
subscriber
;
//创建成功的订阅者对象
//结束当前有序公共事件的回调
function
finishCommonEventCallback
()
{
function
finishCommonEventCallback
()
{
console
.
log
(
"
--------- finishCommonEventCallback ----------
"
);
if
(
err
.
code
)
{
console
.
error
(
"
finishCommonEvent failed
"
+
JSON
.
stringify
(
err
));
}
else
{
console
.
info
(
"
FinishCommonEvent
"
);
}
}
}
subscriber
.
finishCommonEvent
(
finishCommonEventCallback
);
subscriber
.
finishCommonEvent
(
finishCommonEventCallback
);
```
```
### finishCommonEvent
### finishCommonEvent
<sup>9+</sup>
finishCommonEvent(): Promise
\<
void
\>
finishCommonEvent(): Promise
\<
void
\>
结束当前
已排序的
公共事件(Promise形式)。
结束当前
有序
公共事件(Promise形式)。
**系统能力**
:SystemCapability.Notification.CommonEvent
**系统能力**
:SystemCapability.Notification.CommonEvent
...
@@ -1210,10 +1214,11 @@ finishCommonEvent(): Promise\<void\>
...
@@ -1210,10 +1214,11 @@ finishCommonEvent(): Promise\<void\>
```
js
```
js
var
subscriber
;
//创建成功的订阅者对象
var
subscriber
;
//创建成功的订阅者对象
subscriber
.
finishCommonEvent
()
subscriber
.
finishCommonEvent
().
then
(()
=>
{
.
then
(()
=>
{
console
.
info
(
"
FinishCommonEvent
"
);
console
.
info
(
"
--------- finishCommonEventCallback ----------
"
);
}).
catch
((
err
)
=>
{
})
console
.
error
(
"
finishCommonEvent failed
"
+
JSON
.
stringify
(
err
));
});
```
```
## CommonEventData
## CommonEventData
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录