@ohos.net.sharing (网络共享管理)

网络共享管理分享设备已有网络给其他连接设备，支持Wi-Fi热点共享、蓝牙共享和USB共享，同时提供网络共享状态、共享流量查询功能。

说明：

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import sharing from '@ohos.net.sharing'

sharing.isSharingSupported

isSharingSupported(callback: AsyncCallback<boolean>): void

判断是否支持网络共享，使用callback方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

示例：

sharing.isSharingSupported((error, data) => {
  console.log(JSON.stringify(error));
  console.log(JSON.stringify(data));
});

sharing.isSharingSupported

isSharingSupported(): Promise<boolean>

判断是否支持网络共享，使用Promise方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

返回值：

错误码：

示例：

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

sharing.isSharing

isSharing(callback: AsyncCallback<boolean>): void

获取当前网络共享状态，使用callback方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

示例：

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

sharing.isSharing

isSharing(): Promise<boolean>

获取当前网络共享状态，使用Promise方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

返回值：

错误码：

示例：

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

sharing.startSharing

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

开启指定类型共享，使用callback方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

示例：

import SharingIfaceType from '@ohos.net.sharing'

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

sharing.startSharing

startSharing(type: SharingIfaceType): Promise<void>

开启指定类型共享，使用Promise方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

返回值：

错误码：

示例：

import SharingIfaceType from '@ohos.net.sharing'

let SHARING_WIFI = 0;
sharing.startSharing(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>): void

关闭指定类型共享，使用callback方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

示例：

import SharingIfaceType from '@ohos.net.sharing'

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

sharing.stopSharing

stopSharing(type: SharingIfaceType): Promise<void>

关闭指定类型共享，使用Promise方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

返回值：

错误码：

示例：

import SharingIfaceType from '@ohos.net.sharing'

let SHARING_WIFI = 0;
sharing.stopSharing(SHARING_WIFI).then(() => {
  console.log("stop wifi sharing successful");
}).catch(error => {
  console.log("stop wifi sharing failed");
});

sharing.getStatsRxBytes

getStatsRxBytes(callback: AsyncCallback<number>): void

获取共享网络接收数据量，使用callback方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

示例：

sharing.getStatsRxBytes((error, data) => {
  console.log(JSON.stringify(error));
  console.log(JSON.stringify(data));
});

sharing.getStatsRxBytes

getStatsRxBytes(): Promise<number>

获取共享网络接收数据量，使用Promise方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

返回值：

错误码：

示例：

sharing.getStatsRxBytes().then(data => {
  console.log(JSON.stringify(data));
}).catch(error => {
  console.log(JSON.stringify(error));
});

sharing.getStatsTxBytes

getStatsTxBytes(callback: AsyncCallback<number>): void

获取共享网络发送数据量，使用callback方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

示例：

sharing.getStatsTxBytes((error, data) => {
  console.log(JSON.stringify(error));
  console.log(JSON.stringify(data));
});

sharing.getStatsTxBytes

getStatsTxBytes(): Promise<number>

获取共享网络发送数据量，使用Promise方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

返回值：

错误码：

示例：

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

sharing.getStatsTotalBytes

getStatsTotalBytes(callback: AsyncCallback<number>): void

获取共享网络总数据量，使用callback方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

示例：

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

sharing.getStatsTotalBytes

getStatsTotalBytes(): Promise<number>

获取共享网络总数据量，使用Promise方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

返回值：

错误码：

示例：

sharing.getStatsTotalBytes().then(data => {
  console.log(JSON.stringify(data));
}).catch(error => {
  console.log(JSON.stringify(error));
});

sharing.getSharingIfaces

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

获取指定状态的网卡名称列表，使用callback方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

示例：

import SharingIfaceState from '@ohos.net.sharing'

let SHARING_BLUETOOTH = 2;
sharing.getSharingIfaces(SHARING_BLUETOOTH, (error, data) => {
  console.log(JSON.stringify(error));
  console.log(JSON.stringify(data));
});

sharing.getSharingIfaces

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

获取指定状态的网卡名称列表，使用Promise方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

返回值：

错误码：

示例：

import SharingIfaceState from '@ohos.net.sharing'

let SHARING_BLUETOOTH = 2;
sharing.getSharingIfaces(SHARING_BLUETOOTH).then(data => {
  console.log(JSON.stringify(data));
}).catch(error => {
  console.log(JSON.stringify(error));
});

sharing.getSharingState

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

获取指定类型网络共享状态，使用callback方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

示例：

import SharingIfaceType from '@ohos.net.sharing'

let SHARING_WIFI = 0;
sharing.getSharingState(SHARING_WIFI, (error, data) => {
  console.log(JSON.stringify(error));
  console.log(JSON.stringify(data));
});

sharing.getSharingState

getSharingState(type: SharingIfaceType): Promise<SharingIfaceState>

获取指定类型网络共享状态，使用Promise方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

返回值：

示例：

import SharingIfaceType from '@ohos.net.sharing'

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

sharing.getSharableRegexes

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

获取指定类型网卡名称正则表达式列表，使用callback方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

示例：

import SharingIfaceType from '@ohos.net.sharing'

let SHARING_WIFI = 0;
sharing.getSharableRegexes(SHARING_WIFI, (error, data) => {
  console.log(JSON.stringify(error));
  console.log(JSON.stringify(data));
});

sharing.getSharableRegexes

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

获取指定类型网卡名称正则表达式列表，使用Promise方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

返回值：

错误码：

示例：

import SharingIfaceType from '@ohos.net.sharing'

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

sharing.on('sharingStateChange')

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

注册网络共享状态变化事件，使用callback方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

示例：

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

sharing.off('sharingStateChange')

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

注销网络共享状态变化事件，使用callback方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

示例：

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

sharing.on('interfaceSharingStateChange')

on(type: 'interfaceSharingStateChange', callback: Callback<{ type: SharingIfaceType, iface: string, state: SharingIfaceState }>): void

注册网卡网络共享状态变化事件，使用callback方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

示例：

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

sharing.off('interfaceSharingStateChange')

off(type: 'interfaceSharingStateChange', callback?: Callback<{ type: SharingIfaceType, iface: string, state: SharingIfaceState }>): void

注销网卡网络共享状态变化事件，使用callback方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

示例：

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

sharing.on('sharingUpstreamChange')

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

注册上行网络变化事件，使用callback方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

示例：

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

sharing.off('sharingUpstreamChange')

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

注销上行网络变化事件，使用callback方式作为异步方法。

系统接口：此接口为系统接口。

需要权限：ohos.permission.CONNECTIVITY_INTERNAL

系统能力：SystemCapability.Communication.NetManager.NetSharing

参数：

错误码：

示例：

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

SharingIfaceState

网络共享状态。

系统接口：此接口为系统接口。

系统能力：SystemCapability.Communication.NetManager.NetSharing

SharingIfaceType

网络共享类型。

系统接口：此接口为系统接口。

系统能力：SystemCapability.Communication.NetManager.NetSharing