• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.base (公共回调信息)
2
3本模块定义了OpenHarmony ArkTS接口的公共回调类型,包括接口调用时出现的公共回调和公共错误信息。
4
5> **说明:**
6>
7> 本模块首批接口从 API version 6 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8
9## 导入模块
10
11```
12import base from '@ohos.base';
13```
14
15## Callback
16
17Callback\<T> {
18
19(data: T): void;
20
21}
22
23通用回调函数。
24
25开发者在使用时,可自定义data的类型,回调将返回对应类型的信息。
26
27**系统能力**:SystemCapability.Base
28
29| 名称 | 类型 | 必填 | 说明                       |
30| ---- | ---- | ---- | -------------------------- |
31| data | T    | 是   | 接口调用时的公共回调信息。 |
32
33## ErrorCallback
34
35ErrorCallback\<T extends Error = BusinessError> {
36
37(err: T): void;
38
39}
40
41通用回调函数,携带错误参数。
42
43回调返回的信息为[BusinessError](#businesserror)类型的信息。
44
45**系统能力**:SystemCapability.Base
46
47**参数:**
48
49| 名称 | 类型 | 必填 | 说明                         |
50| ---- | ---- | ---- | ---------------------------- |
51| err  | T    | 是   | 接口调用失败的公共错误信息。 |
52
53## AsyncCallback
54
55AsyncCallback\<T, E = void> {
56
57(err: BusinessError\<E>, data: T): void;
58
59}
60
61通用回调函数,携带错误参数和异步返回值。
62
63错误参数为[BusinessError](#businesserror)类型的信息。
64
65异步返回值的类型由开发者自定义,回调将返回对应类型的信息。
66
67**系统能力**:SystemCapability.Base
68
69| 名称 | 类型                                                         | 必填 | 说明                         |
70| ---- | ------------------------------------------------------------ | ---- | ---------------------------- |
71| err  | [BusinessError](#businesserror) | 是   | 接口调用失败的公共错误信息。 |
72| data | T                                                            | 是   | 接口调用时的公共回调信息。   |
73
74## BusinessError
75
76BusinessError\<T = void> extends Error {
77
78code: number;
79
80data?: T;
81}
82
83错误参数。
84
85**系统能力**:SystemCapability.Base
86
87| 名称 | 类型   | 必填 | 说明                                                       |
88| ---- | ------ | ---- | ---------------------------------------------------------- |
89| code | number | 是   | 接口调用失败返回的错误码信息。                             |
90| data | T      | 否   | 接口调用时的公共回调信息。如果不填,则回调不返回相关信息。 |