diff --git a/en/application-dev/reference/apis/js-apis-net-sharing.md b/en/application-dev/reference/apis/js-apis-net-sharing.md deleted file mode 100644 index 23284aeb1715a3f8aed9ec7b2d79ad55d1408319..0000000000000000000000000000000000000000 --- a/en/application-dev/reference/apis/js-apis-net-sharing.md +++ /dev/null @@ -1,746 +0,0 @@ -# Network Sharing Management - -The Network Sharing Management 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. - -> **NOTE** -> -> 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. - -## Modules to Import - -```js -import sharing from '@ohos.net.sharing' -``` - -## sharing.isSharingSupported - -isSharingSupported(callback: AsyncCallback\): void - -Checks whether network sharing is supported. This API uses an asynchronous callback to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| callback | AsyncCallback\ | Yes | Callback used to return the result. The value **true** means that network sharing is supported, and **false** means the opposite.| - -**Example** - -```js -sharing.isSharingSupported((error, data) => { - console.log(JSON.stringify(error)); - console.log(JSON.stringify(data)); -}); -``` - -## sharing.isSharingSupported - -isSharingSupported(): Promise\ - -Checks whether network sharing is supported. This API uses a promise to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Return value** - -| Type | Description | -| --------------------------------- | ------------------------------------- | -| Promise\ | Promise used to return the result. The value **true** means that network sharing is supported, and **false** means the opposite.| - -**Example** - -```js -sharing.isSharingSupported().then(data => { - console.log(JSON.stringify(data)); -}).catch(error => { - console.log(JSON.stringify(error)); -}); -``` - -## sharing.isSharing - -isSharing(callback: AsyncCallback\): void - -Checks whether network sharing is in progress. This API uses an asynchronous callback to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| callback | AsyncCallback\ | Yes | Callback used to return the result. The value **true** means that network sharing is in progress, and **false** means the opposite.| - -**Example** - -```js -sharing.isSharing((error, data) => { - console.log(JSON.stringify(error)); - console.log(JSON.stringify(data)); -}); -``` - -## sharing.isSharing - -isSharing(): Promise\ - -Checks whether network sharing is in progress. This API uses a promise to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Return value** - -| Type | Description | -| --------------------------------- | ------------------------------------- | -| Promise\ | Promise used to return the result. The value **true** means that network sharing is in progress, and **false** means the opposite.| - -**Example** - -```js -sharing.isSharing().then(data => { - console.log(JSON.stringify(data)); -}).catch(error => { - console.log(JSON.stringify(error)); -}); -``` - -## sharing.startSharing - -startSharing(type: SharingIfaceType, callback: AsyncCallback\): void - -Starts network sharing of a specified type. This API uses an asynchronous callback to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| type | [SharingIfaceType](#sharingifacetype) | Yes | Sharing type. The value **0** means Wi-Fi hotspot sharing, **1** means USB sharing, and **2** means Bluetooth sharing.| -| callback | AsyncCallback\ | Yes | Callback used to return the result.| - -**Example** - -```js -import SharingIfaceType from '@ohos.net.sharing' -sharing.startSharing(SharingIfaceType.SHARING_WIFI, (error) => { - console.log(JSON.stringify(error)); -}); -``` - -## sharing.startSharing - -startSharing(type: SharingIfaceType): Promise\ - -Starts network sharing of a specified type. This API uses a promise to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| type | [SharingIfaceType](#sharingifacetype) | Yes | Sharing type. The value **0** means Wi-Fi hotspot sharing, **1** means USB sharing, and **2** means Bluetooth sharing.| - -**Return value** - -| Type | Description | -| --------------------------------- | ------------------------------------- | -| Promise\ | Promise used to return the result.| - -**Example** - -```js -import SharingIfaceType from '@ohos.net.sharing' -sharing.startSharing(SharingIfaceType.SHARING_WIFI).then(() => { - console.log("start wifi sharing successful"); -}).catch(error => { - console.log("start wifi sharing failed"); -}); -``` - -## sharing.stopSharing - -stopSharing(type: SharingIfaceType, callback: AsyncCallback\): void - -Stops network sharing of a specified type. This API uses an asynchronous callback to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| type | [SharingIfaceType](#sharingifacetype) | Yes | Sharing type. The value **0** means Wi-Fi hotspot sharing, **1** means USB sharing, and **2** means Bluetooth sharing.| -| callback | AsyncCallback\ | Yes | Callback used to return the result.| - -**Example** - -```js -import SharingIfaceType from '@ohos.net.sharing' -sharing.stopSharing(SharingIfaceType.SHARING_WIFI, (error) => { - console.log(JSON.stringify(error)); -}); -``` - -## sharing.stopSharing - -stopSharing(type: SharingIfaceType): Promise\ - -Stops network sharing of a specified type. This API uses a promise to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| type | [SharingIfaceType](#sharingifacetype) | Yes | Sharing type. The value **0** means Wi-Fi hotspot sharing, **1** means USB sharing, and **2** means Bluetooth sharing.| - -**Return value** - -| Type | Description | -| --------------------------------- | ------------------------------------- | -| Promise\ | Promise used to return the result.| - -**Example** - -```js -import SharingIfaceType from '@ohos.net.sharing' -sharing.stopSharing(SharingIfaceType.SHARING_WIFI).then(() => { - console.log("stop wifi sharing successful"); -}).catch(error => { - console.log("stop wifi sharing failed"); -}); -``` - -## sharing.getStatsRxBytes - -getStatsRxBytes(callback: AsyncCallback\): void - -Obtains the volume of mobile data traffic received via network sharing. This API uses an asynchronous callback to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| callback | AsyncCallback\ | Yes | Callback used to return the data volume, in KB.| - -**Example** - -```js -sharing.getStatsRxBytes((error, data) => { - console.log(JSON.stringify(error)); - console.log(JSON.stringify(data)); -}); -``` - -## sharing.getStatsRxBytes - -getStatsRxBytes(): Promise\ - -Obtains the volume of mobile data traffic received via network sharing. This API uses a promise to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Return value** - -| Type | Description | -| --------------------------------- | ------------------------------------- | -| Promise\ | Promise used to return the data volume, in KB.| - -**Example** - -```js -sharing.getStatsRxBytes().then(data => { - console.log(JSON.stringify(data)); -}).catch(error => { - console.log(JSON.stringify(error)); -}); -``` - -## sharing.getStatsTxBytes - -getStatsTxBytes(callback: AsyncCallback\): void - -Obtains the volume of mobile data traffic sent via network sharing. This API uses an asynchronous callback to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| callback | AsyncCallback\ | Yes | Callback used to return the data volume, in KB.| - -**Example** - -```js -sharing.getStatsTxBytes((error, data) => { - console.log(JSON.stringify(error)); - console.log(JSON.stringify(data)); -}); -``` - -## sharing.getStatsTxBytes - -getStatsTxBytes(): Promise\ - -Obtains the volume of mobile data traffic sent via network sharing. This API uses a promise to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Return value** - -| Type | Description | -| --------------------------------- | ------------------------------------- | -| Promise\ | Promise used to return the data volume, in KB.| - -**Example** - -```js -sharing.getStatsTxBytes().then(data => { - console.log(JSON.stringify(data)); -}).catch(error => { - console.log(JSON.stringify(error)); -}); -``` - -## sharing.getStatsTotalBytes - -getStatsTotalBytes(callback: AsyncCallback\): void - -Obtains the volume of mobile data traffic sent and received via network sharing. This API uses an asynchronous callback to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| callback | AsyncCallback\ | Yes | Callback used to return the data volume, in KB.| - -**Example** - -```js -sharing.getStatsTotalBytes((error, data) => { - console.log(JSON.stringify(error)); - console.log(JSON.stringify(data)); -}); -``` - -## sharing.getStatsTotalBytes - -getStatsTotalBytes(): Promise\ - -Obtains the volume of mobile data traffic sent and received via network sharing. This API uses a promise to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Return value** - -| Type | Description | -| --------------------------------- | ------------------------------------- | -| Promise\ | Promise used to return the data volume, in KB.| - -**Example** - -```js -sharing.getStatsTotalBytes().then(data => { - console.log(JSON.stringify(data)); -}).catch(error => { - console.log(JSON.stringify(error)); -}); -``` - -## sharing.getSharingIfaces - -getSharingIfaces(state: SharingIfaceState, callback: AsyncCallback\>): void - -Obtains the names of NICs in the specified network sharing state. This API uses an asynchronous callback to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| state | state: [SharingIfaceState](#sharingifacestate) | Yes | Network sharing state.| -| callback | AsyncCallback\> | Yes | Callback used to return an array of NIC names.| - -**Example** - -```js -import SharingIfaceState from '@ohos.net.sharing' -sharing.getSharingIfaces(SharingIfaceState.SHARING_NIC_CAN_SERVER, (error, data) => { - console.log(JSON.stringify(error)); - console.log(JSON.stringify(data)); -}); -``` - -## sharing.getSharingIfaces - -getSharingIfaces(state: SharingIfaceState): Promise\> - -Obtains the names of NICs in the specified network sharing state. This API uses a promise to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| state | state: [SharingIfaceState](#sharingifacestate) | Yes | Network sharing state.| - -**Return value** - -| Type | Description | -| --------------------------------- | ------------------------------------- | -| Promise\> | Promise used to return an array of NIC names.| - -**Example** - -```js -import SharingIfaceState from '@ohos.net.sharing' -sharing.getSharingIfaces(SharingIfaceState.SHARING_NIC_CAN_SERVER).then(data => { - console.log(JSON.stringify(data)); -}).catch(error => { - console.log(JSON.stringify(error)); -}); -``` - -## sharing.getSharingState - -getSharingState(type: SharingIfaceType, callback: AsyncCallback\): void - -Obtains the network sharing state of the specified type. This API uses an asynchronous callback to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| type | [SharingIfaceType](#sharingifacetype) | Yes | Sharing type. The value **0** means Wi-Fi hotspot sharing, **1** means USB sharing, and **2** means Bluetooth sharing.| -| callback | AsyncCallback\<[SharingIfaceState](#sharingifacestate)> | Yes | Callback used to return the network sharing state.| - -**Example** - -```js -import SharingIfaceState from '@ohos.net.sharing' -sharing.getSharingState(SharingIfaceType.SHARING_WIFI, (error, data) => { - console.log(JSON.stringify(error)); - console.log(JSON.stringify(data)); -}); -``` - -## sharing.getSharingState - -getSharingState(type: SharingIfaceType): Promise\ - -Obtains the network sharing state of the specified type. This API uses a promise to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| type | [SharingIfaceType](#sharingifacetype) | Yes | Sharing type. The value **0** means Wi-Fi hotspot sharing, **1** means USB sharing, and **2** means Bluetooth sharing.| - -**Return value** - -| Type | Description | -| --------------------------------- | ------------------------------------- | -| Promise\<[SharingIfaceState](#sharingifacestate)> | Promise used to return the network sharing state.| - -**Example** - -```js -import SharingIfaceType from '@ohos.net.sharing' -sharing.getSharingIfaces(SharingIfaceType.SHARING_WIFI).then(data => { - console.log(JSON.stringify(data)); -}).catch(error => { - console.log(JSON.stringify(error)); -}); -``` - -## sharing.getSharableRegexes - -getSharableRegexes(type: SharingIfaceType, callback: AsyncCallback\>): void - -Obtains regular expressions of NICs of a specified type. This API uses an asynchronous callback to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| type | [SharingIfaceType](#sharingifacetype) | Yes | Sharing type. The value **0** means Wi-Fi hotspot sharing, **1** means USB sharing, and **2** means Bluetooth sharing.| -| callback | AsyncCallback\> | Yes | Callback used to return an array of regular expressions.| - -**Example** - -```js -import SharingIfaceState from '@ohos.net.sharing' -sharing.getSharingState(SharingIfaceType.SHARING_WIFI, (error, data) => { - console.log(JSON.stringify(error)); - console.log(JSON.stringify(data)); -}); -``` - -## sharing.getSharableRegexes - -getSharableRegexes(type: SharingIfaceType): Promise\> - -Obtains regular expressions of NICs of a specified type. This API uses a promise to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| type | [SharingIfaceType](#sharingifacetype) | Yes | Sharing type. The value **0** means Wi-Fi hotspot sharing, **1** means USB sharing, and **2** means Bluetooth sharing.| - -**Return value** - -| Type | Description | -| --------------------------------- | ------------------------------------- | -| Promise\> | Promise used to return an array of regular expressions.| - -**Example** - -```js -import SharingIfaceType from '@ohos.net.sharing' -sharing.getSharableRegexes(SharingIfaceType.SHARING_WIFI).then(data => { - console.log(JSON.stringify(data)); -}).catch(error => { - console.log(JSON.stringify(error)); -}); -``` - -## on('sharingStateChange') - -on(type: 'sharingStateChange', callback: Callback\): void - -Subscribes to network sharing state changes. This API uses an asynchronous callback to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| type | string | Yes | Event name.| -| callback | AsyncCallback\ | Yes | Callback used to return the network sharing state.| - -**Example** - -```js -sharing.on('sharingStateChange', (error, data) => { - console.log(JSON.stringify(error)); - console.log(JSON.stringify(data)); -}); -``` - -## off('sharingStateChange') - -off(type: 'sharingStateChange', callback?: Callback\): void - -Unsubscribes from network sharing state changes. This API uses an asynchronous callback to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| type | string | Yes | Event name.| -| callback | AsyncCallback\ | No | Callback used for unsubscription.| - -**Example** - -```js -sharing.off('sharingStateChange', (error, data) => { - console.log(JSON.stringify(error)); - console.log(JSON.stringify(data)); -}); -``` - -## on('interfaceSharingStateChange') - -on(type: 'interfaceSharingStateChange', callback: Callback\<{ type: SharingIfaceType, iface: string, state: SharingIfaceState }>): void - -Subscribes to network sharing state changes of a specified NIC. This API uses an asynchronous callback to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| type | string | Yes | Event name.| -| callback | AsyncCallback\<{ type: [SharingIfaceType](#sharingifacetype), iface: string, state: SharingIfaceState(#sharingifacestate) }> | Yes | Callback invoked when the network sharing state of the specified NIC changes.| - -**Example** - -```js -sharing.on('interfaceSharingStateChange', (error, data) => { - console.log(JSON.stringify(error)); - console.log(JSON.stringify(data)); -}); -``` - -## off('interfaceSharingStateChange') - -off(type: 'interfaceSharingStateChange', callback?: Callback\<{ type: SharingIfaceType, iface: string, state: SharingIfaceState }>): void - -Unsubscribes from network sharing status changes of a specified NIC. This API uses an asynchronous callback to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| type | string | No | Event name.| -| callback | AsyncCallback\<{ type: [SharingIfaceType](#sharingifacetype), iface: string, state: SharingIfaceState(#sharingifacestate) }> | No | Callback used for unsubscription.| - -**Example** - -```js -sharing.off('interfaceSharingStateChange', (error, data) => { - console.log(JSON.stringify(error)); - console.log(JSON.stringify(data)); -}); -``` - -## on('sharingUpstreamChange') - -on(type: 'sharingUpstreamChange', callback: Callback\): void - -Subscribes to upstream network changes. This API uses an asynchronous callback to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| type | string | Yes | Event name.| -| callback | AsyncCallback\ | Yes | Callback invoked when the upstream network changes.| - -**Example** - -```js -sharing.on('sharingUpstreamChange', (error, data) => { - console.log(JSON.stringify(error)); - console.log(JSON.stringify(data)); -}); -``` - -## off('sharingUpstreamChange') - -off(type: 'sharingUpstreamChange', callback?: Callback\): void - -Unsubscribes from upstream network changes. This API uses an asynchronous callback to return the result. - -**Required permissions**: ohos.permission.CONNECTIVITY_INTERNAL - -**System capability**: SystemCapability.Communication.NetManager.Core - -**Parameters** - -| Name | Type | Mandatory| Description | -| -------- | --------------------------------------- | ---- | ---------- | -| type | string | Yes | Event name.| -| callback | AsyncCallback\ | No | Callback used for unsubscription.| - -**Example** - -```js -sharing.off('sharingUpstreamChange', (error, data) => { - console.log(JSON.stringify(error)); - console.log(JSON.stringify(data)); -}); -``` - -## SharingIfaceState - -Enumerates the network sharing states of an NIC. - -**System capability**: SystemCapability.Communication.NetManager.Core - -| Name | Value | Description | -| ------------------------ | ---- | ---------------------- | -| SHARING_NIC_SERVING | 1 | Network sharing is in progress.| -| SHARING_NIC_CAN_SERVER | 2 | Network sharing is supported.| -| SHARING_NIC_ERROR | 3 | An error occurred during network sharing.| - -## SharingIfaceType - -Enumerates the network sharing types of an NIC. - -**System capability**: SystemCapability.Communication.NetManager.Core - -| Name | Value | Description | -| ------------------------ | ---- | ---------------------- | -| SHARING_WIFI | 0 | Wi-Fi hotspot sharing.| -| SHARING_USB | 1 | USB sharing.| -| SHARING_BLUETOOTH | 2 | Bluetooth sharing.|