interface_sdk-js/api/@ohos.wifi.d.ts
hxyang111111 84837dfc97 【修改】补充syscap信息
Signed-off-by: hxyang111111 <yanghuaxia2@h-partners.com>
2024-02-02 12:41:14 +08:00

2264 lines
69 KiB
TypeScript

/*
* Copyright (C) 2021-2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit ConnectivityKit
*/
import { AsyncCallback, Callback } from './@ohos.base';
/**
* Provides methods to operate or manage Wi-Fi.
* @namespace wifi
* @since 6
*/
declare namespace wifi {
/**
* Enables Wi-Fi.
*
* @permission ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION
* @returns { boolean } Returns {@code true} if the operation is successful, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.enableWifi
*/
function enableWifi(): boolean;
/**
* Disables Wi-Fi.
*
* @permission ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION
* @returns { boolean } Returns {@code true} if the operation is successful, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.disableWifi
*/
function disableWifi(): boolean;
/**
* Queries the Wi-Fi status
*
* @permission ohos.permission.GET_WIFI_INFO
* @returns { boolean } Returns {@code true} if the Wi-Fi is active, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.isWifiActive
*/
function isWifiActive(): boolean;
/**
* Scans Wi-Fi hotspot.
*
* <p>This API works in asynchronous mode.</p>
*
* @permission ohos.permission.SET_WIFI_INFO and ohos.permission.LOCATION
* @returns { boolean } Returns {@code true} if the accessibility is succeed; returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.scan
*/
function scan(): boolean;
/**
* Obtains the hotspot information that scanned.
*
* @permission ohos.permission.GET_WIFI_INFO and (ohos.permission.GET_WIFI_PEERS_MAC or ohos.permission.LOCATION)
* @returns { Promise<Array<WifiScanInfo>> } Returns information about scanned Wi-Fi hotspot if any.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getScanInfoList
*/
function getScanInfos(): Promise<Array<WifiScanInfo>>;
/**
* Obtains the hotspot information that scanned.
*
* @permission ohos.permission.GET_WIFI_INFO and (ohos.permission.GET_WIFI_PEERS_MAC or ohos.permission.LOCATION)
* @param { AsyncCallback<Array<WifiScanInfo>> } get information about scanned Wi-Fi hotspot if any.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getScanInfoList
*/
function getScanInfos(callback: AsyncCallback<Array<WifiScanInfo>>): void;
/**
* Adds Wi-Fi connection configuration to the device.
*
* <p>The configuration will be updated when the configuration is added.</p>
*
* @permission ohos.permission.SET_WIFI_INFO and ohos.permission.SET_WIFI_CONFIG
* @param { WifiDeviceConfig } config Indicates the device configuration for connection to the Wi-Fi network.
* @returns { Promise<number> } Returns {@code networkId} if the configuration is added; returns {@code -1} otherwise.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.addDeviceConfig
*/
function addDeviceConfig(config: WifiDeviceConfig): Promise<number>;
/**
* Adds Wi-Fi connection configuration to the device.
*
* <p>The configuration will be updated when the configuration is added.</p>
*
* @permission ohos.permission.SET_WIFI_INFO and ohos.permission.SET_WIFI_CONFIG
* @param { WifiDeviceConfig } config Indicates the device configuration for connection to the Wi-Fi network.
* @param { AsyncCallback<number> }
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.addDeviceConfig
*/
function addDeviceConfig(config: WifiDeviceConfig, callback: AsyncCallback<number>): void;
/**
* Adds a specified untrusted hotspot configuration.
*
* <p>This method adds one configuration at a time. After this configuration is added,
* your device will determine whether to connect to the hotspot.
*
* @permission ohos.permission.SET_WIFI_INFO
* @param { WifiDeviceConfig } config - Indicates the device configuration for connection to the Wi-Fi network.
* @returns { Promise<boolean> } Returns {@code true} if the untrusted hotspot configuration is added, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.addCandidateConfig
*/
function addUntrustedConfig(config: WifiDeviceConfig): Promise<boolean>;
/**
* Adds a specified untrusted hotspot configuration.
*
* <p>This method adds one configuration at a time. After this configuration is added,
* your device will determine whether to connect to the hotspot.
*
* @permission ohos.permission.SET_WIFI_INFO
* @param { WifiDeviceConfig } config - Indicates the device configuration for connection to the Wi-Fi network.
* @param { AsyncCallback<boolean> }
* @syscap SystemCapability.Communication.WiFi.STA
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.addCandidateConfig
*/
function addUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback<boolean>): void;
/**
* Removes a specified untrusted hotspot configuration.
*
* <p>This method removes one configuration at a time.
*
* @permission ohos.permission.SET_WIFI_INFO
* @param { WifiDeviceConfig } config - Indicates the device configuration for connection to the Wi-Fi network.
* @returns { Promise<boolean> } Returns {@code true} if the untrusted hotspot configuration is removed, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.removeCandidateConfig
*/
function removeUntrustedConfig(config: WifiDeviceConfig): Promise<boolean>;
/**
* Removes a specified untrusted hotspot configuration.
*
* <p>This method removes one configuration at a time.
*
* @permission ohos.permission.SET_WIFI_INFO
* @param { WifiDeviceConfig } config - Indicates the device configuration for connection to the Wi-Fi network.
* @param { AsyncCallback<boolean> }
* @syscap SystemCapability.Communication.WiFi.STA
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.removeCandidateConfig
*/
function removeUntrustedConfig(config: WifiDeviceConfig, callback: AsyncCallback<boolean>): void;
/**
* Connects to Wi-Fi network.
*
* @permission ohos.permission.MANAGE_WIFI_CONNECTION
* @param { number } networkId ID of the connected network.
* @returns { boolean } Returns {@code true} if the network connection is successful, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.connectToNetwork
*/
function connectToNetwork(networkId: number): boolean;
/**
* Connects to Wi-Fi network.
*
*
* @permission ohos.permission.SET_WIFI_INFO and ohos.permission.SET_WIFI_CONFIG and
* ohos.permission.MANAGE_WIFI_CONNECTION
* @param { WifiDeviceConfig } config Indicates the device configuration for connection to the Wi-Fi network.
* @returns { boolean } Returns {@code true} if the network connection is successful, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.connectToDevice
*/
function connectToDevice(config: WifiDeviceConfig): boolean;
/**
* Disconnect Wi-Fi network.
*
* @permission ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION
* @returns { boolean } Returns {@code true} for disconnecting network success, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.disconnect
*/
function disconnect(): boolean;
/**
* Calculates the Wi-Fi signal level based on the Wi-Fi RSSI and frequency band.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { number } rssi Indicates the Wi-Fi RSSI.
* @param { number } band Indicates the Wi-Fi frequency band.
* @returns { number } Returns Wi-Fi signal level ranging from 0 to 4.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getSignalLevel
*/
function getSignalLevel(rssi: number, band: number): number;
/**
* Obtains information about a Wi-Fi connection.
*
* @permission ohos.permission.GET_WIFI_INFO
* @returns { Promise<WifiLinkedInfo> } Returns Wi-Fi linked information.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getLinkedInfo
*/
function getLinkedInfo(): Promise<WifiLinkedInfo>;
/**
* Obtains information about a Wi-Fi connection.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { AsyncCallback<WifiLinkedInfo> } get Wi-Fi linked information.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getLinkedInfo
*/
function getLinkedInfo(callback: AsyncCallback<WifiLinkedInfo>): void;
/**
* Checks whether a Wi-Fi connection has been set up.
*
* @permission ohos.permission.GET_WIFI_INFO
* @returns { boolean } Returns {@code true} if a Wi-Fi connection has been set up, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.isConnected
*/
function isConnected(): boolean;
/**
* Obtains the features supported by this device.
*
* <p>To check whether this device supports a specified feature.
*
* @permission ohos.permission.GET_WIFI_INFO
* @returns { number }Returns the features supported by this device.
* @syscap SystemCapability.Communication.WiFi.Core
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getSupportedFeatures
*/
function getSupportedFeatures(): number;
/**
* Checks whether this device supports a specified feature.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { number } featureId Indicates the ID of the feature.
* @returns { boolean } Returns {@code true} if this device supports the specified feature, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.isFeatureSupported
*/
function isFeatureSupported(featureId: number): boolean;
/**
* Obtains the MAC address of a Wi-Fi device. Wi-Fi must be enabled.
*
* <p>The MAC address is unique and cannot be changed.
*
* @permission ohos.permission.GET_WIFI_LOCAL_MAC and ohos.permission.GET_WIFI_INFO
* @returns { string[] } Returns the MAC address of the Wi-Fi device.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getDeviceMacAddress
*/
function getDeviceMacAddress(): string[];
/**
* Obtains the IP information of a Wi-Fi connection.
*
* <p>The IP information includes the host IP address, gateway address, and DNS information.
*
* @permission ohos.permission.GET_WIFI_INFO
* @returns { IpInfo } Returns the IP information of the Wi-Fi connection.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getIpInfo
*/
function getIpInfo(): IpInfo;
/**
* Obtains the country code of this device.
*
* @permission ohos.permission.GET_WIFI_INFO
* @returns { string } Returns the country code of this device.
* @syscap SystemCapability.Communication.WiFi.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getCountryCode
*/
function getCountryCode(): string;
/**
* Re-associate to current network.
*
* @permission ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION
* @returns { boolean } {@code true} if the Wi-Fi network is re-associate successfully.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.reassociate
*/
function reassociate(): boolean;
/**
* Re-connects to current network.
*
* @permission ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION
* @returns { boolean } {@code true} if the Wi-Fi network is re-connect successfully.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.reconnect
*/
function reconnect(): boolean;
/**
* Obtains the list of all existing Wi-Fi configurations.
*
* <p>You can obtain only the Wi-Fi configurations you created on your own application.
*
* @permission ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION and ohos.permission.GET_WIFI_CONFIG
* @returns { Array<WifiDeviceConfig> } sReturns the list of all existing Wi-Fi configurations you created on your application.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getDeviceConfigs
*/
function getDeviceConfigs(): Array<WifiDeviceConfig>;
/**
* Updates the specified Wi-Fi configuration.
*
* @permission ohos.permission.SET_WIFI_INFO and ohos.permission.SET_WIFI_CONFIG
* @param { WifiDeviceConfig } config Indicates the Wi-Fi configuration to update.
* @returns { number } 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.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.updateDeviceConfig
*/
function updateNetwork(config: WifiDeviceConfig): number;
/**
* Disables a specified network.
*
* <p>The disabled network will not be associated with again.
*
* @permission ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION
* @param { number } netId Identifies the network to disable.
* @returns { boolean } Returns {@code true} if the specified network is disabled, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.disableDeviceConfig
*/
function disableNetwork(netId: number): boolean;
/**
* Removes all the saved Wi-Fi configurations.
*
* @permission ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION
* @returns { boolean } Returns {@code true} if all the saved Wi-Fi configurations are removed;
* returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.removeAllDeviceConfigs
*/
function removeAllNetwork(): boolean;
/**
* Deletes a Wi-Fi network with a specified ID.
*
* <p>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.
*
* @permission ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION
* @param { number } id Indicates the ID of the Wi-Fi network,
* which can be obtained using the {@link #addDeviceConfig} or {@link #getLinkedInfo} method.
* @returns { boolean } Returns {@code true} if the Wi-Fi network is deleted successfully, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.removeDeviceConfig
*/
function removeDevice(id: number): boolean;
/**
* Enables a Wi-Fi hotspot.
*
* <p>This method is asynchronous. After the Wi-Fi hotspot is enabled, Wi-Fi may be disabled.
*
* @permission ohos.permission.MANAGE_WIFI_HOTSPOT
* @returns { boolean } Returns {@code true} if this method is called successfully, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.enableHotspot
*/
function enableHotspot(): boolean;
/**
* Disables a Wi-Fi hotspot.
*
* <p>This method is asynchronous. If Wi-Fi is enabled after the Wi-Fi hotspot is disabled, Wi-Fi may be re-enabled.
*
* @permission ohos.permission.MANAGE_WIFI_HOTSPOT
* @returns { boolean } Returns {@code true} if this method is called successfully, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.disableHotspot
*/
function disableHotspot(): boolean;
/**
* Checks whether a device serving as a Wi-Fi hotspot supports both the 2.4 GHz and 5 GHz Wi-Fi.
*
* @permission ohos.permission.GET_WIFI_INFO and ohos.permission.MANAGE_WIFI_HOTSPOT
* @returns { boolean } Returns {@code true} if the method is called successfully, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.isHotspotDualBandSupported
*/
function isHotspotDualBandSupported(): boolean;
/**
* Checks whether Wi-Fi hotspot is active on a device.
*
* @permission ohos.permission.GET_WIFI_INFO
* @returns { boolean } Returns {@code true} if Wi-Fi hotspot is enabled, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.isHotspotActive
*/
function isHotspotActive(): boolean;
/**
* Sets the hotspot for a device.
*
* <p>Only OPEN and WPA2 PSK hotspot can be configured.
*
* @permission ohos.permission.SET_WIFI_INFO and ohos.permission.GET_WIFI_CONFIG
* @param { HotspotConfig } 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.
* @returns { boolean } Returns {@code true} if the method is called successfully, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.setHotspotConfig
*/
function setHotspotConfig(config: HotspotConfig): boolean;
/**
* Obtains the Wi-Fi hotspot configuration.
*
* @permission ohos.permission.GET_WIFI_INFO and ohos.permission.GET_WIFI_CONFIG
* @returns { HotspotConfig } Returns the configuration of an existing or enabled Wi-Fi hotspot.
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getHotspotConfig
*/
function getHotspotConfig(): HotspotConfig;
/**
* Obtains the list of clients that are connected to a Wi-Fi hotspot.
*
* <p>This method can only be used on a device that serves as a Wi-Fi hotspot.
*
* @permission ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION and ohos.permission.MANAGE_WIFI_HOTSPOT
* @returns { Array<StationInfo> } Returns the list of clients that are connected to the Wi-Fi hotspot.
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getHotspotStations
*/
function getStations(): Array<StationInfo>;
/**
* Obtains information about a P2P connection.
*
* @permission ohos.permission.GET_WIFI_INFO
* @returns { Promise<WifiP2pLinkedInfo> } Returns the P2P connection information.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getP2pLinkedInfo
*/
function getP2pLinkedInfo(): Promise<WifiP2pLinkedInfo>;
/**
* Obtains information about a P2P connection.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { AsyncCallback<WifiP2pLinkedInfo> } get the P2P connection information.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getP2pLinkedInfo
*/
function getP2pLinkedInfo(callback: AsyncCallback<WifiP2pLinkedInfo>): void;
/**
* Obtains information about the current group.
*
* @permission ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
* @returns { Promise<WifiP2pGroupInfo> } Returns the current group information.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getCurrentGroup
*/
function getCurrentGroup(): Promise<WifiP2pGroupInfo>;
/**
* Obtains information about the current group.
*
* @permission ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
* @param { AsyncCallback<WifiP2pGroupInfo> } get the current group information.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getCurrentGroup
*/
function getCurrentGroup(callback: AsyncCallback<WifiP2pGroupInfo>): void;
/**
* Obtains the information about the found devices.
*
* @permission ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
* @returns { Promise<WifiP2pDevice[]> } Returns the found devices list.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getP2pPeerDevices
*/
function getP2pPeerDevices(): Promise<WifiP2pDevice[]>;
/**
* Obtains the information about the found devices.
*
* @permission ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
* @param { AsyncCallback<WifiP2pDevice[]> } Returns the found devices list.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.getP2pPeerDevices
*/
function getP2pPeerDevices(callback: AsyncCallback<WifiP2pDevice[]>): void;
/**
* Creates a P2P group.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { WifiP2PConfig } config Indicates the configuration for creating a group.
* @returns { boolean } Returns {@code true} if the operation is successful, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.createP2pGroup
*/
function createGroup(config: WifiP2PConfig): boolean;
/**
* Removes a P2P group.
*
* @permission ohos.permission.GET_WIFI_INFO
* @returns { boolean } Returns {@code true} if the operation is successful, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.removeP2pGroup
*/
function removeGroup(): boolean;
/**
* Initiates a P2P connection to a device with the specified configuration.
*
* @permission ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
* @param { WifiP2PConfig } config Indicates the configuration for connecting to a specific group.
* @returns { boolean } Returns {@code true} if the operation is successful, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.p2pConnect
*/
function p2pConnect(config: WifiP2PConfig): boolean;
/**
* Canceling a P2P connection.
*
* @permission ohos.permission.GET_WIFI_INFO
* @returns { boolean } Returns {@code true} if the operation is successful, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.p2pCancelConnect
*/
function p2pCancelConnect(): boolean;
/**
* Discover Wi-Fi P2P devices.
*
* @permission ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
* @returns { boolean } Returns {@code true} if the operation is successful, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.startDiscoverP2pDevices
*/
function startDiscoverDevices(): boolean;
/**
* Stops discovering Wi-Fi P2P devices.
*
* @permission ohos.permission.GET_WIFI_INFO
* @returns { boolean } Returns {@code true} if the operation is successful, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.stopDiscoverP2pDevices
*/
function stopDiscoverDevices(): boolean;
/**
* Deletes the persistent P2P group with the specified network ID.
*
* @permission ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION
* @param { number } Indicates the network ID of the group to be deleted.
* @returns { boolean } Returns {@code true} if the operation is successful, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.P2P
* @systemapi Hide this for inner system use.
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.deletePersistentP2pGroup
*/
function deletePersistentGroup(netId: number): boolean;
/**
* Sets the name of the Wi-Fi P2P device.
*
* @permission ohos.permission.SET_WIFI_INFO and ohos.permission.MANAGE_WIFI_CONNECTION
* @param { string } devName Indicates the name to be set.
* @returns { boolean } Returns {@code true} if the operation is successful, returns {@code false} otherwise.
* @syscap SystemCapability.Communication.WiFi.P2P
* @systemapi Hide this for inner system use.
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.setP2pDeviceName
*/
function setDeviceName(devName: string): boolean;
/**
* Subscribe Wi-Fi status change events.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'wifiStateChange' } type - event name.
* @param { Callback<number> } callback - the callback of on, 0: inactive, 1: active, 2: activating, 3: de-activating
* @syscap SystemCapability.Communication.WiFi.STA
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.on#event:wifiStateChange
*/
function on(type: 'wifiStateChange', callback: Callback<number>): void;
/**
* Unsubscribe Wi-Fi status change events.
*
* <p>All callback functions will be deregistered If there is no specific callback parameter.</p>
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'wifiStateChange' } type - event name.
* @param { Callback<number> } callback - the callback of on, 0: inactive, 1: active, 2: activating, 3: de-activating
* @syscap SystemCapability.Communication.WiFi.STA
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.off#event:wifiStateChange
*/
function off(type: 'wifiStateChange', callback?: Callback<number>): void;
/**
* Subscribe Wi-Fi connection change events.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'wifiConnectionChange' } type - event name.
* @param { Callback<number> } callback - the callback of on, 0: disconnected, 1: connected
* @syscap SystemCapability.Communication.WiFi.STA
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.on#event:wifiConnectionChange
*/
function on(type: 'wifiConnectionChange', callback: Callback<number>): void;
/**
* Unsubscribe Wi-Fi connection change events.
*
* <p>All callback functions will be deregistered If there is no specific callback parameter.</p>
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'wifiConnectionChange' } type - event name.
* @param { Callback<number> } callback - the callback of on, 0: disconnected, 1: connected
* @syscap SystemCapability.Communication.WiFi.STA
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.off#event:wifiConnectionChange
*/
function off(type: 'wifiConnectionChange', callback?: Callback<number>): void;
/**
* Subscribe Wi-Fi scan status change events.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'wifiScanStateChange' } type - event name.
* @param { Callback<number> } callback - the callback of on, 0: scan fail, 1: scan success
* @syscap SystemCapability.Communication.WiFi.STA
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.on#event:wifiScanStateChange
*/
function on(type: 'wifiScanStateChange', callback: Callback<number>): void;
/**
* Unsubscribe Wi-Fi scan status change events.
*
* <p>All callback functions will be deregistered If there is no specific callback parameter.</p>
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'wifiScanStateChange' } type - event name.
* @param { Callback<number> } callback - the callback of on, 0: scan fail, 1: scan success
* @syscap SystemCapability.Communication.WiFi.STA
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.off#event:wifiScanStateChange
*/
function off(type: 'wifiScanStateChange', callback?: Callback<number>): void;
/**
* Subscribe Wi-Fi rssi change events.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'wifiRssiChange' } type - event name.
* @param { Callback<number> } callback - the callback of on
* @syscap SystemCapability.Communication.WiFi.STA
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.on#event:wifiRssiChange
*/
function on(type: 'wifiRssiChange', callback: Callback<number>): void;
/**
* Unsubscribe Wi-Fi rssi change events.
*
* <p>All callback functions will be deregistered If there is no specific callback parameter.</p>
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'wifiRssiChange' } type - event name.
* @param { Callback<number> } callback - the callback of on
* @syscap SystemCapability.Communication.WiFi.STA
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.off#event:wifiRssiChange
*/
function off(type: 'wifiRssiChange', callback?: Callback<number>): void;
/**
* Subscribe Wi-Fi stream change events.
*
* @permission ohos.permission.MANAGE_WIFI_CONNECTION
* @param { 'streamChange' } type - event name.
* @param { Callback<number> } callback - the callback of on, 1: stream down, 2: stream up, 3: stream bidirectional
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.on#event:streamChange
*/
function on(type: 'streamChange', callback: Callback<number>): void;
/**
* Unsubscribe Wi-Fi stream change events.
*
* <p>All callback functions will be deregistered If there is no specific callback parameter.</p>
*
* @permission ohos.permission.MANAGE_WIFI_CONNECTION
* @param { 'streamChange' } type - event name.
* @param { Callback<number> } callback - the callback of on, 1: stream down, 2: stream up, 3: stream bidirectional
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.off#event:streamChange
*/
function off(type: 'streamChange', callback?: Callback<number>): void;
/**
* Subscribe Wi-Fi hotspot state change events.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'hotspotStateChange' } type - event name.
* @param { Callback<number> } callback - the callback of on, 0: inactive, 1: active, 2: activating, 3: de-activating
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.on#event:hotspotStateChange
*/
function on(type: 'hotspotStateChange', callback: Callback<number>): void;
/**
* Unsubscribe Wi-Fi hotspot state change events.
*
* <p>All callback functions will be deregistered If there is no specific callback parameter.</p>
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'hotspotStateChange' } type - event name.
* @param { Callback<number> } callback - the callback of on, 0: inactive, 1: active, 2: activating, 3: de-activating
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.off#event:hotspotStateChange
*/
function off(type: 'hotspotStateChange', callback?: Callback<number>): void;
/**
* Subscribe Wi-Fi hotspot sta join events.
*
* @permission ohos.permission.MANAGE_WIFI_HOTSPOT
* @param { 'hotspotStaJoin' } type - event name.
* @param { Callback<StationInfo> } callback - the callback of on
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.on#event:hotspotStaJoin
*/
function on(type: 'hotspotStaJoin', callback: Callback<StationInfo>): void;
/**
* Unsubscribe Wi-Fi hotspot sta join events.
*
* <p>All callback functions will be deregistered If there is no specific callback parameter.</p>
*
* @permission ohos.permission.MANAGE_WIFI_HOTSPOT
* @param { 'hotspotStaJoin' } type - event name.
* @param { Callback<StationInfo> } callback - the callback of on
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.off#event:hotspotStaJoin
*/
function off(type: 'hotspotStaJoin', callback?: Callback<StationInfo>): void;
/**
* Subscribe Wi-Fi hotspot sta leave events.
*
* @permission ohos.permission.MANAGE_WIFI_HOTSPOT
* @param { 'hotspotStaLeave' } type - event name.
* @param { Callback<StationInfo> } callback - the callback of on
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.on#event:hotspotStaLeave
*/
function on(type: 'hotspotStaLeave', callback: Callback<StationInfo>): void;
/**
* Unsubscribe Wi-Fi hotspot sta leave events.
* @permission ohos.permission.MANAGE_WIFI_HOTSPOT
* @param { 'hotspotStaLeave' } type - event name.
* @param { Callback<StationInfo> } callback - the callback of on
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.off#event:hotspotStaLeave
*/
function off(type: 'hotspotStaLeave', callback?: Callback<StationInfo>): void;
/**
* Subscribe P2P status change events.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'p2pStateChange' } type - event name.
* @param { Callback<number> } callback - the callback of on, 1: idle, 2: starting, 3:started, 4: closing, 5: closed
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.on#event:p2pStateChange
*/
function on(type: 'p2pStateChange', callback: Callback<number>): void;
/**
* Unsubscribe P2P status change events.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'p2pStateChange' } type - event name.
* @param { Callback<number> } callback - the callback of on, 1: idle, 2: starting, 3:started, 4: closing, 5: closed
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.off#event:p2pStateChange
*/
function off(type: 'p2pStateChange', callback?: Callback<number>): void;
/**
* Subscribe P2P connection change events.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'p2pConnectionChange' } type - event name.
* @param { Callback<WifiP2pLinkedInfo> } callback - the callback of on
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.on#event:p2pConnectionChange
*/
function on(type: 'p2pConnectionChange', callback: Callback<WifiP2pLinkedInfo>): void;
/**
* Unsubscribe P2P connection change events.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'p2pConnectionChange' } type - event name.
* @param { Callback<WifiP2pLinkedInfo> } callback - the callback of on
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.off#event:p2pConnectionChange
*/
function off(type: 'p2pConnectionChange', callback?: Callback<WifiP2pLinkedInfo>): void;
/**
* Subscribe P2P local device change events.
*
* @permission ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
* @param { 'p2pDeviceChange' } type - event name.
* @param { Callback<WifiP2pDevice> } callback - the callback of on
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.on#event:p2pDeviceChange
*/
function on(type: 'p2pDeviceChange', callback: Callback<WifiP2pDevice>): void;
/**
* Unsubscribe P2P local device change events.
*
* @permission ohos.permission.LOCATION
* @param { 'p2pDeviceChange' } type - event name.
* @param { Callback<WifiP2pDevice> } callback - the callback of on
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.off#event:p2pDeviceChange
*/
function off(type: 'p2pDeviceChange', callback?: Callback<WifiP2pDevice>): void;
/**
* Subscribe P2P peer device change events.
*
* @permission ohos.permission.GET_WIFI_INFO and ohos.permission.LOCATION
* @param { 'p2pPeerDeviceChange' } type - event name.
* @param { Callback<WifiP2pDevice[]> } callback - the callback of on
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.on#event:p2pPeerDeviceChange
*/
function on(type: 'p2pPeerDeviceChange', callback: Callback<WifiP2pDevice[]>): void;
/**
* Unsubscribe P2P peer device change events.
*
* @permission ohos.permission.LOCATION
* @param { 'p2pPeerDeviceChange' } type - event name.
* @param { Callback<WifiP2pDevice[]> } callback - the callback of on
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.off#event:p2pPeerDeviceChange
*/
function off(type: 'p2pPeerDeviceChange', callback?: Callback<WifiP2pDevice[]>): void;
/**
* Subscribe P2P persistent group change events.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'p2pPersistentGroupChange' } type - event name.
* @param { Callback<void> } callback - the callback of on
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.on#event:p2pPersistentGroupChange
*/
function on(type: 'p2pPersistentGroupChange', callback: Callback<void>): void;
/**
* Unsubscribe P2P persistent group change events.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'p2pPersistentGroupChange' } type - event name.
* @param { Callback<void> } callback - the callback of on
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.off#event:p2pPersistentGroupChange
*/
function off(type: 'p2pPersistentGroupChange', callback?: Callback<void>): void;
/**
* Subscribe P2P discovery events.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'p2pDiscoveryChange' } type - event name.
* @param { Callback<number> } callback - the callback of on
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.on#event:p2pDiscoveryChange
*/
function on(type: 'p2pDiscoveryChange', callback: Callback<number>): void;
/**
* Unsubscribe P2P discovery events.
*
* @permission ohos.permission.GET_WIFI_INFO
* @param { 'p2pDiscoveryChange' } type - event name.
* @param { Callback<number> } callback - the callback of on
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.off#event:p2pDiscoveryChange
*/
function off(type: 'p2pDiscoveryChange', callback?: Callback<number>): void;
/**
* Wi-Fi device configuration information.
*
* @interface WifiDeviceConfig
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.WifiDeviceConfig
*/
interface WifiDeviceConfig {
/** Wi-Fi SSID: the maximum length is 32
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
ssid: string;
/** Wi-Fi bssid(MAC): the length is 6
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
bssid: string;
/** Wi-Fi key: maximum length is 64
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
preSharedKey: string;
/** Hide SSID or not, false(default): not hide
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
isHiddenSsid: boolean;
/** Security type: reference definition of WifiSecurityType
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
securityType: WifiSecurityType;
/** The UID of the Wi-Fi configuration creator
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
/* @systemapi */
creatorUid: number;
/** Disable reason
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
/* @systemapi */
disableReason: number;
/** Allocated networkId
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
/* @systemapi */
netId: number;
/** Random mac type
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
/* @systemapi */
randomMacType: number;
/** Random mac address, the length is 6
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
/* @systemapi */
randomMacAddr: string;
/** IP Type
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
/* @systemapi */
ipType: IpType;
/** IP config of static
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
/* @systemapi */
staticIp: IpConfig;
}
/**
* Wi-Fi IP configuration information.
*
* @interface IpConfig
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.IpConfig
*/
interface IpConfig {
/**
* IP address.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
*/
ipAddress: number;
/**
* Gate way.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
*/
gateway: number;
/**
* DNS servers.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
*/
dnsServers: number[];
/**
* Domains.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
*/
domains: Array<string>;
}
/**
* Describes the scanned Wi-Fi information.
*
* @interface WifiScanInfo
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.WifiScanInfo
*/
interface WifiScanInfo {
/** Wi-Fi SSID: the maximum length is 32
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
ssid: string;
/** Wi-Fi bssid(MAC): the length is 6
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
bssid: string;
/** Hotspot capability
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
capabilities: string;
/** Security type: reference definition of WifiSecurityType
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
securityType: WifiSecurityType;
/** Received signal strength indicator (RSSI)
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
rssi: number;
/** Frequency band, 1: 2.4G, 2: 5G
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
band: number;
/** Frequency
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
frequency: number;
/** Channel width
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
channelWidth: number;
/**
* Time stamp
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
timestamp: number;
}
/**
* Describes the wifi security type.
*
* @enum { number } WifiSecurityType
* @syscap SystemCapability.Communication.WiFi.Core
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.WifiSecurityType
*/
enum WifiSecurityType {
/** Invalid security type
* @syscap SystemCapability.Communication.WiFi.Core
* @since 6
* @deprecated since 9
*/
WIFI_SEC_TYPE_INVALID = 0,
/** Open
* @syscap SystemCapability.Communication.WiFi.Core
* @since 6
* @deprecated since 9
*/
WIFI_SEC_TYPE_OPEN = 1,
/**
* Wired Equivalent Privacy (WEP)
* @syscap SystemCapability.Communication.WiFi.Core
* @since 6
* @deprecated since 9
* */
WIFI_SEC_TYPE_WEP = 2,
/**
* Pre-shared key (PSK)
* @syscap SystemCapability.Communication.WiFi.Core
* @since 6
* @deprecated since 9
* */
WIFI_SEC_TYPE_PSK = 3,
/**
* Simultaneous Authentication of Equals (SAE)
* @syscap SystemCapability.Communication.WiFi.Core
* @since 6
* @deprecated since 9
* */
WIFI_SEC_TYPE_SAE = 4,
}
/**
* Wi-Fi connection information.
*
* @interface WifiLinkedInfo
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.WifiLinkedInfo
*/
interface WifiLinkedInfo {
/**
* The SSID of the Wi-Fi hotspot
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
ssid: string;
/**
* The BSSID of the Wi-Fi hotspot
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
bssid: string;
/**
* The ID(uniquely identifies) of a Wi-Fi connection.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
/* @systemapi */
networkId: number;
/**
* The RSSI(dBm) of a Wi-Fi access point.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
rssi: number;
/**
* The frequency band of a Wi-Fi access point.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
band: number;
/**
* The speed of a Wi-Fi access point.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
linkSpeed: number;
/**
* The frequency of a Wi-Fi access point.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
frequency: number;
/**
* Whether the SSID of the access point (AP) of this Wi-Fi connection is hidden.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
isHidden: boolean;
/**
* Whether this Wi-Fi connection restricts the data volume.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
*/
isRestricted: boolean;
/**
*
* The load value of this Wi-Fi connection. A greater value indicates a higher load.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
/* @systemapi */
chload: number;
/**
* The signal-to-noise ratio (SNR) of this Wi-Fi connection.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
/* @systemapi */
snr: number;
/**
*
* The Wi-Fi MAC address of a device.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
macAddress: string;
/**
* The IP address of this Wi-Fi connection.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
ipAddress: number;
/**
*
* The state of the supplicant of this Wi-Fi connection.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
/* @systemapi */
suppState: SuppState;
/**
* The state of this Wi-Fi connection.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
connState: ConnState;
}
/**
* Wi-Fi IP information.
*
* @interface IpInfo
* @syscap SystemCapability.Communication.WiFi.STA
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.IpInfo
*/
interface IpInfo {
/**
* The IP address of the Wi-Fi connection
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @since 7
* @deprecated since 9
* */
ipAddress: number;
/**
* The gateway of the Wi-Fi connection
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @since 7
* @deprecated since 9
* */
gateway: number;
/**
* The network mask of the Wi-Fi connection
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @since 7
* @deprecated since 9
* */
netmask: number;
/**
*
* The primary DNS server IP address of the Wi-Fi connection
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @since 7
* @deprecated since 9
* */
primaryDns: number;
/** T
* he secondary DNS server IP address of the Wi-Fi connection
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @since 7
* @deprecated since 9
* */
secondDns: number;
/**
* The DHCP server IP address of the Wi-Fi connection
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @since 7
* @deprecated since 9
* */
serverIp: number;
/**
* The IP address lease duration of the Wi-Fi connection
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @since 7
* @deprecated since 9
* */
leaseDuration: number;
}
/**
* Wi-Fi hotspot configuration information.
*
* @interface HotspotConfig
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.HotspotConfig
*/
interface HotspotConfig {
/**
* The SSID of the Wi-Fi hotspot
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi
* @since 7
* @deprecated since 9
* */
ssid: string;
/**
* The encryption mode of the Wi-Fi hotspot
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi
* @since 7
* @deprecated since 9
* */
securityType: WifiSecurityType;
/**
* The frequency band of the Wi-Fi hotspot
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi
* @since 7
* @deprecated since 9
* */
band: number;
/**
* The password of the Wi-Fi hotspot
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi
* @since 7
* @deprecated since 9
* */
preSharedKey: string;
/**
* The maximum number of connections allowed by the Wi-Fi hotspot
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi
* @since 7
* @deprecated since 9
* */
maxConn: number;
}
/**
* Wi-Fi station information.
*
* @interface StationInfo
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.StationInfo
*/
interface StationInfo {
/**
* the network name of the Wi-Fi client
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi
* @since 7
* @deprecated since 9
* */
name: string;
/**
* The MAC address of the Wi-Fi client
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi
* @since 7
* @deprecated since 9
* */
macAddress: string;
/**
* The IP address of the Wi-Fi client
* @syscap SystemCapability.Communication.WiFi.AP.Core
* @systemapi
* @since 7
* @deprecated since 9
* */
ipAddress: string;
}
/**
* Wi-Fi IP type enumeration.
*
* @enum { number } IpType
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 7
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.IpType
*/
enum IpType {
/**
* Use statically configured IP settings
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi
* @since 7
* @deprecated since 9
* */
STATIC,
/**
* Use dynamically configured IP settings
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi
* @since 7
* @deprecated since 9
* */
DHCP,
/**
* No IP details are assigned
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi
* @since 7
* @deprecated since 9
* */
UNKNOWN,
}
/**
* The state of the supplicant enumeration.
*
* @enum { number } SuppState
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi Hide this for inner system use.
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.SuppState
*/
export enum SuppState {
/** The supplicant is not associated with or is disconnected from the AP.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi
* @since 6
* @deprecated since 9
*/
DISCONNECTED,
/**
* The network interface is disabled.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi
* @since 6
* @deprecated since 9
* */
INTERFACE_DISABLED,
/**
* The supplicant is disabled.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi
* @since 6
* @deprecated since 9
* */
INACTIVE,
/**
* The supplicant is scanning for a Wi-Fi connection.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi
* @since 6
* @deprecated since 9
* */
SCANNING,
/**
* The supplicant is authenticating with a specified AP.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi
* @since 6
* @deprecated since 9
* */
AUTHENTICATING,
/**
* The supplicant is associating with a specified AP.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi
* @since 6
* @deprecated since 9
* */
ASSOCIATING,
/**
* The supplicant is associated with a specified AP.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi
* @since 6
* @deprecated since 9
* */
ASSOCIATED,
/**
* The four-way handshake is ongoing.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi
* @since 6
* @deprecated since 9
* */
FOUR_WAY_HANDSHAKE,
/** The group handshake is ongoing.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi
* @since 6
* @deprecated since 9
*/
GROUP_HANDSHAKE,
/**
* All authentication is completed.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi
* @since 6
* @deprecated since 9
* */
COMPLETED,
/**
* Failed to establish a connection to the supplicant.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi
* @since 6
* @deprecated since 9
* */
UNINITIALIZED,
/**
* The supplicant is in an unknown or invalid state.
* @syscap SystemCapability.Communication.WiFi.STA
* @systemapi
* @since 6
* @deprecated since 9
* */
INVALID
}
/**
* The state of Wi-Fi connection enumeration.
*
* @enum { number } ConnState
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.ConnState
*/
export enum ConnState {
/**
* The device is searching for an available AP.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
SCANNING,
/**
* The Wi-Fi connection is being set up.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
CONNECTING,
/**
* The Wi-Fi connection is being authenticated.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
AUTHENTICATING,
/**
* The IP address of the Wi-Fi connection is being obtained.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
OBTAINING_IPADDR,
/**
* The Wi-Fi connection has been set up.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
CONNECTED,
/**
* The Wi-Fi connection is being torn down.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
DISCONNECTING,
/**
* The Wi-Fi connection has been torn down.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
DISCONNECTED,
/**
* Failed to set up the Wi-Fi connection.
* @syscap SystemCapability.Communication.WiFi.STA
* @since 6
* @deprecated since 9
* */
UNKNOWN
}
/**
* P2P device information.
*
* @interface WifiP2pDevice
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.WifiP2pDevice
*/
interface WifiP2pDevice {
/**
* Device name
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
deviceName: string;
/**
* Device mac address
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
deviceAddress: string;
/**
* Primary device type
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
primaryDeviceType: string;
/**
* Device status
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
deviceStatus: P2pDeviceStatus;
/**
* Device group capabilities
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
groupCapabilitys: number;
}
/**
* P2P config.
* @interface WifiP2PConfig
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.WifiP2PConfig
*/
interface WifiP2PConfig {
/**
* Device mac address s
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
*/
deviceAddress: string;
/**
* Group network ID. When creating a group, -1 indicates creates a temporary group,
* -2: indicates creates a persistent group
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
*/
netId: number;
/**
* The passphrase of this {@code WifiP2pConfig} instance
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
passphrase: string;
/**
* Group name
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
groupName: string;
/**
* Group owner band
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
goBand: GroupOwnerBand;
}
/**
* P2P group information.
* @interface WifiP2pGroupInfo
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.WifiP2pGroupInfo
*/
interface WifiP2pGroupInfo {
/**
* Indicates whether it is group owner
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
isP2pGo: boolean;
/**
* Group owner information
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
ownerInfo: WifiP2pDevice;
/**
* The group passphrase
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
passphrase: string;
/**
* Interface name
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
interface: string;
/**
* Group name
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
groupName: string;
/** Network ID
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
*/
networkId: number;
/** Frequency
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
*/
frequency: number;
/**
* Client list
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
clientDevices: WifiP2pDevice[];
/**
* Group owner IP address
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
goIpAddress: string;
}
/**
* P2P connection status.
*
* @enum { number } P2pConnectState
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.P2pConnectState
*/
enum P2pConnectState {
/**
* p2p is disconnected.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
*/
DISCONNECTED = 0,
/**
* p2p is connected.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
*/
CONNECTED = 1,
}
/**
* P2P linked information.
* @typedef WifiP2pLinkedInfo
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.WifiP2pLinkedInfo
*/
interface WifiP2pLinkedInfo {
/**
* Connection status
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
connectState: P2pConnectState;
/**
* Indicates whether it is group owner
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
isGroupOwner: boolean;
/**
* Group owner address
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* */
groupOwnerAddr: string;
}
/**
* P2P device status.
*
* @enum { number } P2pDeviceStatus
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.P2pDeviceStatus
*/
enum P2pDeviceStatus {
/**
* Indicate p2p device is connected.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
*/
CONNECTED = 0,
/**
* Indicate p2p device is invited.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
*/
INVITED = 1,
/**
* Indicate p2p device is failed.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
*/
FAILED = 2,
/**
* Indicate p2p device is available.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
*/
AVAILABLE = 3,
/**
* Indicate p2p device is unavailable.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
*/
UNAVAILABLE = 4,
}
/**
* P2P group owner band.
*
* @enum { number } GroupOwnerBand
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
* @useinstead ohos.wifiManager/wifiManager.GroupOwnerBand
*/
enum GroupOwnerBand {
/**
* default band.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
*/
GO_BAND_AUTO = 0,
/**
* 2.4G band.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
*/
GO_BAND_2GHZ = 1,
/**
* 5G band.
* @syscap SystemCapability.Communication.WiFi.P2P
* @since 8
* @deprecated since 9
*/
GO_BAND_5GHZ = 2,
}
}
export default wifi;