js-apis-telephony-data.md 28.5 KB
Newer Older
Z
zengyawen 已提交
1
# @ohos.telephony.data (蜂窝数据)
2

C
clevercong 已提交
3 4
蜂窝数据提供了移动数据管理能力,包括获取、设置默认移动数据的SIM卡,获取蜂窝数据业务的上下行和分组交换域(PS域)的连接状态,以及检查蜂窝数据业务和漫游是否启用等。

Z
zengyawen 已提交
5
>**说明:**
6 7 8 9 10
>
>本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 

## 导入模块

Z
zengyawen 已提交
11
```js
12 13 14
import data from '@ohos.telephony.data';
```

C
clevercong 已提交
15
## data.getDefaultCellularDataSlotId
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30

getDefaultCellularDataSlotId(callback: AsyncCallback\<number\>): void 

获取默认移动数据的SIM卡,使用callback方式作为异步方法。 

**系统能力**:SystemCapability.Telephony.CellularData

**参数:**

| 参数名   | 类型                    | 必填 | 说明                                       |
| -------- | ----------------------- | ---- | ------------------------------------------ |
| callback | AsyncCallback\<number\> | 是   | 回调函数。<br />0:卡槽1。<br />1:卡槽2。 |

**示例:**

Z
zengyawen 已提交
31
```js
32 33 34 35 36
data.getDefaultCellularDataSlotId((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});
```

C
clevercong 已提交
37
## data.getDefaultCellularDataSlotId
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52

getDefaultCellularDataSlotId(): Promise\<number\> 

获取默认移动数据的SIM卡,使用Promise方式作为异步方法。 

**系统能力**:SystemCapability.Telephony.CellularData

**返回值:**

| 类型              | 说明                                                         |
| ----------------- | ------------------------------------------------------------ |
| Promise\<number\> | 以Promise形式返回获取默认移动数据的SIM卡。<br />0:卡槽1。<br />1:卡槽2。 |

**示例:**

Z
zengyawen 已提交
53
```js
54 55
let promise = data.getDefaultCellularDataSlotId();
promise.then((data) => {
Y
YOUR_NAME 已提交
56
    console.log(`getDefaultCellularDataSlotId success, promise: data->${JSON.stringify(data)}`);
57
}).catch((err) => {
Y
YOUR_NAME 已提交
58 59 60 61
    console.error(`getDefaultCellularDataSlotId fail, promise: err->${JSON.stringify(err)}`);
});
```

Y
YOUR_NAME 已提交
62
## data.getDefaultCellularDataSlotIdSync<sup>9+</sup>
D
dingxiaochen 已提交
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81

getDefaultCellularDataSlotIdSync(): number

获取默认移动数据的SIM卡

**系统能力**:SystemCapability.Telephony.CellularData

**返回值:**

| 类型              | 说明                                                         |
| ------ | -------------------------------------------------- |
| number | 获取默认移动数据的SIM卡。<br />0:卡槽1。<br />1:卡槽2。 |

**示例:**

```js
console.log("Result: "+ data.getDefaultCellularDataSlotIdSync())
```

Y
YOUR_NAME 已提交
82 83
## data.setDefaultCellularDataSlotId

D
dingxiaochen 已提交
84
setDefaultCellularDataSlotId(slotId: number, callback: AsyncCallback\<void\>): void 
Y
YOUR_NAME 已提交
85 86 87

设置默认移动数据的SIM卡,使用callback方式作为异步方法。 

D
dingxiaochen 已提交
88
**系统接口:** 此接口为系统接口。
C
clevercong 已提交
89

Y
YOUR_NAME 已提交
90 91 92 93 94 95 96 97 98
**需要权限**:ohos.permission.SET_TELEPHONY_STATE

**系统能力**:SystemCapability.Telephony.CellularData

**参数:**

| 参数名   | 类型                  | 必填 | 说明                                                         |
| -------- | --------------------- | ---- | ------------------------------------------------------------ |
| slotId   | number                | 是   | SIM卡槽ID。<br/>- 0:卡槽1。<br/>- 1:卡槽2。<br/>- -1:清除默认配置。 |
C
clevercong 已提交
99
| callback | AsyncCallback\<void\> | 是   | 回调函数。                                                   |
Y
YOUR_NAME 已提交
100

D
dingxiaochen 已提交
101 102
**错误码:**

S
SubmarinePhantom 已提交
103
以下错误码的详细介绍请参见[ohos.telephony(电话子系统)错误码](../../reference/errorcodes/errorcode-telephony.md)
D
dingxiaochen 已提交
104

D
dingxiaochen 已提交
105 106 107
| 错误码ID |                 错误信息                     |
| -------- | -------------------------------------------- |
| 201      | Permission denied.                           |
S
SubmarinePhantom 已提交
108
| 202      | Non-system applications use system APIs.     |
D
dingxiaochen 已提交
109 110 111 112 113 114 115 116
| 401      | Parameter error.                             |
| 8300001  | Invalid parameter value.                     |
| 8300002  | Operation failed. Cannot connect to service. |
| 8300003  | System internal error.                       |
| 8300004  | Do not have sim card.                        |
| 8300999  | Unknown error code.                          |
| 8301001  | SIM card is not activated.                   |

Y
YOUR_NAME 已提交
117 118 119
**示例:**

```js
D
dingxiaochen 已提交
120 121
data.setDefaultCellularDataSlotId(0, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}.`);
Y
YOUR_NAME 已提交
122 123 124 125 126 127 128 129 130
});
```

## data.setDefaultCellularDataSlotId

setDefaultCellularDataSlotId(slotId: number): Promise\<void\> 

设置默认移动数据的SIM卡,使用Promise方式作为异步方法。 

D
dingxiaochen 已提交
131
**系统接口:** 此接口为系统接口。
C
clevercong 已提交
132

Y
YOUR_NAME 已提交
133 134 135 136 137 138 139 140 141 142 143 144
**需要权限**:ohos.permission.SET_TELEPHONY_STATE

**系统能力**:SystemCapability.Telephony.CellularData

**参数:**

| 参数名 | 类型   | 必填 | 说明                                                         |
| ------ | ------ | ---- | ------------------------------------------------------------ |
| slotId | number | 是   | SIM卡槽ID。<br/>- 0:卡槽1。<br/>- 1:卡槽2。<br/>- -1:清除默认配置。 |

**返回值:**

C
clevercong 已提交
145 146 147
| 类型            | 说明                            |
| --------------- | ------------------------------- |
| Promise\<void\> | 以Promise形式异步返回设置结果。 |
Y
YOUR_NAME 已提交
148

D
dingxiaochen 已提交
149 150
**错误码:**

S
SubmarinePhantom 已提交
151
以下错误码的详细介绍请参见[ohos.telephony(电话子系统)错误码](../../reference/errorcodes/errorcode-telephony.md)
D
dingxiaochen 已提交
152

D
dingxiaochen 已提交
153 154 155
| 错误码ID |                 错误信息                     |
| -------- | -------------------------------------------- |
| 201      | Permission denied.                           |
S
SubmarinePhantom 已提交
156
| 202      | Non-system applications use system APIs.     |
D
dingxiaochen 已提交
157 158 159 160 161 162 163 164
| 401      | Parameter error.                             |
| 8300001  | Invalid parameter value.                     |
| 8300002  | Operation failed. Cannot connect to service. |
| 8300003  | System internal error.                       |
| 8300004  | Do not have sim card.                        |
| 8300999  | Unknown error code.                          |
| 8301001  | SIM card is not activated.                   |

Y
YOUR_NAME 已提交
165 166 167 168
**示例:**

```js
let promise = data.setDefaultCellularDataSlotId(0);
D
dingxiaochen 已提交
169 170
promise.then(() => {
    console.log(`setDefaultCellularDataSlotId success.`);
Y
YOUR_NAME 已提交
171 172
}).catch((err) => {
    console.error(`setDefaultCellularDataSlotId fail, promise: err->${JSON.stringify(err)}`);
173 174 175
});
```

C
clevercong 已提交
176
## data.getCellularDataFlowType
177 178 179 180 181 182 183 184 185 186 187

getCellularDataFlowType(callback: AsyncCallback\<DataFlowType\>): void

获取蜂窝数据业务的上下行状态,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Telephony.CellularData

**参数:**

| 参数名   | 类型                                           | 必填 | 说明       |
| -------- | ---------------------------------------------- | ---- | ---------- |
C
clevercong 已提交
188
| callback | AsyncCallback\<[DataFlowType](#dataflowtype)\> | 是   | 回调函数。 |
189 190 191

**示例:**

Z
zengyawen 已提交
192
```js
193 194 195 196 197
data.getCellularDataFlowType((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});
```

C
clevercong 已提交
198
## data.getCellularDataFlowType
199 200 201 202 203 204 205 206 207 208 209

getCellularDataFlowType(): Promise\<DataFlowType\>

获取蜂窝数据业务的上下行状态,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Telephony.CellularData

**返回值:**

| 类型                                     | 说明                                            |
| ---------------------------------------- | ----------------------------------------------- |
C
clevercong 已提交
210
| Promise\<[DataFlowType](#dataflowtype)\> | 以Promise形式返回获取蜂窝数据业务的上下行状态。 |
211 212 213

**示例:**

Z
zengyawen 已提交
214
```js
215 216 217 218 219 220 221 222
let promise = data.getCellularDataFlowType();
promise.then((data) => {
    console.log(`test success, promise: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`test fail, promise: err->${JSON.stringify(err)}`);
});
```

C
clevercong 已提交
223
## data.getCellularDataState
224 225 226 227 228 229 230 231 232 233 234

getCellularDataState(callback: AsyncCallback\<DataConnectState\>): void

获取分组交换域(PS域)的连接状态,使用callback方式作为异步方法。

**系统能力**:SystemCapability.Telephony.CellularData

**参数:**

| 参数名   | 类型                                                   | 必填 | 说明       |
| -------- | ------------------------------------------------------ | ---- | ---------- |
C
clevercong 已提交
235
| callback | AsyncCallback\<[DataConnectState](#dataconnectstate)\> | 是   | 回调函数。 |
236 237 238

**示例:**

Z
zengyawen 已提交
239
```js
240 241 242 243 244
data.getCellularDataState((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});
```

C
clevercong 已提交
245
## data.getCellularDataState
246 247 248 249 250 251 252 253 254 255 256

getCellularDataState(): Promise\<DataConnectState\>

获取分组交换域(PS域)的连接状态,使用Promise方式作为异步方法。

**系统能力**:SystemCapability.Telephony.CellularData

**返回值:**

| 类型                                             | 说明                                  |
| ------------------------------------------------ | ------------------------------------- |
C
clevercong 已提交
257
| Promise\<[DataConnectState](#dataconnectstate)\> | 以Promise形式返回获取PS域的连接状态。 |
258 259 260

**示例:**

Z
zengyawen 已提交
261
```js
262 263 264 265 266 267 268 269
let promise = data.getCellularDataState();
promise.then((data) => {
    console.log(`test success, promise: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`test fail, promise: err->${JSON.stringify(err)}`);
});
```

C
clevercong 已提交
270
## data.isCellularDataEnabled
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285

isCellularDataEnabled(callback: AsyncCallback\<boolean\>): void

检查蜂窝数据业务是否启用,使用callback方式作为异步方法。

**需要权限**:ohos.permission.GET_NETWORK_INFO

**系统能力**:SystemCapability.Telephony.CellularData

**参数:**

| 参数名   | 类型                     | 必填 | 说明                                                         |
| -------- | ------------------------ | ---- | ------------------------------------------------------------ |
| callback | AsyncCallback\<boolean\> | 是   | 回调函数。<br />true:蜂窝数据业务已启用。<br />false:蜂窝数据业务已禁用。 |

D
dingxiaochen 已提交
286 287
**错误码:**

S
SubmarinePhantom 已提交
288
以下错误码的详细介绍请参见[ohos.telephony(电话子系统)错误码](../../reference/errorcodes/errorcode-telephony.md)
D
dingxiaochen 已提交
289

D
dingxiaochen 已提交
290 291 292 293 294 295 296 297 298
| 错误码ID |                 错误信息                     |
| -------- | -------------------------------------------- |
| 201      | Permission denied.                           |
| 401      | Parameter error.                             |
| 8300001  | Invalid parameter value.                     |
| 8300002  | Operation failed. Cannot connect to service. |
| 8300003  | System internal error.                       |
| 8300999  | Unknown error code.                          |

299 300
**示例:**

Z
zengyawen 已提交
301
```js
302 303 304 305 306
data.isCellularDataEnabled((err, data) => {
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});
```

C
clevercong 已提交
307
## data.isCellularDataEnabled
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322

isCellularDataEnabled(): Promise\<boolean\>

检查蜂窝数据业务是否启用,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.GET_NETWORK_INFO

**系统能力**:SystemCapability.Telephony.CellularData

**返回值:**

| 类型               | 说明                                                         |
| ------------------ | ------------------------------------------------------------ |
| Promise\<boolean\> | 以Promise形式返回检查蜂窝数据业务是否启用。<br />true:蜂窝数据业务已启用。<br />false:蜂窝数据业务已禁用。 |

D
dingxiaochen 已提交
323 324
**错误码:**

S
SubmarinePhantom 已提交
325
以下错误码的详细介绍请参见[ohos.telephony(电话子系统)错误码](../../reference/errorcodes/errorcode-telephony.md)
D
dingxiaochen 已提交
326

D
dingxiaochen 已提交
327 328 329 330 331 332 333
| 错误码ID |                 错误信息                     |
| -------- | -------------------------------------------- |
| 201      | Permission denied.                           |
| 8300002  | Operation failed. Cannot connect to service. |
| 8300003  | System internal error.                       |
| 8300999  | Unknown error code.                          |

334 335
**示例:**

Z
zengyawen 已提交
336
```js
337 338 339 340 341 342 343 344
let promise = data.isCellularDataEnabled();
promise.then((data) => {
    console.log(`test success, promise: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`test fail, promise: err->${JSON.stringify(err)}`);
});
```

C
clevercong 已提交
345
## data.isCellularDataRoamingEnabled
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361

isCellularDataRoamingEnabled(slotId: number, callback: AsyncCallback\<boolean\>): void

检查蜂窝数据业务是否启用漫游,使用callback方式作为异步方法。

**需要权限**:ohos.permission.GET_NETWORK_INFO

**系统能力**:SystemCapability.Telephony.CellularData

**参数:**

| 参数名   | 类型                     | 必填 | 说明                                                         |
| -------- | ------------------------ | ---- | ------------------------------------------------------------ |
| slotId   | number                   | 是   | 卡槽ID。<br />0:卡槽1。<br />1:卡槽2。                     |
| callback | AsyncCallback\<boolean\> | 是   | 回调函数。<br />true:蜂窝数据业务已启用漫游。<br />false:蜂窝数据业务已禁用漫游。 |

D
dingxiaochen 已提交
362 363
**错误码:**

S
SubmarinePhantom 已提交
364
以下错误码的详细介绍请参见[ohos.telephony(电话子系统)错误码](../../reference/errorcodes/errorcode-telephony.md)
D
dingxiaochen 已提交
365

D
dingxiaochen 已提交
366 367 368 369 370 371 372 373 374
| 错误码ID |                  错误信息                    |
| -------- | -------------------------------------------- |
| 201      | Permission denied.                           |
| 401      | Parameter error.                             |
| 8300001  | Invalid parameter value.                     |
| 8300002  | Operation failed. Cannot connect to service. |
| 8300003  | System internal error.                       |
| 8300999  | Unknown error code.                          |

375 376
**示例:**

Z
zengyawen 已提交
377
```js
D
dingxiaochen 已提交
378
data.isCellularDataRoamingEnabled(0, (err, data) => {
379 380 381 382
    console.log(`callback: err->${JSON.stringify(err)}, data->${JSON.stringify(data)}`);
});
```

C
clevercong 已提交
383
## data.isCellularDataRoamingEnabled
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404

isCellularDataRoamingEnabled(slotId: number): Promise\<boolean\>

检查蜂窝数据业务是否启用漫游,使用Promise方式作为异步方法。

**需要权限**:ohos.permission.GET_NETWORK_INFO

**系统能力**:SystemCapability.Telephony.CellularData

**参数:**

| 参数名 | 类型   | 必填 | 说明                                     |
| ------ | ------ | ---- | ---------------------------------------- |
| slotId | number | 是   | 卡槽ID。<br />0:卡槽1。<br />1:卡槽2。 |

**返回值:**

| 类型               | 说明                                                         |
| ------------------ | ------------------------------------------------------------ |
| Promise\<boolean\> | 以Promise形式返回检查蜂窝数据业务是否启用漫游。<br />true:蜂窝数据业务已启用漫游。<br />false:蜂窝数据业务已禁用漫游。 |

D
dingxiaochen 已提交
405 406
**错误码:**

S
SubmarinePhantom 已提交
407
以下错误码的详细介绍请参见[ohos.telephony(电话子系统)错误码](../../reference/errorcodes/errorcode-telephony.md)
D
dingxiaochen 已提交
408

D
dingxiaochen 已提交
409 410 411 412 413 414 415 416 417
| 错误码ID |                  错误信息                    |
| -------- | -------------------------------------------- |
| 201      | Permission denied.                           |
| 401      | Parameter error.                             |
| 8300001  | Invalid parameter value.                     |
| 8300002  | Operation failed. Cannot connect to service. |
| 8300003  | System internal error.                       |
| 8300999  | Unknown error code.                          |

418 419
**示例:**

Z
zengyawen 已提交
420
```js
421 422 423 424 425 426 427 428
let promise = data.isCellularDataRoamingEnabled(0);
promise.then((data) => {
    console.log(`test success, promise: data->${JSON.stringify(data)}`);
}).catch((err) => {
    console.error(`test fail, promise: err->${JSON.stringify(err)}`);
});
```

C
clevercong 已提交
429 430
## data.enableCellularData

S
SubmarinePhantom 已提交
431
enableCellularData(callback: AsyncCallback\<void\>): void
C
clevercong 已提交
432 433 434

启用蜂窝数据服务,使用callback方式作为异步方法。

D
dingxiaochen 已提交
435
**系统接口:** 此接口为系统接口。
C
clevercong 已提交
436 437 438 439 440 441 442 443 444 445 446

**需要权限**:ohos.permission.SET_TELEPHONY_STATE

**系统能力**:SystemCapability.Telephony.CellularData

**参数:**

| 参数名   | 类型                  | 必填 | 说明       |
| -------- | --------------------- | ---- | ---------- |
| callback | AsyncCallback\<void\> | 是   | 回调函数。 |

D
dingxiaochen 已提交
447 448
**错误码:**

S
SubmarinePhantom 已提交
449
以下错误码的详细介绍请参见[ohos.telephony(电话子系统)错误码](../../reference/errorcodes/errorcode-telephony.md)
D
dingxiaochen 已提交
450

D
dingxiaochen 已提交
451 452 453
| 错误码ID |                  错误信息                    |
| -------- | -------------------------------------------- |
| 201      | Permission denied.                           |
S
SubmarinePhantom 已提交
454
| 202      | Non-system applications use system APIs.     |
D
dingxiaochen 已提交
455 456 457 458 459 460
| 401      | Parameter error.                             |
| 8300001  | Invalid parameter value.                     |
| 8300002  | Operation failed. Cannot connect to service. |
| 8300003  | System internal error.                       |
| 8300999  | Unknown error code.                          |

C
clevercong 已提交
461 462 463
**示例:**

```js
D
dingxiaochen 已提交
464 465
data.enableCellularData((err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
C
clevercong 已提交
466 467 468 469 470
});
```

## data.enableCellularData

S
SubmarinePhantom 已提交
471
enableCellularData(): Promise\<void\>
C
clevercong 已提交
472 473 474

启用蜂窝数据服务,使用Promise方式作为异步方法。

D
dingxiaochen 已提交
475
**系统接口:** 此接口为系统接口。
C
clevercong 已提交
476 477 478 479 480 481 482 483 484 485 486

**需要权限**:ohos.permission.SET_TELEPHONY_STATE

**系统能力**:SystemCapability.Telephony.CellularData

**返回值:**

| 类型            | 说明                    |
| --------------- | ----------------------- |
| Promise\<void\> | 以Promise形式返回结果。 |

D
dingxiaochen 已提交
487 488
**错误码:**

S
SubmarinePhantom 已提交
489
以下错误码的详细介绍请参见[ohos.telephony(电话子系统)错误码](../../reference/errorcodes/errorcode-telephony.md)
D
dingxiaochen 已提交
490

D
dingxiaochen 已提交
491 492 493
| 错误码ID |                  错误信息                    |
| -------- | -------------------------------------------- |
| 201      | Permission denied.                           |
S
SubmarinePhantom 已提交
494
| 202      | Non-system applications use system APIs.     |
D
dingxiaochen 已提交
495 496 497 498
| 8300002  | Operation failed. Cannot connect to service. |
| 8300003  | System internal error.                       |
| 8300999  | Unknown error code.                          |

C
clevercong 已提交
499 500 501 502
**示例:**

```js
let promise = data.enableCellularData();
D
dingxiaochen 已提交
503 504
promise.then(() => {
    console.log(`enableCellularData success.`);
C
clevercong 已提交
505 506 507 508 509 510 511
}).catch((err) => {
    console.error(`enableCellularData fail, promise: err->${JSON.stringify(err)}`);
});
```

## data.disableCellularData

S
SubmarinePhantom 已提交
512
disableCellularData(callback: AsyncCallback\<void\>): void
C
clevercong 已提交
513 514 515

禁用蜂窝数据服务,使用callback方式作为异步方法。

D
dingxiaochen 已提交
516
**系统接口:** 此接口为系统接口。
C
clevercong 已提交
517 518 519 520 521 522 523 524 525 526 527

**需要权限**:ohos.permission.SET_TELEPHONY_STATE

**系统能力**:SystemCapability.Telephony.CellularData

**参数:**

| 参数名   | 类型                  | 必填 | 说明       |
| -------- | --------------------- | ---- | ---------- |
| callback | AsyncCallback\<void\> | 是   | 回调函数。 |

D
dingxiaochen 已提交
528 529
**错误码:**

S
SubmarinePhantom 已提交
530
以下错误码的详细介绍请参见[ohos.telephony(电话子系统)错误码](../../reference/errorcodes/errorcode-telephony.md)
D
dingxiaochen 已提交
531

D
dingxiaochen 已提交
532 533 534
| 错误码ID |                  错误信息                    |
| -------- | -------------------------------------------- |
| 201      | Permission denied.                           |
S
SubmarinePhantom 已提交
535
| 202      | Non-system applications use system APIs.     |
D
dingxiaochen 已提交
536 537 538 539 540 541
| 401      | Parameter error.                             |
| 8300001  | Invalid parameter value.                     |
| 8300002  | Operation failed. Cannot connect to service. |
| 8300003  | System internal error.                       |
| 8300999  | Unknown error code.                          |

C
clevercong 已提交
542 543 544
**示例:**

```js
D
dingxiaochen 已提交
545 546
data.disableCellularData((err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
C
clevercong 已提交
547 548 549 550 551
});
```

## data.disableCellularData

S
SubmarinePhantom 已提交
552
disableCellularData(): Promise\<void\>
C
clevercong 已提交
553 554 555

禁用蜂窝数据服务,使用Promise方式作为异步方法。

D
dingxiaochen 已提交
556
**系统接口:** 此接口为系统接口。
C
clevercong 已提交
557 558 559 560 561 562 563 564 565 566 567

**需要权限**:ohos.permission.SET_TELEPHONY_STATE

**系统能力**:SystemCapability.Telephony.CellularData

**返回值:**

| 类型            | 说明                        |
| --------------- | --------------------------- |
| Promise\<void\> | 以Promise形式返回禁用结果。 |

D
dingxiaochen 已提交
568 569
**错误码:**

S
SubmarinePhantom 已提交
570
以下错误码的详细介绍请参见[ohos.telephony(电话子系统)错误码](../../reference/errorcodes/errorcode-telephony.md)
D
dingxiaochen 已提交
571

D
dingxiaochen 已提交
572 573 574
| 错误码ID |                  错误信息                    |
| -------- | -------------------------------------------- |
| 201      | Permission denied.                           |
S
SubmarinePhantom 已提交
575
| 202      | Non-system applications use system APIs.     |
D
dingxiaochen 已提交
576 577 578 579
| 8300002  | Operation failed. Cannot connect to service. |
| 8300003  | System internal error.                       |
| 8300999  | Unknown error code.                          |

C
clevercong 已提交
580 581 582 583
**示例:**

```js
let promise = data.disableCellularData();
D
dingxiaochen 已提交
584 585
promise.then(() => {
    console.log(`disableCellularData success.`);
C
clevercong 已提交
586 587 588 589 590 591 592
}).catch((err) => {
    console.error(`disableCellularData fail, promise: err->${JSON.stringify(err)}`);
});
```

## data.enableCellularDataRoaming

S
SubmarinePhantom 已提交
593
enableCellularDataRoaming(slotId: number, callback: AsyncCallback\<void\>): void
C
clevercong 已提交
594 595 596

启用蜂窝数据漫游,使用callback方式作为异步方法。

D
dingxiaochen 已提交
597
**系统接口:** 此接口为系统接口。
C
clevercong 已提交
598 599 600 601 602 603 604 605 606 607 608 609

**需要权限**:ohos.permission.SET_TELEPHONY_STATE

**系统能力**:SystemCapability.Telephony.CellularData

**参数:**

| 参数名   | 类型                  | 必填 | 说明                                     |
| -------- | --------------------- | ---- | ---------------------------------------- |
| slotId   | number                | 是   | 卡槽ID。<br />0:卡槽1。<br />1:卡槽2。 |
| callback | AsyncCallback\<void\> | 是   | 回调函数。                               |

D
dingxiaochen 已提交
610 611
**错误码:**

S
SubmarinePhantom 已提交
612
以下错误码的详细介绍请参见[ohos.telephony(电话子系统)错误码](../../reference/errorcodes/errorcode-telephony.md)
D
dingxiaochen 已提交
613

D
dingxiaochen 已提交
614 615 616
| 错误码ID |                  错误信息                    |
| -------- | -------------------------------------------- |
| 201      | Permission denied.                           |
S
SubmarinePhantom 已提交
617
| 202      | Non-system applications use system APIs.     |
D
dingxiaochen 已提交
618 619 620 621 622 623
| 401      | Parameter error.                             |
| 8300001  | Invalid parameter value.                     |
| 8300002  | Operation failed. Cannot connect to service. |
| 8300003  | System internal error.                       |
| 8300999  | Unknown error code.                          |

C
clevercong 已提交
624 625 626
**示例:**

```js
D
dingxiaochen 已提交
627 628
data.enableCellularDataRoaming(0, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
C
clevercong 已提交
629 630 631 632 633
});
```

## data.enableCellularDataRoaming

S
SubmarinePhantom 已提交
634
enableCellularDataRoaming(slotId: number): Promise\<void\>
C
clevercong 已提交
635 636 637

启用蜂窝数据漫游,使用Promise方式作为异步方法。

D
dingxiaochen 已提交
638
**系统接口:** 此接口为系统接口。
C
clevercong 已提交
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655

**需要权限**:ohos.permission.SET_TELEPHONY_STATE

**系统能力**:SystemCapability.Telephony.CellularData

**参数:**

| 参数名 | 类型   | 必填 | 说明                                     |
| ------ | ------ | ---- | ---------------------------------------- |
| slotId | number | 是   | 卡槽ID。<br />0:卡槽1。<br />1:卡槽2。 |

**返回值:**

| 类型            | 说明                      |
| --------------- | ------------------------- |
| Promise\<void\> | 以Promise形式返回启用结果 |

D
dingxiaochen 已提交
656 657
**错误码:**

S
SubmarinePhantom 已提交
658
以下错误码的详细介绍请参见[ohos.telephony(电话子系统)错误码](../../reference/errorcodes/errorcode-telephony.md)
D
dingxiaochen 已提交
659

D
dingxiaochen 已提交
660 661 662
| 错误码ID |                  错误信息                    |
| -------- | -------------------------------------------- |
| 201      | Permission denied.                           |
S
SubmarinePhantom 已提交
663
| 202      | Non-system applications use system APIs.     |
D
dingxiaochen 已提交
664 665 666 667 668 669
| 401      | Parameter error.                             |
| 8300001  | Invalid parameter value.                     |
| 8300002  | Operation failed. Cannot connect to service. |
| 8300003  | System internal error.                       |
| 8300999  | Unknown error code.                          |

C
clevercong 已提交
670 671 672 673
**示例:**

```js
let promise = data.enableCellularDataRoaming(0);
D
dingxiaochen 已提交
674 675
promise.then(() => {
    console.log(`enableCellularDataRoaming success.`);
C
clevercong 已提交
676 677 678 679 680 681 682
}).catch((err) => {
    console.error(`enableCellularDataRoaming fail, promise: err->${JSON.stringify(err)}`);
});
```

## data.disableCellularDataRoaming

S
SubmarinePhantom 已提交
683
disableCellularDataRoaming(slotId: number, callback: AsyncCallback\<void\>): void
C
clevercong 已提交
684 685 686

禁用蜂窝数据漫游,使用callback方式作为异步方法。

D
dingxiaochen 已提交
687
**系统接口:** 此接口为系统接口。
C
clevercong 已提交
688 689 690 691 692 693 694 695 696 697 698 699

**需要权限**:ohos.permission.SET_TELEPHONY_STATE

**系统能力**:SystemCapability.Telephony.CellularData

**参数:**

| 参数名   | 类型                  | 必填 | 说明                                     |
| -------- | --------------------- | ---- | ---------------------------------------- |
| slotId   | number                | 是   | 卡槽ID。<br />0:卡槽1。<br />1:卡槽2。 |
| callback | AsyncCallback\<void\> | 是   | 回调函数。                               |

D
dingxiaochen 已提交
700 701
**错误码:**

S
SubmarinePhantom 已提交
702
以下错误码的详细介绍请参见[ohos.telephony(电话子系统)错误码](../../reference/errorcodes/errorcode-telephony.md)
D
dingxiaochen 已提交
703

D
dingxiaochen 已提交
704 705 706
| 错误码ID |                  错误信息                    |
| -------- | -------------------------------------------- |
| 201      | Permission denied.                           |
S
SubmarinePhantom 已提交
707
| 202      | Non-system applications use system APIs.     |
D
dingxiaochen 已提交
708 709 710 711 712 713
| 401      | Parameter error.                             |
| 8300001  | Invalid parameter value.                     |
| 8300002  | Operation failed. Cannot connect to service. |
| 8300003  | System internal error.                       |
| 8300999  | Unknown error code.                          |

C
clevercong 已提交
714 715 716
**示例:**

```js
D
dingxiaochen 已提交
717 718
data.disableCellularDataRoaming(0, (err) => {
    console.log(`callback: err->${JSON.stringify(err)}`);
C
clevercong 已提交
719 720 721 722 723
});
```

## data.disableCellularDataRoaming

S
SubmarinePhantom 已提交
724
disableCellularDataRoaming(slotId: number): Promise\<void\>
C
clevercong 已提交
725 726 727

禁用蜂窝数据漫游,使用Promise方式作为异步方法。

D
dingxiaochen 已提交
728
**系统接口:** 此接口为系统接口。
C
clevercong 已提交
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745

**需要权限**:ohos.permission.SET_TELEPHONY_STATE

**系统能力**:SystemCapability.Telephony.CellularData

**参数:**

| 参数名 | 类型   | 必填 | 说明                                     |
| ------ | ------ | ---- | ---------------------------------------- |
| slotId | number | 是   | 卡槽ID。<br />0:卡槽1。<br />1:卡槽2。 |

**返回值:**

| 类型            | 说明                      |
| --------------- | ------------------------- |
| Promise\<void\> | 以Promise形式返回禁用结果 |

D
dingxiaochen 已提交
746 747
**错误码:**

S
SubmarinePhantom 已提交
748
以下错误码的详细介绍请参见[ohos.telephony(电话子系统)错误码](../../reference/errorcodes/errorcode-telephony.md)
D
dingxiaochen 已提交
749

D
dingxiaochen 已提交
750 751 752
| 错误码ID |                  错误信息                    |
| -------- | -------------------------------------------- |
| 201      | Permission denied.                           |
S
SubmarinePhantom 已提交
753
| 202      | Non-system applications use system APIs.     |
D
dingxiaochen 已提交
754 755 756 757 758 759
| 401      | Parameter error.                             |
| 8300001  | Invalid parameter value.                     |
| 8300002  | Operation failed. Cannot connect to service. |
| 8300003  | System internal error.                       |
| 8300999  | Unknown error code.                          |

C
clevercong 已提交
760 761 762 763
**示例:**

```js
let promise = data.disableCellularDataRoaming(0);
D
dingxiaochen 已提交
764 765
promise.then(() => {
    console.log(`disableCellularDataRoaming success.`);
C
clevercong 已提交
766 767 768 769 770
}).catch((err) => {
    console.error(`disableCellularDataRoaming fail, promise: err->${JSON.stringify(err)}`);
});
```

C
clevercong 已提交
771
## DataFlowType
772

C
clevercong 已提交
773
描述蜂窝数据流类型。 
774

Z
zengyawen 已提交
775
**系统能力**:SystemCapability.Telephony.CellularData
776

C
clevercong 已提交
777
| 名称                   | 值   | 说明                                       |
C
clevercong 已提交
778 779 780 781 782 783
| ---------------------- | ---- | ------------------------------------------ |
| DATA_FLOW_TYPE_NONE    | 0    | 表示没有上行或下行数据。                   |
| DATA_FLOW_TYPE_DOWN    | 1    | 表示只有下行数据。                         |
| DATA_FLOW_TYPE_UP      | 2    | 表示只有上行数据。                         |
| DATA_FLOW_TYPE_UP_DOWN | 3    | 表示有上下行数据。                         |
| DATA_FLOW_TYPE_DORMANT | 4    | 表示没有上下行数据,底层链路处于休眠状态。 |
784

C
clevercong 已提交
785
## DataConnectState
786

C
clevercong 已提交
787 788
描述蜂窝数据链路连接状态。 

Z
zengyawen 已提交
789
**系统能力**:SystemCapability.Telephony.CellularData
C
clevercong 已提交
790

C
clevercong 已提交
791
| 名称                    | 值   | 说明                       |
C
clevercong 已提交
792 793 794 795 796
| ----------------------- | ---- | -------------------------- |
| DATA_STATE_UNKNOWN      | -1   | 表示蜂窝数据链路未知。     |
| DATA_STATE_DISCONNECTED | 0    | 表示蜂窝数据链路断开。     |
| DATA_STATE_CONNECTING   | 1    | 表示正在连接蜂窝数据链路。 |
| DATA_STATE_CONNECTED    | 2    | 表示蜂窝数据链路已连接。   |
C
clevercong 已提交
797
| DATA_STATE_SUSPENDED    | 3    | 表示蜂窝数据链路被挂起。   |