# @ohos.net.sharing (Network Sharing)

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.

Modules to Import

import sharing from '@ohos.net.sharing';

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

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

sharing.isSharingSupported((error: BusinessError, data: boolean) => {
  console.log(JSON.stringify(error));
  console.log(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

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

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

sharing.isSharing

isSharing(callback: AsyncCallback<boolean>): void

Checks whether network sharing is in progress. 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

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

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

sharing.isSharing

isSharing(): Promise<boolean>

Checks whether network sharing is in progress. 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

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

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

sharing.startSharing

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

Starts network 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

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

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

sharing.startSharing

startSharing(type: SharingIfaceType): Promise<void>

Starts network 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

Return value

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

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

sharing.stopSharing

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

Stops network 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

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

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

sharing.stopSharing

stopSharing(type: SharingIfaceType): Promise<void>

Stops network 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

Return value

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

let SHARING_WIFI = 0;
sharing
  .stopSharing(SHARING_WIFI)
  .then(() => {
    console.log('stop wifi sharing successful');
  })
  .catch((error: BusinessError) => {
    console.log('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

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

sharing.getStatsRxBytes((error: BusinessError, data: number) => {
  console.log(JSON.stringify(error));
  console.log(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

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

sharing
  .getStatsRxBytes()
  .then((data: number) => {
    console.log(JSON.stringify(data));
  })
  .catch((error: BusinessError) => {
    console.log(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

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

sharing.getStatsTxBytes((error: BusinessError, data: number) => {
  console.log(JSON.stringify(error));
  console.log(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

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

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

sharing.getStatsTotalBytes

getStatsTotalBytes(callback: AsyncCallback<number>): void

Obtains the volume of mobile data traffic sent and 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

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

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

sharing.getStatsTotalBytes

getStatsTotalBytes(): Promise<number>

Obtains the volume of mobile data traffic sent and 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

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

sharing
  .getStatsTotalBytes()
  .then((data: number) => {
    console.log(JSON.stringify(data));
  })
  .catch((error: BusinessError) => {
    console.log(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

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

let SHARING_BLUETOOTH = 2;
sharing.getSharingIfaces(SHARING_BLUETOOTH, (error: BusinessError, data: string[]) => {
  console.log(JSON.stringify(error));
  console.log(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

Return value

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

let SHARING_BLUETOOTH = 2;
sharing
  .getSharingIfaces(SHARING_BLUETOOTH)
  .then((data: string[]) => {
    console.log(JSON.stringify(data));
  })
  .catch((error: BusinessError) => {
    console.log(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

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

let SHARING_WIFI = 0;
sharing.getSharingState(SHARING_WIFI, (error: BusinessError, data: sharing.SharingIfaceState) => {
  console.log(JSON.stringify(error));
  console.log(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

Error codes

Return value

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

let SHARING_WIFI = 0;
sharing
  .getSharingState(SHARING_WIFI)
  .then((data: sharing.SharingIfaceState) => {
    console.log(JSON.stringify(data));
  })
  .catch((error: BusinessError) => {
    console.log(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

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

let SHARING_WIFI = 0;
sharing.getSharableRegexes(SHARING_WIFI, (error: BusinessError, data: string[]) => {
  console.log(JSON.stringify(error));
  console.log(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

Return value

Error codes

Example

import sharing from '@ohos.net.sharing';
import { BusinessError } from '@ohos.base';

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

sharing.on('sharingStateChange')

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

Subscribes to network sharing state 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

Error codes

Example

import sharing from '@ohos.net.sharing';

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

sharing.off('sharingStateChange')

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

Unsubscribes from network sharing state 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

Error codes

Example

import sharing from '@ohos.net.sharing';

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

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

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Error codes

Example

import sharing from '@ohos.net.sharing';

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

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

System API: This is a system API.

Required permissions: ohos.permission.CONNECTIVITY_INTERNAL

System capability: SystemCapability.Communication.NetManager.NetSharing

Parameters

Error codes

Example

import sharing from '@ohos.net.sharing';

sharing.off('interfaceSharingStateChange', (data: object) => {
  console.log(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

Error codes

Example

import sharing from '@ohos.net.sharing';

sharing.on('sharingUpstreamChange', (data: object) => {
  console.log('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

Error codes

Example

import sharing from '@ohos.net.sharing';

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

SharingIfaceState

Enumerates the network sharing states of an NIC.

System API: This is a system API.

System capability: SystemCapability.Communication.NetManager.NetSharing

SharingIfaceType

Enumerates the network sharing types of an NIC.

System API: This is a system API.

System capability: SystemCapability.Communication.NetManager.NetSharing