;
/**
* Updates the specified Wi-Fi configuration.
*
* @param config Indicates the Wi-Fi configuration to update.
*
* @return Returns the network ID in the updated Wi-Fi configuration if the update is successful;
* returns {@code -1} if the specified Wi-Fi configuration is not contained in the list.
* @since 7
* @syscap SystemCapability.Communication.WiFi.STA
* @permission ohos.permission.SET_WIFI_INFO, ohos.permission.SET_WIFI_CONFIG
* @systemapi Hide this for inner system use.
*/
function updateNetwork(config: WifiDeviceConfig): number;
/**
* Disables a specified network.
*
* The disabled network will not be associated with again.
*
* @param netId Identifies the network to disable.
* @return Returns {@code true} if the specified network is disabled; returns {@code false} otherwise.
* @since 7
* @syscap SystemCapability.Communication.WiFi.STA
* @permission ohos.permission.SET_WIFI_INFO, ohos.permission.MANAGE_WIFI_CONNECTION
* @systemapi Hide this for inner system use.
*/
function disableNetwork(netId: number): boolean;
/**
* Removes all the saved Wi-Fi configurations.
*
* @return Returns {@code true} if all the saved Wi-Fi configurations are removed;
* returns {@code false} otherwise.
* @since 7
* @syscap SystemCapability.Communication.WiFi.STA
* @permission ohos.permission.SET_WIFI_INFO, ohos.permission.MANAGE_WIFI_CONNECTION
* @systemapi Hide this for inner system use.
*/
function removeAllNetwork(): boolean;
/**
* Deletes a Wi-Fi network with a specified ID.
*
*
After a Wi-Fi network is deleted, its configuration will be deleted from the list of Wi-Fi configurations.
* If the Wi-Fi network is being connected, the connection will be interrupted.
* The application can only delete Wi-Fi networks it has created.
*
* @param id Indicates the ID of the Wi-Fi network,
* which can be obtained using the {@link #addDeviceConfig} or {@link #getLinkedInfo} method.
* @return Returns {@code true} if the Wi-Fi network is deleted successfully; returns {@code false} otherwise.
* @since 7
* @syscap SystemCapability.Communication.WiFi.STA
* @permission ohos.permission.SET_WIFI_INFO, ohos.permission.MANAGE_WIFI_CONNECTION
* @systemapi Hide this for inner system use.
*/
function removeDevice(id: number): boolean;
/**
* Enables a Wi-Fi hotspot.
*
*
This method is asynchronous. After the Wi-Fi hotspot is enabled, Wi-Fi may be disabled.
*
* @return Returns {@code true} if this method is called successfully; returns {@code false} otherwise.
* @since 7
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @permission ohos.permission.MANAGE_WIFI_HOTSPOT
* @systemapi Hide this for inner system use.
*/
function enableHotspot(): boolean;
/**
* Disables a Wi-Fi hotspot.
*
*
This method is asynchronous. If Wi-Fi is enabled after the Wi-Fi hotspot is disabled, Wi-Fi may be re-enabled.
*
* @return Returns {@code true} if this method is called successfully; returns {@code false} otherwise.
* @since 7
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @permission ohos.permission.MANAGE_WIFI_HOTSPOT
* @systemapi Hide this for inner system use.
*/
function disableHotspot(): boolean;
/**
* Checks whether a device serving as a Wi-Fi hotspot supports both the 2.4 GHz and 5 GHz Wi-Fi.
*
* @return Returns {@code true} if the method is called successfully; returns {@code false} otherwise.
* @since 7
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @permission ohos.permission.GET_WIFI_INFO, ohos.permission.MANAGE_WIFI_HOTSPOT
* @systemapi Hide this for inner system use.
*/
function isHotspotDualBandSupported(): boolean;
/**
* Checks whether Wi-Fi hotspot is active on a device.
*
* @return Returns {@code true} if Wi-Fi hotspot is enabled; returns {@code false} otherwise.
* @since 7
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @permission ohos.permission.GET_WIFI_INFO
* @systemapi Hide this for inner system use.
*/
function isHotspotActive(): boolean;
/**
* Sets the hotspot for a device.
*
*
Only OPEN and WPA2 PSK hotspots can be configured.
*
* @param config Indicates the Wi-Fi hotspot configuration.
* The SSID and {@code securityType} must be available and correct.
* If {@code securityType} is not {@code open}, {@code preSharedKey} must be available and correct.
* @return Returns {@code true} if the method is called successfully; returns {@code false} otherwise.
* @since 7
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @permission ohos.permission.SET_WIFI_INFO, ohos.permission.GET_WIFI_CONFIG
* @systemapi Hide this for inner system use.
*/
function setHotspotConfig(config: HotspotConfig): boolean;
/**
* Obtains the Wi-Fi hotspot configuration.
*
* @return Returns the configuration of an existing or enabled Wi-Fi hotspot.
* @since 7
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @permission ohos.permission.GET_WIFI_INFO, ohos.permission.GET_WIFI_CONFIG
* @systemapi Hide this for inner system use.
*/
function getHotspotConfig(): HotspotConfig;
/**
* Obtains the list of clients that are connected to a Wi-Fi hotspot.
*
*
This method can only be used on a device that serves as a Wi-Fi hotspot.
*
* @return Returns the list of clients that are connected to the Wi-Fi hotspot.
* @since 7
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @permission ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION, ohos.permission.MANAGE_WIFI_HOTSPOT
* @systemapi Hide this for inner system use.
*/
function getStations(): Array;
/**
* Obtains information about a P2P connection.
*
* @return Returns the P2P connection information.
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO
*/
function getP2pLinkedInfo(): Promise;
function getP2pLinkedInfo(callback: AsyncCallback): void;
/**
* Obtains information about the current group.
*
* @return Returns the current group information.
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION
*/
function getCurrentGroup(): Promise;
function getCurrentGroup(callback: AsyncCallback): void;
/**
* Obtains the information about the found devices.
*
* @return Returns the found devices list.
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION
*/
function getP2pPeerDevices(): Promise;
function getP2pPeerDevices(callback: AsyncCallback): void;
/**
* Creates a P2P group.
*
* @param config Indicates the configuration for creating a group.
* @return Returns {@code true} if the operation is successful; returns {@code false} otherwise.
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO
*/
function createGroup(config: WifiP2PConfig): boolean;
/**
* Removes a P2P group.
*
* @return Returns {@code true} if the operation is successful; returns {@code false} otherwise.
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO
*/
function removeGroup(): boolean;
/**
* Initiates a P2P connection to a device with the specified configuration.
*
* @param config Indicates the configuration for connecting to a specific group.
* @return Returns {@code true} if the operation is successful; returns {@code false} otherwise.
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION
*/
function p2pConnect(config: WifiP2PConfig): boolean;
/**
* Canceling a P2P connection.
*
* @return Returns {@code true} if the operation is successful; returns {@code false} otherwise.
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO
*/
function p2pCancelConnect(): boolean;
/**
* Discovers Wi-Fi P2P devices.
*
* @return Returns {@code true} if the operation is successful; returns {@code false} otherwise.
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION
*/
function startDiscoverDevices(): boolean;
/**
* Stops discovering Wi-Fi P2P devices.
*
* @return Returns {@code true} if the operation is successful; returns {@code false} otherwise.
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO
*/
function stopDiscoverDevices(): boolean;
/**
* Deletes the persistent P2P group with the specified network ID.
*
* @param netId Indicates the network ID of the group to be deleted.
* @return Returns {@code true} if the operation is successful; returns {@code false} otherwise.
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.SET_WIFI_INFO, ohos.permission.MANAGE_WIFI_CONNECTION
* @systemapi Hide this for inner system use.
*/
function deletePersistentGroup(netId: number): boolean;
/**
* Sets the name of the Wi-Fi P2P device.
*
* @param devName Indicates the name to be set.
* @return Returns {@code true} if the operation is successful; returns {@code false} otherwise.
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.SET_WIFI_INFO, ohos.permission.MANAGE_WIFI_CONNECTION
* @systemapi Hide this for inner system use.
*/
function setDeviceName(devName: string): boolean;
/**
* Subscribe Wi-Fi status change events.
*
* @return Returns 0: inactive, 1: active, 2: activating, 3: deactivating
* @since 7
* @syscap SystemCapability.Communication.WiFi.STA
* @permission ohos.permission.GET_WIFI_INFO
*/
function on(type: "wifiStateChange", callback: Callback): void;
/**
* Unsubscribe Wi-Fi status change events.
*
* All callback functions will be deregistered If there is no specific callback parameter.
*
* @since 7
* @syscap SystemCapability.Communication.WiFi.STA
* @permission ohos.permission.GET_WIFI_INFO
*/
function off(type: "wifiStateChange", callback?: Callback): void;
/**
* Subscribe Wi-Fi connection change events.
*
* @return Returns 0: disconnected, 1: connected
* @since 7
* @syscap SystemCapability.Communication.WiFi.STA
* @permission ohos.permission.GET_WIFI_INFO
*/
function on(type: "wifiConnectionChange", callback: Callback): void;
/**
* Unsubscribe Wi-Fi connection change events.
*
* All callback functions will be deregistered If there is no specific callback parameter.
*
* @since 7
* @syscap SystemCapability.Communication.WiFi.STA
* @permission ohos.permission.GET_WIFI_INFO
*/
function off(type: "wifiConnectionChange", callback?: Callback): void;
/**
* Subscribe Wi-Fi scan status change events.
*
* @return Returns 0: scan fail, 1: scan success
* @since 7
* @syscap SystemCapability.Communication.WiFi.STA
* @permission ohos.permission.GET_WIFI_INFO
*/
function on(type: "wifiScanStateChange", callback: Callback): void;
/**
* Unsubscribe Wi-Fi scan status change events.
*
* All callback functions will be deregistered If there is no specific callback parameter.
*
* @since 7
* @syscap SystemCapability.Communication.WiFi.STA
* @permission ohos.permission.GET_WIFI_INFO
*/
function off(type: "wifiScanStateChange", callback?: Callback): void;
/**
* Subscribe Wi-Fi rssi change events.
*
* @return Returns RSSI value in dBm
* @since 7
* @syscap SystemCapability.Communication.WiFi.STA
* @permission ohos.permission.GET_WIFI_INFO
*/
function on(type: "wifiRssiChange", callback: Callback): void;
/**
* Unsubscribe Wi-Fi rssi change events.
*
* All callback functions will be deregistered If there is no specific callback parameter.
*
* @since 7
* @syscap SystemCapability.Communication.WiFi.STA
* @permission ohos.permission.GET_WIFI_INFO
*/
function off(type: "wifiRssiChange", callback?: Callback): void;
/**
* Subscribe Wi-Fi stream change events.
*
* @return Returns 0: stream none, 1: stream down, 2: stream up, 3: stream bidirectional
* @since 7
* @syscap SystemCapability.Communication.WiFi.STA
* @permission ohos.permission.MANAGE_WIFI_CONNECTION
* @systemapi Hide this for inner system use.
*/
function on(type: "streamChange", callback: Callback): void;
/**
* Unsubscribe Wi-Fi stream change events.
*
* All callback functions will be deregistered If there is no specific callback parameter.
*
* @since 7
* @syscap SystemCapability.Communication.WiFi.STA
* @permission ohos.permission.MANAGE_WIFI_CONNECTION
* @systemapi Hide this for inner system use.
*/
function off(type: "streamChange", callback?: Callback): void;
/**
* Subscribe Wi-Fi hotspot state change events.
*
* @return Returns 0: inactive, 1: active, 2: activating, 3: deactivating
* @since 7
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @permission ohos.permission.GET_WIFI_INFO
*/
function on(type: "hotspotStateChange", callback: Callback): void;
/**
* Unsubscribe Wi-Fi hotspot state change events.
*
* All callback functions will be deregistered If there is no specific callback parameter.
*
* @since 7
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @permission ohos.permission.GET_WIFI_INFO
*/
function off(type: "hotspotStateChange", callback?: Callback): void;
/**
* Subscribe Wi-Fi hotspot sta join events.
*
* @return Returns StationInfo
* @since 7
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @permission ohos.permission.MANAGE_WIFI_HOTSPOT
* @systemapi Hide this for inner system use.
*/
function on(type: "hotspotStaJoin", callback: Callback): void;
/**
* Unsubscribe Wi-Fi hotspot sta join events.
*
* All callback functions will be deregistered If there is no specific callback parameter.
*
* @since 7
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @permission ohos.permission.MANAGE_WIFI_HOTSPOT
* @systemapi Hide this for inner system use.
*/
function off(type: "hotspotStaJoin", callback?: Callback): void;
/**
* Subscribe Wi-Fi hotspot sta leave events.
*
* @return Returns {@link #StationInfo} object
* @since 7
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @permission ohos.permission.MANAGE_WIFI_HOTSPOT
* @systemapi Hide this for inner system use.
*/
function on(type: "hotspotStaLeave", callback: Callback): void;
/**
* Unsubscribe Wi-Fi hotspot sta leave events.
*
* @return Returns {@link #StationInfo} object
* @since 7
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @permission ohos.permission.MANAGE_WIFI_HOTSPOT
* @systemapi Hide this for inner system use.
*/
function off(type: "hotspotStaLeave", callback?: Callback): void;
/**
* Subscribe P2P status change events.
*
* @return Returns 1: idle, 2: starting, 3:started, 4: closing, 5: closed
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO
*/
function on(type: "p2pStateChange", callback: Callback): void;
/**
* Unsubscribe P2P status change events.
*
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO
*/
function off(type: "p2pStateChange", callback?: Callback): void;
/**
* Subscribe P2P connection change events.
*
* @return Returns WifiP2pLinkedInfo
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO
*/
function on(type: "p2pConnectionChange", callback: Callback): void;
/**
* Unsubscribe P2P connection change events.
*
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO
*/
function off(type: "p2pConnectionChange", callback?: Callback): void;
/**
* Subscribe P2P local device change events.
*
* @return Returns WifiP2pDevice
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION
*/
function on(type: "p2pDeviceChange", callback: Callback): void;
/**
* Unsubscribe P2P local device change events.
*
* @return Returns WifiP2pDevice
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.LOCATION
*/
function off(type: "p2pDeviceChange", callback?: Callback): void;
/**
* Subscribe P2P peer device change events.
*
* @return Returns WifiP2pDevice[]
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO, ohos.permission.LOCATION
*/
function on(type: "p2pPeerDeviceChange", callback: Callback): void;
/**
* Unsubscribe P2P peer device change events.
*
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.LOCATION
*/
function off(type: "p2pPeerDeviceChange", callback?: Callback): void;
/**
* Subscribe P2P persistent group change events.
*
* @return Returns void
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO
*/
function on(type: "p2pPersistentGroupChange", callback: Callback): void;
/**
* Unsubscribe P2P persistent group change events.
*
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO
*/
function off(type: "p2pPersistentGroupChange", callback?: Callback): void;
/**
* Subscribe P2P discovery events.
*
* @return Returns 0: initial state, 1: discovery succeeded
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO
*/
function on(type: "p2pDiscoveryChange", callback: Callback): void;
/**
* Unsubscribe P2P discovery events.
*
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
* @permission ohos.permission.GET_WIFI_INFO
*/
function off(type: "p2pDiscoveryChange", callback?: Callback): void;
/**
* Wi-Fi device configuration information.
*
* @since 6
* @syscap SystemCapability.Communication.WiFi.STA
*/
interface WifiDeviceConfig {
/** Wi-Fi SSID: the maximum length is 32 */
ssid: string;
/** Wi-Fi bssid(MAC): the length is 6 */
bssid: string;
/** Wi-Fi key: maximum length is 64 */
preSharedKey: string;
/** Hide SSID or not, false(default): not hide */
isHiddenSsid: boolean;
/** Security type: reference definition of WifiSecurityType */
securityType: WifiSecurityType;
/** The UID of the Wi-Fi configuration creator */
/* @systemapi */
creatorUid: number;
/** Disable reason */
/* @systemapi */
disableReason: number;
/** Allocated networkId */
/* @systemapi */
netId: number;
/** Random mac type */
/* @systemapi */
randomMacType: number;
/** Random mac address, the length is 6 */
/* @systemapi */
randomMacAddr: string;
/** IP Type */
/* @systemapi */
ipType: IpType;
/** IP config of static */
/* @systemapi */
staticIp: IpConfig;
}
/**
* Wi-Fi IP configuration information.
*
* @since 7
* @systemapi Hide this for inner system use.
* @syscap SystemCapability.Communication.WiFi.STA
*/
interface IpConfig {
ipAddress: number;
gateway: number;
dnsServers: number[];
domains: Array;
}
/**
* Describes the scanned Wi-Fi information.
*
* @since 6
* @syscap SystemCapability.Communication.WiFi.STA
*/
interface WifiScanInfo {
/** Wi-Fi SSID: the maximum length is 32 */
ssid: string;
/** Wi-Fi bssid(MAC): the length is 6 */
bssid: string;
/** Hotspot capability */
capabilities: string;
/** Security type: reference definition of WifiSecurityType */
securityType: WifiSecurityType;
/** Received signal strength indicator (RSSI) */
rssi: number;
/** Frequency band, 1: 2.4G, 2: 5G */
band: number;
/** Frequency */
frequency: number;
/** Channel width */
channelWidth: number;
/** Time stamp */
timestamp: number;
}
/**
* Describes the wifi security type.
*
* @since 6
* @syscap SystemCapability.Communication.WiFi.Core
*/
enum WifiSecurityType {
/** Invalid security type */
WIFI_SEC_TYPE_INVALID = 0,
/** Open */
WIFI_SEC_TYPE_OPEN = 1,
/** Wired Equivalent Privacy (WEP) */
WIFI_SEC_TYPE_WEP = 2,
/** Pre-shared key (PSK) */
WIFI_SEC_TYPE_PSK = 3,
/** Simultaneous Authentication of Equals (SAE) */
WIFI_SEC_TYPE_SAE = 4,
}
/**
* Wi-Fi connection information.
*
* @since 6
* @syscap SystemCapability.Communication.WiFi.STA
*/
interface WifiLinkedInfo {
/** The SSID of the Wi-Fi hotspot */
ssid: string;
/** The BSSID of the Wi-Fi hotspot */
bssid: string;
/** The ID(uniquely identifies) of a Wi-Fi connection. */
/* @systemapi */
networkId: number;
/** The RSSI(dBm) of a Wi-Fi access point. */
rssi: number;
/** The frequency band of a Wi-Fi access point. */
band: number;
/** The speed of a Wi-Fi access point. */
linkSpeed: number;
/** The frequency of a Wi-Fi access point. */
frequency: number;
/** Whether the SSID of the access point (AP) of this Wi-Fi connection is hidden. */
isHidden: boolean;
/** Whether this Wi-Fi connection restricts the data volume. */
isRestricted: boolean;
/** The load value of this Wi-Fi connection. A greater value indicates a higher load. */
/* @systemapi */
chload: number;
/** The signal-to-noise ratio (SNR) of this Wi-Fi connection. */
/* @systemapi */
snr: number;
/** The Wi-Fi MAC address of a device. */
macAddress: string;
/** The IP address of this Wi-Fi connection. */
ipAddress: number;
/** The state of the supplicant of this Wi-Fi connection. */
/* @systemapi */
suppState: SuppState;
/** The state of this Wi-Fi connection. */
connState: ConnState;
}
/**
* Wi-Fi IP information.
*
* @since 7
* @syscap SystemCapability.Communication.WiFi.STA
*/
interface IpInfo {
/** The IP address of the Wi-Fi connection */
ipAddress: number;
/** The gateway of the Wi-Fi connection */
gateway: number;
/** The network mask of the Wi-Fi connection */
netmask: number;
/** The primary DNS server IP address of the Wi-Fi connection */
primaryDns: number;
/** The secondary DNS server IP address of the Wi-Fi connection */
secondDns: number;
/** The DHCP server IP address of the Wi-Fi connection */
serverIp: number;
/** The IP address lease duration of the Wi-Fi connection */
leaseDuration: number;
}
/**
* Wi-Fi hotspot configuration information.
*
* @since 7
* @systemapi Hide this for inner system use.
* @syscap SystemCapability.Communication.WiFi.AP.Core
*/
interface HotspotConfig {
/** The SSID of the Wi-Fi hotspot */
ssid: string;
/** The encryption mode of the Wi-Fi hotspot */
securityType: WifiSecurityType;
/** The frequency band of the Wi-Fi hotspot */
band: number;
/** The password of the Wi-Fi hotspot */
preSharedKey: string;
/** The maximum number of connections allowed by the Wi-Fi hotspot */
maxConn: number;
}
/**
* Wi-Fi station information.
*
* @since 7
* @systemapi Hide this for inner system use.
* @syscap SystemCapability.Communication.WiFi.AP.Core
*/
interface StationInfo {
/** the network name of the Wi-Fi client */
name: string;
/** The MAC address of the Wi-Fi client */
macAddress: string;
/** The IP address of the Wi-Fi client */
ipAddress: string;
}
/**
* Wi-Fi IP type enumeration.
*
* @since 7
* @systemapi Hide this for inner system use.
* @syscap SystemCapability.Communication.WiFi.STA
*/
enum IpType {
/** Use statically configured IP settings */
STATIC,
/** Use dynamically configured IP settings */
DHCP,
/** No IP details are assigned */
UNKNOWN,
}
/**
* The state of the supplicant enumeration.
*
* @since 6
* @systemapi Hide this for inner system use.
* @syscap SystemCapability.Communication.WiFi.STA
*/
export enum SuppState {
/** The supplicant is not associated with or is disconnected from the AP. */
DISCONNECTED,
/** The network interface is disabled. */
INTERFACE_DISABLED,
/** The supplicant is disabled. */
INACTIVE,
/** The supplicant is scanning for a Wi-Fi connection. */
SCANNING,
/** The supplicant is authenticating with a specified AP. */
AUTHENTICATING,
/** The supplicant is associating with a specified AP. */
ASSOCIATING,
/** The supplicant is associated with a specified AP. */
ASSOCIATED,
/** The four-way handshake is ongoing. */
FOUR_WAY_HANDSHAKE,
/** The group handshake is ongoing. */
GROUP_HANDSHAKE,
/** All authentication is completed. */
COMPLETED,
/** Failed to establish a connection to the supplicant. */
UNINITIALIZED,
/** The supplicant is in an unknown or invalid state. */
INVALID
}
/**
* The state of Wi-Fi connection enumeration.
*
* @since 6
* @syscap SystemCapability.Communication.WiFi.STA
*/
export enum ConnState {
/** The device is searching for an available AP. */
SCANNING,
/** The Wi-Fi connection is being set up. */
CONNECTING,
/** The Wi-Fi connection is being authenticated. */
AUTHENTICATING,
/** The IP address of the Wi-Fi connection is being obtained. */
OBTAINING_IPADDR,
/** The Wi-Fi connection has been set up. */
CONNECTED,
/** The Wi-Fi connection is being torn down. */
DISCONNECTING,
/** The Wi-Fi connection has been torn down. */
DISCONNECTED,
/** Failed to set up the Wi-Fi connection. */
UNKNOWN
}
/**
* P2P device information.
*
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
*/
interface WifiP2pDevice {
/** Device name */
deviceName: string;
/** Device mac address */
deviceAddress: string;
/** Primary device type */
primaryDeviceType: string;
/** Device status */
deviceStatus: P2pDeviceStatus;
/** Device group capabilitys */
groupCapabilitys: number;
}
/**
* P2P config.
*
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
*/
interface WifiP2PConfig {
/** Device mac address */
deviceAddress: string;
/**
* Group network ID. When creating a group, -1 indicates creates a temporary group,
* -2: indicates creates a persistent group
*/
netId: number;
/* The passphrase of this {@code WifiP2pConfig} instance */
passphrase: string;
/** Group name */
groupName: string;
/** Group owner band */
goBand: GroupOwnerBand;
}
/**
* P2P group information.
*
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
*/
interface WifiP2pGroupInfo {
/** Indicates whether it is group owner */
isP2pGo: boolean;
/** Group owner information */
ownerInfo: WifiP2pDevice;
/** The group passphrase */
passphrase: string;
/** Interface name */
interface: string;
/** Group name */
groupName: string;
/** Network ID */
networkId: number;
/** Frequency */
frequency: number;
/** Client list */
clientDevices: WifiP2pDevice[];
/** Group owner IP address */
goIpAddress: string;
}
/**
* P2P connection status.
*
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
*/
enum P2pConnectState {
DISCONNECTED = 0,
CONNECTED = 1,
}
/**
* P2P linked information.
*
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
*/
interface WifiP2pLinkedInfo {
/** Connection status */
connectState: P2pConnectState;
/** Indicates whether it is group owner */
isGroupOwner: boolean;
/** Group owner address */
groupOwnerAddr: string;
}
/**
* P2P device status.
*
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
*/
enum P2pDeviceStatus {
CONNECTED = 0,
INVITED = 1,
FAILED = 2,
AVAILABLE = 3,
UNAVAILABLE = 4,
}
/**
* P2P group owner band.
*
* @since 8
* @syscap SystemCapability.Communication.WiFi.P2P
*/
enum GroupOwnerBand {
GO_BAND_AUTO = 0,
GO_BAND_2GHZ = 1,
GO_BAND_5GHZ = 2,
}
}
export default wifi;