@ohos.net.sharing (Network Sharing Management) (System API)

The 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.

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. The APIs provided by this module are system APIs.

Modules to Import

import { sharing } from '@kit.NetworkKit';

sharing.isSharingSupported

isSharingSupported(callback: AsyncCallback<boolean>): void

Checks whether network sharing is supported. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<boolean>	Yes	Callback used to return the result. The value true means that network sharing is supported, and false means the opposite.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
2200002	Failed to connect to the service.
2200003	System internal error.
2202011	Cannot get network sharing configuration.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

sharing.isSharingSupported((error: BusinessError, data: boolean) => {
  console.error(JSON.stringify(error));
  console.info(JSON.stringify(data));
});

sharing.isSharingSupported

isSharingSupported(): Promise<boolean>

Checks whether network sharing is supported. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true means that network sharing is supported, and false means the opposite.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
2200002	Failed to connect to the service.
2200003	System internal error.
2202011	Cannot get network sharing configuration.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

sharing
  .isSharingSupported()
  .then((data: boolean) => {
    console.info(JSON.stringify(data));
  })
  .catch((error: BusinessError) => {
    console.error(JSON.stringify(error));
  });

sharing.isSharing

isSharing(callback: AsyncCallback<boolean>): void

Obtains the current network sharing status. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
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.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
2200002	Failed to connect to the service.
2200003	System internal error.
2202011	Cannot get network sharing configuration.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

sharing.isSharing((error: BusinessError, data: boolean) => {
  console.error(JSON.stringify(error));
  console.info(JSON.stringify(data));
});

sharing.isSharing

isSharing(): Promise<boolean>

Obtains the current network sharing status. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Return value

Type	Description
Promise<boolean>	Promise used to return the result. The value true means that network sharing is in progress, and false means the opposite.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
2200002	Failed to connect to the service.
2200003	System internal error.
2202011	Cannot get network sharing configuration.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

sharing
  .isSharing()
  .then((data: boolean) => {
    console.info(JSON.stringify(data));
  })
  .catch((error: BusinessError) => {
    console.error(JSON.stringify(error));
  });

sharing.startSharing

startSharing(type: SharingIfaceType, callback: AsyncCallback<void>): void

Enables sharing of a specified type. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
type	SharingIfaceType	Yes	Sharing type. The value 0 means Wi-Fi hotspot sharing, 1 means USB sharing, and 2 means Bluetooth sharing.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.
2200001	Invalid parameter value.
2200002	Failed to connect to the service.
2200003	System internal error.
2202004	Try to share an unavailable iface.
2202005	WiFi sharing failed.
2202006	Bluetooth sharing failed.
2202009	Failed to enable forwarding for network sharing.
2202011	Cannot get network sharing configuration.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let SHARING_WIFI = 0;
sharing.startSharing(SHARING_WIFI, (error: BusinessError) => {
  console.error(JSON.stringify(error));
});

sharing.startSharing

startSharing(type: SharingIfaceType): Promise<void>

Enables sharing of a specified type. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
type	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<void>	Promise used to return the result.

Error codes

ID	Error Message
202	Non-system applications use system APIs.
201	Permission denied.
401	Parameter error.
2200001	Invalid parameter value.
2200002	Failed to connect to the service.
2200003	System internal error.
2202004	Try to share an unavailable iface.
2202005	WiFi sharing failed.
2202006	Bluetooth sharing failed.
2202009	Failed to enable forwarding for network sharing.
2202011	Cannot get network sharing configuration.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let SHARING_WIFI = 0;
sharing
  .startSharing(SHARING_WIFI)
  .then(() => {
    console.info('start wifi sharing successful');
  })
  .catch((error: BusinessError) => {
    console.error('start wifi sharing failed');
  });

sharing.stopSharing

stopSharing(type: SharingIfaceType, callback: AsyncCallback<void>): void

Disables sharing of a specified type. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
type	SharingIfaceType	Yes	Sharing type. The value 0 means Wi-Fi hotspot sharing, 1 means USB sharing, and 2 means Bluetooth sharing.
callback	AsyncCallback<void>	Yes	Callback used to return the result.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.
2200001	Invalid parameter value.
2200002	Failed to connect to the service.
2200003	System internal error.
2202004	Try to share an unavailable iface.
2202005	WiFi sharing failed.
2202006	Bluetooth sharing failed.
2202011	Cannot get network sharing configuration.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let SHARING_WIFI = 0;
sharing.stopSharing(SHARING_WIFI, (error: BusinessError) => {
  console.error(JSON.stringify(error));
});

sharing.stopSharing

stopSharing(type: SharingIfaceType): Promise<void>

Disables sharing of a specified type. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
type	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<void>	Promise used to return the result.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.
2200001	Invalid parameter value.
2200002	Failed to connect to the service.
2200003	System internal error.
2202004	Try to share an unavailable iface.
2202005	WiFi sharing failed.
2202006	Bluetooth sharing failed.
2202011	Cannot get network sharing configuration.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let SHARING_WIFI = 0;
sharing
  .stopSharing(SHARING_WIFI)
  .then(() => {
    console.info('stop wifi sharing successful');
  })
  .catch((error: BusinessError) => {
    console.error('stop wifi sharing failed');
  });

sharing.getStatsRxBytes

getStatsRxBytes(callback: AsyncCallback<number>): void

Obtains the volume of mobile data traffic received via network sharing. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<number>	Yes	Callback used to return the data volume, in KB.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.
2200002	Failed to connect to the service.
2200003	System internal error.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

sharing.getStatsRxBytes((error: BusinessError, data: number) => {
  console.error(JSON.stringify(error));
  console.info(JSON.stringify(data));
});

sharing.getStatsRxBytes

getStatsRxBytes(): Promise<number>

Obtains the volume of mobile data traffic received via network sharing. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Return value

Type	Description
Promise<number>	Promise used to return the data volume, in KB.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.
2200002	Failed to connect to the service.
2200003	System internal error.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

sharing
  .getStatsRxBytes()
  .then((data: number) => {
    console.info(JSON.stringify(data));
  })
  .catch((error: BusinessError) => {
    console.error(JSON.stringify(error));
  });

sharing.getStatsTxBytes

getStatsTxBytes(callback: AsyncCallback<number>): void

Obtains the volume of mobile data traffic sent via network sharing. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<number>	Yes	Callback used to return the data volume, in KB.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.
2200002	Failed to connect to the service.
2200003	System internal error.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

sharing.getStatsTxBytes((error: BusinessError, data: number) => {
  console.error(JSON.stringify(error));
  console.info(JSON.stringify(data));
});

sharing.getStatsTxBytes

getStatsTxBytes(): Promise<number>

Obtains the volume of mobile data traffic sent via network sharing. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Return value

Type	Description
Promise<number>	Promise used to return the data volume, in KB.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.
2200002	Failed to connect to the service.
2200003	System internal error.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

sharing
  .getStatsTxBytes()
  .then((data: number) => {
    console.info(JSON.stringify(data));
  })
  .catch((error: BusinessError) => {
    console.error(JSON.stringify(error));
  });

sharing.getStatsTotalBytes

getStatsTotalBytes(callback: AsyncCallback<number>): void

Obtains the total volume of mobile data traffic sent via network sharing. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
callback	AsyncCallback<number>	Yes	Callback used to return the data volume, in KB.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.
2200002	Failed to connect to the service.
2200003	System internal error.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

sharing.getStatsTotalBytes((error: BusinessError, data: number) => {
  console.error(JSON.stringify(error));
  console.info(JSON.stringify(data));
});

sharing.getStatsTotalBytes

getStatsTotalBytes(): Promise<number>

Obtains the total volume of mobile data traffic sent via network sharing. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Return value

Type	Description
Promise<number>	Promise used to return the data volume, in KB.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.
2200002	Failed to connect to the service.
2200003	System internal error.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

sharing
  .getStatsTotalBytes()
  .then((data: number) => {
    console.info(JSON.stringify(data));
  })
  .catch((error: BusinessError) => {
    console.error(JSON.stringify(error));
  });

sharing.getSharingIfaces

getSharingIfaces(state: SharingIfaceState, callback: AsyncCallback<Array<string>>): void

Obtains the names of NICs in the specified network sharing state. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
state	SharingIfaceState	Yes	Network sharing state.
callback	AsyncCallback<Array<string>>	Yes	Callback used to return an array of NIC names.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.
2200001	Invalid parameter value.
2200002	Failed to connect to the service.
2200003	System internal error.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let SHARING_BLUETOOTH = 2;
sharing.getSharingIfaces(SHARING_BLUETOOTH, (error: BusinessError, data: string[]) => {
  console.error(JSON.stringify(error));
  console.info(JSON.stringify(data));
});

sharing.getSharingIfaces

getSharingIfaces(state: SharingIfaceState): Promise<Array<string>>

Obtains the names of NICs in the specified network sharing state. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
state	SharingIfaceState	Yes	Network sharing state.

Return value

Type	Description
Promise<Array<string>>	Promise used to return an array of NIC names.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.
2200001	Invalid parameter value.
2200002	Failed to connect to the service.
2200003	System internal error.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let SHARING_BLUETOOTH = 2;
sharing
  .getSharingIfaces(SHARING_BLUETOOTH)
  .then((data: string[]) => {
    console.info(JSON.stringify(data));
  })
  .catch((error: BusinessError) => {
    console.error(JSON.stringify(error));
  });

sharing.getSharingState

getSharingState(type: SharingIfaceType, callback: AsyncCallback<SharingIfaceState>): void

Obtains the network sharing state of the specified type. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
type	SharingIfaceType	Yes	Sharing type. The value 0 means Wi-Fi hotspot sharing, 1 means USB sharing, and 2 means Bluetooth sharing.
callback	AsyncCallback<SharingIfaceState>	Yes	Callback used to return the network sharing state.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.
2200001	Invalid parameter value.
2200002	Failed to connect to the service.
2200003	System internal error.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let SHARING_WIFI = 0;
sharing.getSharingState(SHARING_WIFI, (error: BusinessError, data: sharing.SharingIfaceState) => {
  console.error(JSON.stringify(error));
  console.info(JSON.stringify(data));
});

sharing.getSharingState

getSharingState(type: SharingIfaceType): Promise<SharingIfaceState>

Obtains the network sharing state of the specified type. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
type	SharingIfaceType	Yes	Sharing type. The value 0 means Wi-Fi hotspot sharing, 1 means USB sharing, and 2 means Bluetooth sharing.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.
2200001	Invalid parameter value.
2200002	Failed to connect to the service.
2200003	System internal error.

Return value

Type	Description
Promise<SharingIfaceState>	Promise used to return the network sharing state.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let SHARING_WIFI = 0;
sharing
  .getSharingState(SHARING_WIFI)
  .then((data: sharing.SharingIfaceState) => {
    console.info(JSON.stringify(data));
  })
  .catch((error: BusinessError) => {
    console.error(JSON.stringify(error));
  });

sharing.getSharableRegexes

getSharableRegexes(type: SharingIfaceType, callback: AsyncCallback<Array<string>>): void

Obtains regular expressions of NICs of a specified type. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
type	SharingIfaceType	Yes	Sharing type. The value 0 means Wi-Fi hotspot sharing, 1 means USB sharing, and 2 means Bluetooth sharing.
callback	AsyncCallback<Array<string>>	Yes	Callback used to return an array of regular expressions.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.
2200001	Invalid parameter value.
2200002	Failed to connect to the service.
2200003	System internal error.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let SHARING_WIFI = 0;
sharing.getSharableRegexes(SHARING_WIFI, (error: BusinessError, data: string[]) => {
  console.error(JSON.stringify(error));
  console.info(JSON.stringify(data));
});

sharing.getSharableRegexes

getSharableRegexes(type: SharingIfaceType): Promise<Array<string>>

Obtains regular expressions of NICs of a specified type. This API uses a promise to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
type	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<Array<string>>	Promise used to return an array of regular expressions.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.
2200001	Invalid parameter value.
2200002	Failed to connect to the service.
2200003	System internal error.

Example

import { sharing } from '@kit.NetworkKit';
import { BusinessError } from '@kit.BasicServicesKit';

let SHARING_WIFI = 0;
sharing
  .getSharableRegexes(SHARING_WIFI)
  .then((data: string[]) => {
    console.info(JSON.stringify(data));
  })
  .catch((error: BusinessError) => {
    console.error(JSON.stringify(error));
  });

sharing.on('sharingStateChange')

on(type: 'sharingStateChange', callback: Callback<boolean>): void

Registers the network sharing status change event. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value sharingStateChange indicates a network sharing status change event.
callback	AsyncCallback<boolean>	Yes	Callback invoked when the network sharing state changes.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.

Example

import { sharing } from '@kit.NetworkKit';

sharing.on('sharingStateChange', (data: boolean) => {
  console.info('on sharingStateChange: ' + JSON.stringify(data));
});

sharing.off('sharingStateChange')

off(type: 'sharingStateChange', callback?: Callback<boolean>): void

Unregisters the network sharing status change event. This method uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value sharingStateChange indicates a network sharing status change event.
callback	AsyncCallback<boolean>	No	Callback invoked when the network sharing state changes.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.

Example

import { sharing } from '@kit.NetworkKit';

sharing.off('sharingStateChange', (data: boolean) => {
  console.info(JSON.stringify(data));
});

sharing.on('interfaceSharingStateChange')

on(type: 'interfaceSharingStateChange', callback: Callback<InterfaceSharingStateInfo>): void

Subscribes to network sharing state changes of a specified NIC. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value interfaceSharingStateChange indicates a network sharing status change event of the NIC.
callback	AsyncCallback<InterfaceSharingStateInfo>	Yes	Callback used to return the result. It is called when the network sharing state of a specified NIC changes.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.

Example

import { sharing } from '@kit.NetworkKit';

sharing.on('interfaceSharingStateChange', (data: object) => {
  console.info('on interfaceSharingStateChange:' + JSON.stringify(data));
});

sharing.off('interfaceSharingStateChange')

off(type: 'interfaceSharingStateChange', callback?: Callback<InterfaceSharingStateInfo>): void

Unsubscribes from network sharing state changes of a specified NIC. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value interfaceSharingStateChange indicates a network sharing status change event of the NIC.
callback	AsyncCallback<InterfaceSharingStateInfo>	No	Callback used to return the result.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.

Example

import { sharing } from '@kit.NetworkKit';

sharing.off('interfaceSharingStateChange', (data: object) => {
  console.info(JSON.stringify(data));
});

sharing.on('sharingUpstreamChange')

on(type: 'sharingUpstreamChange', callback: Callback<NetHandle>): void

Subscribes to upstream network changes. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value sharingUpstreamChange indicates an upstream network change event.
callback	AsyncCallback<NetHandle>	Yes	Callback invoked when the upstream network changes.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.

Example

import { sharing } from '@kit.NetworkKit';

sharing.on('sharingUpstreamChange', (data: object) => {
  console.info('on sharingUpstreamChange:' + JSON.stringify(data));
});

sharing.off('sharingUpstreamChange')

off(type: 'sharingUpstreamChange', callback?: Callback<NetHandle>): void

Unsubscribes from upstream network changes. This API uses an asynchronous callback to return the result.

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Name	Type	Mandatory	Description
type	string	Yes	Event type. The value sharingUpstreamChange indicates an upstream network change event.
callback	AsyncCallback<NetHandle>	No	Callback used for unsubscription from upstream network changes.

Error codes

ID	Error Message
201	Permission denied.
202	Non-system applications use system APIs.
401	Parameter error.

Example

import { sharing } from '@kit.NetworkKit';

sharing.off('sharingUpstreamChange', (data: object) => {
  console.info(JSON.stringify(data));
});

InterfaceSharingStateInfo¹¹⁺

Wakes up the listener for network sharing state changes of an NIC.

System API: This is a system API.

System capability: SystemCapability.Communication.NetManager.NetSharing

Name	Type	Read-Only	Optional	Description
type	SharingIfaceType	No	No	Enumerates the network sharing types of an NIC.
iface	string	No	No	NIC name.
state	SharingIfaceState	No	No	Network sharing state of the NIC.

SharingIfaceState

Enumerates the network sharing states of an NIC.

System API: This is a system API.

System capability: SystemCapability.Communication.NetManager.NetSharing

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 API: This is a system API.

System capability: SystemCapability.Communication.NetManager.NetSharing

Name	Value	Description
SHARING_WIFI	0	Wi-Fi hotspot sharing.
SHARING_USB	1	USB sharing.
SHARING_BLUETOOTH	2	Bluetooth sharing.