1# # @ohos.net.sharing (Network Sharing) 2 3The Network Sharing module allows you to share your device's Internet connection with other connected devices by means of Wi-Fi hotspot, Bluetooth, and USB sharing. It also allows you to query the network sharing state and shared mobile data volume. 4 5> **NOTE** 6> 7> The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. 8 9## Modules to Import 10 11```js 12import sharing from '@ohos.net.sharing'; 13``` 14 15## sharing.isSharingSupported 16 17isSharingSupported(callback: AsyncCallback\<boolean>): void 18 19Checks whether network sharing is supported. This API uses an asynchronous callback to return the result. 20 21**System API**: This is a system API. 22 23**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 24 25**System capability**: SystemCapability.Communication.NetManager.NetSharing 26 27**Parameters** 28 29| Name | Type | Mandatory| Description | 30| -------- | ----------------------- | ---- | -------------------------------------- | 31| callback | AsyncCallback\<boolean> | Yes | Callback used to return the result. The value **true** means that network sharing is supported, and **false** means the opposite.| 32 33**Error codes** 34 35| ID| Error Message | 36| --------- | -------------------------------------------- | 37| 201 | Permission denied. | 38| 202 | Non-system applications use system APIs. | 39| 2200002 | Operation failed. Cannot connect to service. | 40| 2200003 | System internal error. | 41| 2202011 | Cannot get network sharing configuration. | 42 43**Example** 44 45```js 46import sharing from '@ohos.net.sharing'; 47import { BusinessError } from '@ohos.base'; 48 49sharing.isSharingSupported((error: BusinessError, data: boolean) => { 50 console.log(JSON.stringify(error)); 51 console.log(JSON.stringify(data)); 52}); 53``` 54 55## sharing.isSharingSupported 56 57isSharingSupported(): Promise\<boolean> 58 59Checks whether network sharing is supported. This API uses a promise to return the result. 60 61**System API**: This is a system API. 62 63**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 64 65**System capability**: SystemCapability.Communication.NetManager.NetSharing 66 67**Return value** 68 69| Type | Description | 70| ----------------- | ------------------------------------- | 71| Promise\<boolean> | Promise used to return the result. The value **true** means that network sharing is supported, and **false** means the opposite.| 72 73**Error codes** 74 75| ID| Error Message | 76| --------- | -------------------------------------------- | 77| 201 | Permission denied. | 78| 202 | Non-system applications use system APIs. | 79| 2200002 | Operation failed. Cannot connect to service. | 80| 2200003 | System internal error. | 81| 2202011 | Cannot get network sharing configuration. | 82 83**Example** 84 85```js 86import sharing from '@ohos.net.sharing'; 87import { BusinessError } from '@ohos.base'; 88 89sharing 90 .isSharingSupported() 91 .then((data: boolean) => { 92 console.log(JSON.stringify(data)); 93 }) 94 .catch((error: BusinessError) => { 95 console.log(JSON.stringify(error)); 96 }); 97``` 98 99## sharing.isSharing 100 101isSharing(callback: AsyncCallback\<boolean>): void 102 103Checks whether network sharing is in progress. This API uses an asynchronous callback to return the result. 104 105**System API**: This is a system API. 106 107**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 108 109**System capability**: SystemCapability.Communication.NetManager.NetSharing 110 111**Parameters** 112 113| Name | Type | Mandatory| Description | 114| -------- | ----------------------- | ---- | ------------------------------------ | 115| callback | AsyncCallback\<boolean> | Yes | Callback used to return the result. The value **true** means that network sharing is in progress, and **false** means the opposite.| 116 117**Error codes** 118 119| ID| Error Message | 120| --------- | -------------------------------------------- | 121| 201 | Permission denied. | 122| 202 | Non-system applications use system APIs. | 123| 2200002 | Operation failed. Cannot connect to service. | 124| 2200003 | System internal error. | 125| 2202011 | Cannot get network sharing configuration. | 126 127**Example** 128 129```js 130import sharing from '@ohos.net.sharing'; 131import { BusinessError } from '@ohos.base'; 132 133sharing.isSharing((error: BusinessError, data: boolean) => { 134 console.log(JSON.stringify(error)); 135 console.log(JSON.stringify(data)); 136}); 137``` 138 139## sharing.isSharing 140 141isSharing(): Promise\<boolean> 142 143Checks whether network sharing is in progress. This API uses a promise to return the result. 144 145**System API**: This is a system API. 146 147**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 148 149**System capability**: SystemCapability.Communication.NetManager.NetSharing 150 151**Return value** 152 153| Type | Description | 154| ----------------- | --------------------------------------------------------------- | 155| Promise\<boolean> | Promise used to return the result. The value **true** means that network sharing is in progress, and **false** means the opposite.| 156 157**Error codes** 158 159| ID| Error Message | 160| --------- | -------------------------------------------- | 161| 201 | Permission denied. | 162| 202 | Non-system applications use system APIs. | 163| 2200002 | Operation failed. Cannot connect to service. | 164| 2200003 | System internal error. | 165| 2202011 | Cannot get network sharing configuration. | 166 167**Example** 168 169```js 170import sharing from '@ohos.net.sharing'; 171import { BusinessError } from '@ohos.base'; 172 173sharing 174 .isSharing() 175 .then((data: boolean) => { 176 console.log(JSON.stringify(data)); 177 }) 178 .catch((error: BusinessError) => { 179 console.log(JSON.stringify(error)); 180 }); 181``` 182 183## sharing.startSharing 184 185startSharing(type: SharingIfaceType, callback: AsyncCallback\<void>): void 186 187Starts network sharing of a specified type. This API uses an asynchronous callback to return the result. 188 189**System API**: This is a system API. 190 191**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 192 193**System capability**: SystemCapability.Communication.NetManager.NetSharing 194 195**Parameters** 196 197| Name | Type | Mandatory| Description | 198| -------- | ------------------------------------- | ---- | ---------------------------------------- | 199| type | [SharingIfaceType](#sharingifacetype) | Yes | Sharing type. The value **0** means Wi-Fi hotspot sharing, **1** means USB sharing, and **2** means Bluetooth sharing.| 200| callback | AsyncCallback\<void> | Yes | Callback used to return the result. | 201 202**Error codes** 203 204| ID| Error Message | 205| --------- | -------------------------------------------- | 206| 201 | Permission denied. | 207| 202 | Non-system applications use system APIs. | 208| 401 | Parameter error. | 209| 2200001 | Invalid parameter value. | 210| 2200002 | Operation failed. Cannot connect to service. | 211| 2200003 | System internal error. | 212| 2202004 | Try to share an unavailable iface. | 213| 2202005 | WiFi sharing failed. | 214| 2202006 | Bluetooth sharing failed. | 215| 2202009 | Network share enable forwarding error. | 216| 2202011 | Cannot get network sharing configuration. | 217 218**Example** 219 220```js 221import sharing from '@ohos.net.sharing'; 222import { BusinessError } from '@ohos.base'; 223 224let SHARING_WIFI = 0; 225sharing.startSharing(SHARING_WIFI, (error: BusinessError) => { 226 console.log(JSON.stringify(error)); 227}); 228``` 229 230## sharing.startSharing 231 232startSharing(type: SharingIfaceType): Promise\<void> 233 234Starts network sharing of a specified type. This API uses a promise to return the result. 235 236**System API**: This is a system API. 237 238**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 239 240**System capability**: SystemCapability.Communication.NetManager.NetSharing 241 242**Parameters** 243 244| Name| Type | Mandatory| Description | 245| ------ | ------------------------------------- | ---- | ---------------------------------------- | 246| type | [SharingIfaceType](#sharingifacetype) | Yes | Sharing type. The value **0** means Wi-Fi hotspot sharing, **1** means USB sharing, and **2** means Bluetooth sharing.| 247 248**Return value** 249 250| Type | Description | 251| -------------- | ------------------------------------- | 252| Promise\<void> | Promise used to return the result.| 253 254**Error codes** 255 256| ID| Error Message | 257| --------- | -------------------------------------------- | 258| 202 | Non-system applications use system APIs. | 259| 201 | Permission denied. | 260| 401 | Parameter error. | 261| 2200001 | Invalid parameter value. | 262| 2200002 | Operation failed. Cannot connect to service. | 263| 2200003 | System internal error. | 264| 2202004 | Try to share an unavailable iface. | 265| 2202005 | WiFi sharing failed. | 266| 2202006 | Bluetooth sharing failed. | 267| 2202009 | Network share enable forwarding error. | 268| 2202011 | Cannot get network sharing configuration. | 269 270**Example** 271 272```js 273import sharing from '@ohos.net.sharing'; 274import { BusinessError } from '@ohos.base'; 275 276let SHARING_WIFI = 0; 277sharing 278 .startSharing(SHARING_WIFI) 279 .then(() => { 280 console.log('start wifi sharing successful'); 281 }) 282 .catch((error: BusinessError) => { 283 console.log('start wifi sharing failed'); 284 }); 285``` 286 287## sharing.stopSharing 288 289stopSharing(type: SharingIfaceType, callback: AsyncCallback\<void>): void 290 291Stops network sharing of a specified type. This API uses an asynchronous callback to return the result. 292 293**System API**: This is a system API. 294 295**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 296 297**System capability**: SystemCapability.Communication.NetManager.NetSharing 298 299**Parameters** 300 301| Name | Type | Mandatory| Description | 302| -------- | ------------------------------------- | ---- | ---------------------------------------- | 303| type | [SharingIfaceType](#sharingifacetype) | Yes | Sharing type. The value **0** means Wi-Fi hotspot sharing, **1** means USB sharing, and **2** means Bluetooth sharing.| 304| callback | AsyncCallback\<void> | Yes | Callback used to return the result. | 305 306**Error codes** 307 308| ID| Error Message | 309| --------- | -------------------------------------------- | 310| 201 | Permission denied. | 311| 202 | Non-system applications use system APIs. | 312| 401 | Parameter error. | 313| 2200001 | Invalid parameter value. | 314| 2200002 | Operation failed. Cannot connect to service. | 315| 2200003 | System internal error. | 316| 2202004 | Try to share an unavailable iface. | 317| 2202005 | WiFi sharing failed. | 318| 2202006 | Bluetooth sharing failed. | 319| 2202011 | Cannot get network sharing configuration. | 320 321**Example** 322 323```js 324import sharing from '@ohos.net.sharing'; 325import { BusinessError } from '@ohos.base'; 326 327let SHARING_WIFI = 0; 328sharing.stopSharing(SHARING_WIFI, (error: BusinessError) => { 329 console.log(JSON.stringify(error)); 330}); 331``` 332 333## sharing.stopSharing 334 335stopSharing(type: SharingIfaceType): Promise\<void> 336 337Stops network sharing of a specified type. This API uses a promise to return the result. 338 339**System API**: This is a system API. 340 341**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 342 343**System capability**: SystemCapability.Communication.NetManager.NetSharing 344 345**Parameters** 346 347| Name| Type | Mandatory| Description | 348| ------ | ------------------------------------- | ---- | ---------------------------------------- | 349| type | [SharingIfaceType](#sharingifacetype) | Yes | Sharing type. The value **0** means Wi-Fi hotspot sharing, **1** means USB sharing, and **2** means Bluetooth sharing.| 350 351**Return value** 352 353| Type | Description | 354| -------------- | ------------------------------------- | 355| Promise\<void> | Promise used to return the result.| 356 357**Error codes** 358 359| ID| Error Message | 360| --------- | -------------------------------------------- | 361| 201 | Permission denied. | 362| 202 | Non-system applications use system APIs. | 363| 401 | Parameter error. | 364| 2200001 | Invalid parameter value. | 365| 2200002 | Operation failed. Cannot connect to service. | 366| 2200003 | System internal error. | 367| 2202004 | Try to share an unavailable iface. | 368| 2202005 | WiFi sharing failed. | 369| 2202006 | Bluetooth sharing failed. | 370| 2202011 | Cannot get network sharing configuration. | 371 372**Example** 373 374```js 375import sharing from '@ohos.net.sharing'; 376import { BusinessError } from '@ohos.base'; 377 378let SHARING_WIFI = 0; 379sharing 380 .stopSharing(SHARING_WIFI) 381 .then(() => { 382 console.log('stop wifi sharing successful'); 383 }) 384 .catch((error: BusinessError) => { 385 console.log('stop wifi sharing failed'); 386 }); 387``` 388 389## sharing.getStatsRxBytes 390 391getStatsRxBytes(callback: AsyncCallback\<number>): void 392 393Obtains the volume of mobile data traffic received via network sharing. This API uses an asynchronous callback to return the result. 394 395**System API**: This is a system API. 396 397**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 398 399**System capability**: SystemCapability.Communication.NetManager.NetSharing 400 401**Parameters** 402 403| Name | Type | Mandatory| Description | 404| -------- | ---------------------- | ---- | --------------------------------------- | 405| callback | AsyncCallback\<number> | Yes | Callback used to return the data volume, in KB.| 406 407**Error codes** 408 409| ID| Error Message | 410| --------- | -------------------------------------------- | 411| 201 | Permission denied. | 412| 202 | Non-system applications use system APIs. | 413| 401 | Parameter error. | 414| 2200002 | Operation failed. Cannot connect to service. | 415| 2200003 | System internal error. | 416 417**Example** 418 419```js 420import sharing from '@ohos.net.sharing'; 421import { BusinessError } from '@ohos.base'; 422 423sharing.getStatsRxBytes((error: BusinessError, data: number) => { 424 console.log(JSON.stringify(error)); 425 console.log(JSON.stringify(data)); 426}); 427``` 428 429## sharing.getStatsRxBytes 430 431getStatsRxBytes(): Promise\<number> 432 433Obtains the volume of mobile data traffic received via network sharing. This API uses a promise to return the result. 434 435**System API**: This is a system API. 436 437**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 438 439**System capability**: SystemCapability.Communication.NetManager.NetSharing 440 441**Return value** 442 443| Type | Description | 444| ---------------- | ------------------------------------------------- | 445| Promise\<number> | Promise used to return the data volume, in KB.| 446 447**Error codes** 448 449| ID| Error Message | 450| --------- | -------------------------------------------- | 451| 201 | Permission denied. | 452| 202 | Non-system applications use system APIs. | 453| 401 | Parameter error. | 454| 2200002 | Operation failed. Cannot connect to service. | 455| 2200003 | System internal error. | 456 457**Example** 458 459```js 460import sharing from '@ohos.net.sharing'; 461import { BusinessError } from '@ohos.base'; 462 463sharing 464 .getStatsRxBytes() 465 .then((data: number) => { 466 console.log(JSON.stringify(data)); 467 }) 468 .catch((error: BusinessError) => { 469 console.log(JSON.stringify(error)); 470 }); 471``` 472 473## sharing.getStatsTxBytes 474 475getStatsTxBytes(callback: AsyncCallback\<number>): void 476 477Obtains the volume of mobile data traffic sent via network sharing. This API uses an asynchronous callback to return the result. 478 479**System API**: This is a system API. 480 481**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 482 483**System capability**: SystemCapability.Communication.NetManager.NetSharing 484 485**Parameters** 486 487| Name | Type | Mandatory| Description | 488| -------- | ---------------------- | ---- | --------------------------------------- | 489| callback | AsyncCallback\<number> | Yes | Callback used to return the data volume, in KB.| 490 491**Error codes** 492 493| ID| Error Message | 494| --------- | -------------------------------------------- | 495| 201 | Permission denied. | 496| 202 | Non-system applications use system APIs. | 497| 401 | Parameter error. | 498| 2200002 | Operation failed. Cannot connect to service. | 499| 2200003 | System internal error. | 500 501**Example** 502 503```js 504import sharing from '@ohos.net.sharing'; 505import { BusinessError } from '@ohos.base'; 506 507sharing.getStatsTxBytes((error: BusinessError, data: number) => { 508 console.log(JSON.stringify(error)); 509 console.log(JSON.stringify(data)); 510}); 511``` 512 513## sharing.getStatsTxBytes 514 515getStatsTxBytes(): Promise\<number> 516 517Obtains the volume of mobile data traffic sent via network sharing. This API uses a promise to return the result. 518 519**System API**: This is a system API. 520 521**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 522 523**System capability**: SystemCapability.Communication.NetManager.NetSharing 524 525**Return value** 526 527| Type | Description | 528| ---------------- | ------------------------------------------------- | 529| Promise\<number> | Promise used to return the data volume, in KB.| 530 531**Error codes** 532 533| ID| Error Message | 534| --------- | -------------------------------------------- | 535| 201 | Permission denied. | 536| 202 | Non-system applications use system APIs. | 537| 401 | Parameter error. | 538| 2200002 | Operation failed. Cannot connect to service. | 539| 2200003 | System internal error. | 540 541**Example** 542 543```js 544import sharing from '@ohos.net.sharing'; 545import { BusinessError } from '@ohos.base'; 546 547sharing 548 .getStatsTxBytes() 549 .then((data: number) => { 550 console.log(JSON.stringify(data)); 551 }) 552 .catch((error: BusinessError) => { 553 console.log(JSON.stringify(error)); 554 }); 555``` 556 557## sharing.getStatsTotalBytes 558 559getStatsTotalBytes(callback: AsyncCallback\<number>): void 560 561Obtains the volume of mobile data traffic sent and received via network sharing. This API uses an asynchronous callback to return the result. 562 563**System API**: This is a system API. 564 565**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 566 567**System capability**: SystemCapability.Communication.NetManager.NetSharing 568 569**Parameters** 570 571| Name | Type | Mandatory| Description | 572| -------- | ---------------------- | ---- | --------------------------------------- | 573| callback | AsyncCallback\<number> | Yes | Callback used to return the data volume, in KB.| 574 575**Error codes** 576 577| ID| Error Message | 578| --------- | -------------------------------------------- | 579| 201 | Permission denied. | 580| 202 | Non-system applications use system APIs. | 581| 401 | Parameter error. | 582| 2200002 | Operation failed. Cannot connect to service. | 583| 2200003 | System internal error. | 584 585**Example** 586 587```js 588import sharing from '@ohos.net.sharing'; 589import { BusinessError } from '@ohos.base'; 590 591sharing.getStatsTotalBytes((error: BusinessError, data: number) => { 592 console.log(JSON.stringify(error)); 593 console.log(JSON.stringify(data)); 594}); 595``` 596 597## sharing.getStatsTotalBytes 598 599getStatsTotalBytes(): Promise\<number> 600 601Obtains the volume of mobile data traffic sent and received via network sharing. This API uses a promise to return the result. 602 603**System API**: This is a system API. 604 605**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 606 607**System capability**: SystemCapability.Communication.NetManager.NetSharing 608 609**Return value** 610 611| Type | Description | 612| ---------------- | ----------------------------------------------- | 613| Promise\<number> | Promise used to return the data volume, in KB.| 614 615**Error codes** 616 617| ID| Error Message | 618| --------- | -------------------------------------------- | 619| 201 | Permission denied. | 620| 202 | Non-system applications use system APIs. | 621| 401 | Parameter error. | 622| 2200002 | Operation failed. Cannot connect to service. | 623| 2200003 | System internal error. | 624 625**Example** 626 627```js 628import sharing from '@ohos.net.sharing'; 629import { BusinessError } from '@ohos.base'; 630 631sharing 632 .getStatsTotalBytes() 633 .then((data: number) => { 634 console.log(JSON.stringify(data)); 635 }) 636 .catch((error: BusinessError) => { 637 console.log(JSON.stringify(error)); 638 }); 639``` 640 641## sharing.getSharingIfaces 642 643getSharingIfaces(state: SharingIfaceState, callback: AsyncCallback\<Array\<string>>): void 644 645Obtains the names of NICs in the specified network sharing state. This API uses an asynchronous callback to return the result. 646 647**System API**: This is a system API. 648 649**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 650 651**System capability**: SystemCapability.Communication.NetManager.NetSharing 652 653**Parameters** 654 655| Name | Type | Mandatory| Description | 656| -------- | --------------------------------------- | ---- | -------------------------------------- | 657| state | [SharingIfaceState](#sharingifacestate) | Yes | Network sharing state. | 658| callback | AsyncCallback\<Array\<string>> | Yes | Callback used to return an array of NIC names.| 659 660**Error codes** 661 662| ID| Error Message | 663| --------- | -------------------------------------------- | 664| 201 | Permission denied. | 665| 202 | Non-system applications use system APIs. | 666| 401 | Parameter error. | 667| 2200001 | Invalid parameter value. | 668| 2200002 | Operation failed. Cannot connect to service. | 669| 2200003 | System internal error. | 670 671**Example** 672 673```js 674import sharing from '@ohos.net.sharing'; 675import { BusinessError } from '@ohos.base'; 676 677let SHARING_BLUETOOTH = 2; 678sharing.getSharingIfaces(SHARING_BLUETOOTH, (error: BusinessError, data: string[]) => { 679 console.log(JSON.stringify(error)); 680 console.log(JSON.stringify(data)); 681}); 682``` 683 684## sharing.getSharingIfaces 685 686getSharingIfaces(state: SharingIfaceState): Promise\<Array\<string>> 687 688Obtains the names of NICs in the specified network sharing state. This API uses a promise to return the result. 689 690**System API**: This is a system API. 691 692**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 693 694**System capability**: SystemCapability.Communication.NetManager.NetSharing 695 696**Parameters** 697 698| Name| Type | Mandatory| Description | 699| ------ | --------------------------------------- | ---- | -------------- | 700| state | [SharingIfaceState](#sharingifacestate) | Yes | Network sharing state.| 701 702**Return value** 703 704| Type | Description | 705| ------------------------ | ----------------------------------------- | 706| Promise\<Array\<string>> | Promise used to return an array of NIC names.| 707 708**Error codes** 709 710| ID| Error Message | 711| --------- | -------------------------------------------- | 712| 201 | Permission denied. | 713| 202 | Non-system applications use system APIs. | 714| 401 | Parameter error. | 715| 2200001 | Invalid parameter value. | 716| 2200002 | Operation failed. Cannot connect to service. | 717| 2200003 | System internal error. | 718 719**Example** 720 721```js 722import sharing from '@ohos.net.sharing'; 723import { BusinessError } from '@ohos.base'; 724 725let SHARING_BLUETOOTH = 2; 726sharing 727 .getSharingIfaces(SHARING_BLUETOOTH) 728 .then((data: string[]) => { 729 console.log(JSON.stringify(data)); 730 }) 731 .catch((error: BusinessError) => { 732 console.log(JSON.stringify(error)); 733 }); 734``` 735 736## sharing.getSharingState 737 738getSharingState(type: SharingIfaceType, callback: AsyncCallback\<SharingIfaceState\>): void 739 740Obtains the network sharing state of the specified type. This API uses an asynchronous callback to return the result. 741 742**System API**: This is a system API. 743 744**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 745 746**System capability**: SystemCapability.Communication.NetManager.NetSharing 747 748**Parameters** 749 750| Name | Type | Mandatory| Description | 751| -------- | ------------------------------------------------------- | ---- | ---------------------------------------- | 752| type | [SharingIfaceType](#sharingifacetype) | Yes | Sharing type. The value **0** means Wi-Fi hotspot sharing, **1** means USB sharing, and **2** means Bluetooth sharing.| 753| callback | AsyncCallback\<[SharingIfaceState](#sharingifacestate)> | Yes | Callback used to return the network sharing state. | 754 755**Error codes** 756 757| ID| Error Message | 758| --------- | -------------------------------------------- | 759| 201 | Permission denied. | 760| 202 | Non-system applications use system APIs. | 761| 401 | Parameter error. | 762| 2200001 | Invalid parameter value. | 763| 2200002 | Operation failed. Cannot connect to service. | 764| 2200003 | System internal error. | 765 766**Example** 767 768```js 769import sharing from '@ohos.net.sharing'; 770import { BusinessError } from '@ohos.base'; 771 772let SHARING_WIFI = 0; 773sharing.getSharingState(SHARING_WIFI, (error: BusinessError, data: sharing.SharingIfaceState) => { 774 console.log(JSON.stringify(error)); 775 console.log(JSON.stringify(data)); 776}); 777``` 778 779## sharing.getSharingState 780 781getSharingState(type: SharingIfaceType): Promise\<SharingIfaceState\> 782 783Obtains the network sharing state of the specified type. This API uses a promise to return the result. 784 785**System API**: This is a system API. 786 787**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 788 789**System capability**: SystemCapability.Communication.NetManager.NetSharing 790 791**Parameters** 792 793| Name| Type | Mandatory| Description | 794| ------ | ------------------------------------- | ---- | ---------------------------------------- | 795| type | [SharingIfaceType](#sharingifacetype) | Yes | Sharing type. The value **0** means Wi-Fi hotspot sharing, **1** means USB sharing, and **2** means Bluetooth sharing.| 796 797**Error codes** 798 799| ID| Error Message | 800| --------- | -------------------------------------------- | 801| 201 | Permission denied. | 802| 202 | Non-system applications use system APIs. | 803| 401 | Parameter error. | 804| 2200001 | Invalid parameter value. | 805| 2200002 | Operation failed. Cannot connect to service. | 806| 2200003 | System internal error. | 807 808**Return value** 809 810| Type | Description | 811| ------------------------------------------------- | ----------------------------------------- | 812| Promise\<[SharingIfaceState](#sharingifacestate)> | Promise used to return the network sharing state.| 813 814**Example** 815 816```js 817import sharing from '@ohos.net.sharing'; 818import { BusinessError } from '@ohos.base'; 819 820let SHARING_WIFI = 0; 821sharing 822 .getSharingState(SHARING_WIFI) 823 .then((data: sharing.SharingIfaceState) => { 824 console.log(JSON.stringify(data)); 825 }) 826 .catch((error: BusinessError) => { 827 console.log(JSON.stringify(error)); 828 }); 829``` 830 831## sharing.getSharableRegexes 832 833getSharableRegexes(type: SharingIfaceType, callback: AsyncCallback\<Array\<string\>\>): void 834 835Obtains regular expressions of NICs of a specified type. This API uses an asynchronous callback to return the result. 836 837**System API**: This is a system API. 838 839**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 840 841**System capability**: SystemCapability.Communication.NetManager.NetSharing 842 843**Parameters** 844 845| Name | Type | Mandatory| Description | 846| -------- | ------------------------------------- | ---- | ---------------------------------------------- | 847| type | [SharingIfaceType](#sharingifacetype) | Yes | Sharing type. The value **0** means Wi-Fi hotspot sharing, **1** means USB sharing, and **2** means Bluetooth sharing. | 848| callback | AsyncCallback\<Array\<string>> | Yes | Callback used to return an array of regular expressions.| 849 850**Error codes** 851 852| ID| Error Message | 853| --------- | -------------------------------------------- | 854| 201 | Permission denied. | 855| 202 | Non-system applications use system APIs. | 856| 401 | Parameter error. | 857| 2200001 | Invalid parameter value. | 858| 2200002 | Operation failed. Cannot connect to service. | 859| 2200003 | System internal error. | 860 861**Example** 862 863```js 864import sharing from '@ohos.net.sharing'; 865import { BusinessError } from '@ohos.base'; 866 867let SHARING_WIFI = 0; 868sharing.getSharableRegexes(SHARING_WIFI, (error: BusinessError, data: string[]) => { 869 console.log(JSON.stringify(error)); 870 console.log(JSON.stringify(data)); 871}); 872``` 873 874## sharing.getSharableRegexes 875 876getSharableRegexes(type: SharingIfaceType): Promise\<Array\<string>> 877 878Obtains regular expressions of NICs of a specified type. This API uses a promise to return the result. 879 880**System API**: This is a system API. 881 882**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 883 884**System capability**: SystemCapability.Communication.NetManager.NetSharing 885 886**Parameters** 887 888| Name| Type | Mandatory| Description | 889| ------ | ------------------------------------- | ---- | ---------------------------------------- | 890| type | [SharingIfaceType](#sharingifacetype) | Yes | Sharing type. The value **0** means Wi-Fi hotspot sharing, **1** means USB sharing, and **2** means Bluetooth sharing.| 891 892**Return value** 893 894| Type | Description | 895| ------------------------ | ----------------------------------- | 896| Promise\<Array\<string>> | Promise used to return an array of regular expressions.| 897 898**Error codes** 899 900| ID| Error Message | 901| --------- | -------------------------------------------- | 902| 201 | Permission denied. | 903| 202 | Non-system applications use system APIs. | 904| 401 | Parameter error. | 905| 2200001 | Invalid parameter value. | 906| 2200002 | Operation failed. Cannot connect to service. | 907| 2200003 | System internal error. | 908 909**Example** 910 911```js 912import sharing from '@ohos.net.sharing'; 913import { BusinessError } from '@ohos.base'; 914 915let SHARING_WIFI = 0; 916sharing 917 .getSharableRegexes(SHARING_WIFI) 918 .then((data: string[]) => { 919 console.log(JSON.stringify(data)); 920 }) 921 .catch((error: BusinessError) => { 922 console.log(JSON.stringify(error)); 923 }); 924``` 925 926## sharing.on('sharingStateChange') 927 928on(type: 'sharingStateChange', callback: Callback\<boolean>): void 929 930Subscribes to network sharing state changes. This API uses an asynchronous callback to return the result. 931 932**System API**: This is a system API. 933 934**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 935 936**System capability**: SystemCapability.Communication.NetManager.NetSharing 937 938**Parameters** 939 940| Name | Type | Mandatory| Description | 941| -------- | ----------------------- | ---- | ---------------------------- | 942| type | string | Yes | Event name. | 943| callback | AsyncCallback\<boolean> | Yes | Callback invoked when the network sharing state changes.| 944 945**Error codes** 946 947| ID| Error Message | 948| --------- | ---------------------------------------- | 949| 201 | Permission denied. | 950| 202 | Non-system applications use system APIs. | 951| 401 | Parameter error. | 952 953**Example** 954 955```js 956import sharing from '@ohos.net.sharing'; 957 958sharing.on('sharingStateChange', (data: boolean) => { 959 console.log('on sharingStateChange: ' + JSON.stringify(data)); 960}); 961``` 962 963## sharing.off('sharingStateChange') 964 965off(type: 'sharingStateChange', callback?: Callback\<boolean>): void 966 967Unsubscribes from network sharing state changes. This API uses an asynchronous callback to return the result. 968 969**System API**: This is a system API. 970 971**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 972 973**System capability**: SystemCapability.Communication.NetManager.NetSharing 974 975**Parameters** 976 977| Name | Type | Mandatory| Description | 978| -------- | ----------------------- | ---- | ---------------------------- | 979| type | string | Yes | Event name. | 980| callback | AsyncCallback\<boolean> | No | Callback invoked when the network sharing state changes.| 981 982**Error codes** 983 984| ID| Error Message | 985| --------- | ---------------------------------------- | 986| 201 | Permission denied. | 987| 202 | Non-system applications use system APIs. | 988| 401 | Parameter error. | 989 990**Example** 991 992```js 993import sharing from '@ohos.net.sharing'; 994 995sharing.off('sharingStateChange', (data: boolean) => { 996 console.log(JSON.stringify(data)); 997}); 998``` 999 1000## sharing.on('interfaceSharingStateChange') 1001 1002on(type: 'interfaceSharingStateChange', callback: Callback\<InterfaceSharingStateInfo\>): void 1003 1004Subscribes to network sharing state changes of a specified NIC. This API uses an asynchronous callback to return the result. 1005 1006**System API**: This is a system API. 1007 1008**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 1009 1010**System capability**: SystemCapability.Communication.NetManager.NetSharing 1011 1012**Parameters** 1013 1014| Name | Type | Mandatory| Description | 1015| -------- | -------------------------------------------------------------------- | ---- | ------------------------------------- | 1016| type | string | Yes | Event name. | 1017| callback | AsyncCallback\<[InterfaceSharingStateInfo](#interfacesharingstateinfo11)> | Yes | Callback used to return the result. It is called when the network sharing state of a specified NIC changes.| 1018 1019**Error codes** 1020 1021| ID| Error Message | 1022| --------- | ---------------------------------------- | 1023| 201 | Permission denied. | 1024| 202 | Non-system applications use system APIs. | 1025| 401 | Parameter error. | 1026 1027**Example** 1028 1029```js 1030import sharing from '@ohos.net.sharing'; 1031 1032sharing.on('interfaceSharingStateChange', (data: object) => { 1033 console.log('on interfaceSharingStateChange:' + JSON.stringify(data)); 1034}); 1035``` 1036 1037## sharing.off('interfaceSharingStateChange') 1038 1039off(type: 'interfaceSharingStateChange', callback?: Callback\<InterfaceSharingStateInfo\>): void 1040 1041Unsubscribes from network sharing status changes of a specified NIC. This API uses an asynchronous callback to return the result. 1042 1043**System API**: This is a system API. 1044 1045**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 1046 1047**System capability**: SystemCapability.Communication.NetManager.NetSharing 1048 1049**Parameters** 1050 1051| Name | Type | Mandatory| Description | 1052| -------- | --------------------------------------------------------------------------- | ---- | ---------------------------------------- | 1053| type | string | Yes | Event name. | 1054| callback | AsyncCallback\<[InterfaceSharingStateInfo](#interfacesharingstateinfo11)> | No | Callback used to return the result.| 1055 1056**Error codes** 1057 1058| ID| Error Message | 1059| --------- | ---------------------------------------- | 1060| 201 | Permission denied. | 1061| 202 | Non-system applications use system APIs. | 1062| 401 | Parameter error. | 1063 1064**Example** 1065 1066```js 1067import sharing from '@ohos.net.sharing'; 1068 1069sharing.off('interfaceSharingStateChange', (data: object) => { 1070 console.log(JSON.stringify(data)); 1071}); 1072``` 1073 1074## sharing.on('sharingUpstreamChange') 1075 1076on(type: 'sharingUpstreamChange', callback: Callback\<NetHandle>): void 1077 1078Subscribes to upstream network changes. This API uses an asynchronous callback to return the result. 1079 1080**System API**: This is a system API. 1081 1082**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 1083 1084**System capability**: SystemCapability.Communication.NetManager.NetSharing 1085 1086**Parameters** 1087 1088| Name | Type | Mandatory| Description | 1089| -------- | ------------------------- | ---- | ------------------------------ | 1090| type | string | Yes | Event name. | 1091| callback | AsyncCallback\<NetHandle> | Yes | Callback invoked when the upstream network changes.| 1092 1093**Error codes** 1094 1095| ID| Error Message | 1096| --------- | ---------------------------------------- | 1097| 201 | Permission denied. | 1098| 202 | Non-system applications use system APIs. | 1099| 401 | Parameter error. | 1100 1101**Example** 1102 1103```js 1104import sharing from '@ohos.net.sharing'; 1105 1106sharing.on('sharingUpstreamChange', (data: object) => { 1107 console.log('on sharingUpstreamChange:' + JSON.stringify(data)); 1108}); 1109``` 1110 1111## sharing.off('sharingUpstreamChange') 1112 1113off(type: 'sharingUpstreamChange', callback?: Callback\<NetHandle>): void 1114 1115Unsubscribes from upstream network changes. This API uses an asynchronous callback to return the result. 1116 1117**System API**: This is a system API. 1118 1119**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL 1120 1121**System capability**: SystemCapability.Communication.NetManager.NetSharing 1122 1123**Parameters** 1124 1125| Name | Type | Mandatory| Description | 1126| -------- | ------------------------- | ---- | -------------------------------- | 1127| type | string | Yes | Event name. | 1128| callback | AsyncCallback\<NetHandle> | No | Callback used for unsubscription from upstream network changes.| 1129 1130**Error codes** 1131 1132| ID| Error Message | 1133| --------- | ---------------------------------------- | 1134| 201 | Permission denied. | 1135| 202 | Non-system applications use system APIs. | 1136| 401 | Parameter error. | 1137 1138**Example** 1139 1140```js 1141import sharing from '@ohos.net.sharing'; 1142 1143sharing.off('sharingUpstreamChange', (data: object) => { 1144 console.log(JSON.stringify(data)); 1145}); 1146``` 1147 1148## InterfaceSharingStateInfo<sup>11+</sup> 1149 1150Wakes up the listener for network sharing state changes of an NIC. 1151 1152**System API**: This is a system API. 1153 1154**System capability**: SystemCapability.Communication.NetManager.NetSharing 1155 1156| Name | Type | Mandatory| Description | 1157| -------- | ------------------------------------------------- | ---- | ------------------- | 1158| type | [SharingIfaceType](#sharingifacetype) | Yes | Enumerates the network sharing types of an NIC. | 1159| iface | string | Yes | NIC name.| 1160| state | [SharingIfaceState](#sharingifacestate) | Yes | Network sharing state of the NIC. | 1161 1162## SharingIfaceState 1163 1164Enumerates the network sharing states of an NIC. 1165 1166**System API**: This is a system API. 1167 1168**System capability**: SystemCapability.Communication.NetManager.NetSharing 1169 1170| Name | Value | Description | 1171| ---------------------- | --- | ---------------- | 1172| SHARING_NIC_SERVING | 1 | Network sharing is in progress. | 1173| SHARING_NIC_CAN_SERVER | 2 | Network sharing is supported.| 1174| SHARING_NIC_ERROR | 3 | An error occurred during network sharing. | 1175 1176## SharingIfaceType 1177 1178Enumerates the network sharing types of an NIC. 1179 1180**System API**: This is a system API. 1181 1182**System capability**: SystemCapability.Communication.NetManager.NetSharing 1183 1184| Name | Value | Description | 1185| ----------------- | --- | -------------------- | 1186| SHARING_WIFI | 0 | Wi-Fi hotspot sharing.| 1187| SHARING_USB | 1 | USB sharing. | 1188| SHARING_BLUETOOTH | 2 | Bluetooth sharing. | 1189