mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-11-23 07:10:52 +00:00
a1a19b23f5
Signed-off-by: h30034439 <hanyiyichn@163.com>
868 lines
25 KiB
TypeScript
868 lines
25 KiB
TypeScript
/*
|
|
* Copyright (c) 2023-2024 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 MDMKit
|
|
*/
|
|
|
|
import type { AsyncCallback } from './@ohos.base';
|
|
import type Want from './@ohos.app.ability.Want';
|
|
|
|
/**
|
|
* This module offers set wifi policies on the devices.
|
|
*
|
|
* @namespace wifiManager
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 10
|
|
*/
|
|
declare namespace wifiManager {
|
|
/**
|
|
* Describes the wifi security type.
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
enum WifiSecurityType {
|
|
/**
|
|
* Invalid security type
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
WIFI_SEC_TYPE_INVALID = 0,
|
|
|
|
/**
|
|
* Open
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
WIFI_SEC_TYPE_OPEN = 1,
|
|
|
|
/**
|
|
* Wired Equivalent Privacy (WEP)
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
WIFI_SEC_TYPE_WEP = 2,
|
|
|
|
/**
|
|
* Pre-shared key (PSK)
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
WIFI_SEC_TYPE_PSK = 3,
|
|
|
|
/**
|
|
* Simultaneous Authentication of Equals (SAE)
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
WIFI_SEC_TYPE_SAE = 4,
|
|
|
|
/**
|
|
* EAP authentication.
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
WIFI_SEC_TYPE_EAP = 5,
|
|
|
|
/**
|
|
* SUITE_B_192 192 bit level.
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
WIFI_SEC_TYPE_EAP_SUITE_B = 6,
|
|
|
|
/**
|
|
* Opportunistic Wireless Encryption.
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
WIFI_SEC_TYPE_OWE = 7,
|
|
|
|
/**
|
|
* WAPI certificate to be specified.
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
WIFI_SEC_TYPE_WAPI_CERT = 8,
|
|
|
|
/**
|
|
* WAPI pre-shared key to be specified.
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
WIFI_SEC_TYPE_WAPI_PSK = 9
|
|
}
|
|
|
|
/**
|
|
* Wi-Fi IP type enumeration.
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
enum IpType {
|
|
/**
|
|
* Use statically configured IP settings
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
STATIC,
|
|
|
|
/**
|
|
* Use dynamically configured IP settings
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
DHCP,
|
|
|
|
/**
|
|
* No IP details are assigned
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
UNKNOWN
|
|
}
|
|
|
|
/**
|
|
* Wi-Fi IP profile.
|
|
*
|
|
* @typedef IpProfile
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
interface IpProfile {
|
|
/**
|
|
* The ip address
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
ipAddress: number;
|
|
|
|
/**
|
|
* The gateway
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
gateway: number;
|
|
|
|
/**
|
|
* The length of prefix
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
prefixLength: number;
|
|
|
|
/**
|
|
* The DNS services
|
|
*
|
|
* @type { number[] }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
dnsServers: number[];
|
|
|
|
/**
|
|
* The domains
|
|
*
|
|
* @type { Array<string> }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
domains: Array<string>;
|
|
}
|
|
|
|
/**
|
|
* Wi-Fi EAP method.
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
enum EapMethod {
|
|
/**
|
|
* Not specified
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
EAP_NONE,
|
|
|
|
/**
|
|
* Protected extensible authentication protocol
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
EAP_PEAP,
|
|
|
|
/**
|
|
* Transport layer security
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
EAP_TLS,
|
|
|
|
/**
|
|
* Tunneled transport layer security
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
EAP_TTLS,
|
|
|
|
/**
|
|
* Password
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
EAP_PWD,
|
|
|
|
/**
|
|
* Subscriber identity module
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
EAP_SIM,
|
|
|
|
/**
|
|
* Authentication and key agreement
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
EAP_AKA,
|
|
|
|
/**
|
|
* AKA prime
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
EAP_AKA_PRIME,
|
|
|
|
/**
|
|
* Unauth TLS
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
EAP_UNAUTH_TLS
|
|
}
|
|
|
|
/**
|
|
* Wi-Fi phase 2 method.
|
|
*
|
|
* @enum { number }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
enum Phase2Method {
|
|
/**
|
|
* Not specified
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
PHASE2_NONE,
|
|
|
|
/**
|
|
* Password authentication protocol
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
PHASE2_PAP,
|
|
|
|
/**
|
|
* Microsoft challenge handshake authentication protocol
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
PHASE2_MSCHAP,
|
|
|
|
/**
|
|
* Microsoft challenge handshake authentication protocol version 2
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
PHASE2_MSCHAPV2,
|
|
|
|
/**
|
|
* Generic token card
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
PHASE2_GTC,
|
|
|
|
/**
|
|
* Subscriber identity module
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
PHASE2_SIM,
|
|
|
|
/**
|
|
* Authentication and key agreement
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
PHASE2_AKA,
|
|
|
|
/**
|
|
* AKA Prime
|
|
*
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
PHASE2_AKA_PRIME
|
|
}
|
|
|
|
/**
|
|
* Wi-Fi EAP profile.
|
|
*
|
|
* @typedef WifiEapProfile
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
interface WifiEapProfile {
|
|
/**
|
|
* EAP authentication method
|
|
*
|
|
* @type { EapMethod }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
eapMethod: EapMethod;
|
|
|
|
/**
|
|
* Phase 2 authentication method
|
|
*
|
|
* @type { Phase2Method }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
phase2Method: Phase2Method;
|
|
|
|
/**
|
|
* The identity
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
identity: string;
|
|
|
|
/**
|
|
* Anonymous identity
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
anonymousIdentity: string;
|
|
|
|
/**
|
|
* Password
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
password: string;
|
|
|
|
/**
|
|
* CA certificate alias
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
caCertAliases: string;
|
|
|
|
/**
|
|
* CA certificate path
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
caPath: string;
|
|
|
|
/**
|
|
* Client certificate alias
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
clientCertAliases: string;
|
|
|
|
/**
|
|
* content of user's certificate
|
|
*
|
|
* @type { Uint8Array }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
certEntry: Uint8Array;
|
|
|
|
/**
|
|
* Password of user's certificate
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
certPassword: string;
|
|
|
|
/**
|
|
* Alternate subject match
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
altSubjectMatch: string;
|
|
|
|
/**
|
|
* Domain suffix match
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
domainSuffixMatch: string;
|
|
|
|
/**
|
|
* Realm for Passpoint credential
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
realm: string;
|
|
|
|
/**
|
|
* Public Land Mobile Network of the provider of Passpoint credential
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
plmn: string;
|
|
|
|
/**
|
|
* Sub ID of the SIM card
|
|
*
|
|
* @type { number }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
eapSubId: number;
|
|
}
|
|
|
|
/**
|
|
* Wi-Fi profile.
|
|
*
|
|
* @typedef WifiProfile
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
interface WifiProfile {
|
|
/**
|
|
* Wi-Fi SSID: the maximum length is 32
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
ssid: string;
|
|
|
|
/**
|
|
* Wi-Fi bssid(MAC): the length is 6
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
bssid?: string;
|
|
|
|
/**
|
|
* Wi-Fi key: maximum length is 64
|
|
*
|
|
* @type { string }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
preSharedKey: string;
|
|
|
|
/**
|
|
* Hide SSID or not, false(default): not hide
|
|
*
|
|
* @type { ?boolean }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
isHiddenSsid?: boolean;
|
|
|
|
/**
|
|
* Security type: reference definition of WifiSecurityType
|
|
*
|
|
* @type { WifiSecurityType }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
securityType: WifiSecurityType;
|
|
|
|
/**
|
|
* The UID of the Wi-Fi profile creator
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
creatorUid?: number;
|
|
|
|
/**
|
|
* Disable reason
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
disableReason?: number;
|
|
|
|
/**
|
|
* Allocated networkId
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
netId?: number;
|
|
|
|
/**
|
|
* Random mac type
|
|
*
|
|
* @type { ?number }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
randomMacType?: number;
|
|
|
|
/**
|
|
* Random mac address, the length is 6
|
|
*
|
|
* @type { ?string }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
randomMacAddr?: string;
|
|
|
|
/**
|
|
* IP Type
|
|
*
|
|
* @type { ?IpType }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
ipType?: IpType;
|
|
|
|
/**
|
|
* IP profile of static
|
|
*
|
|
* @type { ?IpProfile }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
staticIp?: IpProfile;
|
|
|
|
/**
|
|
* EAP profile info.
|
|
*
|
|
* @type { ?WifiEapProfile }
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
eapProfile?: WifiEapProfile;
|
|
}
|
|
|
|
/**
|
|
* Gets state of whether the wifi is active.
|
|
* This function can be called by a super administrator.
|
|
*
|
|
* @permission ohos.permission.ENTERPRISE_SET_WIFI
|
|
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
|
|
* The admin must have the corresponding permission.
|
|
* @param { AsyncCallback<boolean> } callback - the callback of isWifiActive.
|
|
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
|
|
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
|
|
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
|
|
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @systemapi
|
|
* @stagemodelonly
|
|
* @since 10
|
|
*/
|
|
function isWifiActive(admin: Want, callback: AsyncCallback<boolean>): void;
|
|
|
|
/**
|
|
* Gets state of whether the wifi is active.
|
|
* This function can be called by a super administrator.
|
|
*
|
|
* @permission ohos.permission.ENTERPRISE_SET_WIFI
|
|
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
|
|
* The admin must have the corresponding permission.
|
|
* @returns { Promise<boolean> } the promise returned by isWifiActive.
|
|
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
|
|
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
|
|
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
|
|
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @systemapi
|
|
* @stagemodelonly
|
|
* @since 10
|
|
*/
|
|
function isWifiActive(admin: Want): Promise<boolean>;
|
|
|
|
/**
|
|
* Gets state of whether the Wi-Fi is active.
|
|
* This function can be called by a super administrator.
|
|
*
|
|
* @permission ohos.permission.ENTERPRISE_MANAGE_WIFI
|
|
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
|
|
* The admin must have the corresponding permission.
|
|
* @returns { boolean } true if Wi-Fi is active.
|
|
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
|
|
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
|
|
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
function isWifiActiveSync(admin: Want): boolean;
|
|
|
|
/**
|
|
* Sets the wifi profile.
|
|
*
|
|
* @permission ohos.permission.ENTERPRISE_SET_WIFI
|
|
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
|
|
* The admin must have the corresponding permission.
|
|
* @param { WifiProfile } profile - profile indicates the profile of wifi.
|
|
* @param { AsyncCallback<void> } callback - the callback of setWifiProfile.
|
|
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
|
|
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
|
|
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
|
|
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @systemapi
|
|
* @stagemodelonly
|
|
* @since 10
|
|
*/
|
|
function setWifiProfile(admin: Want, profile: WifiProfile, callback: AsyncCallback<void>): void;
|
|
|
|
/**
|
|
* Sets the wifi profile.
|
|
*
|
|
* @permission ohos.permission.ENTERPRISE_SET_WIFI
|
|
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
|
|
* The admin must have the corresponding permission.
|
|
* @param { WifiProfile } profile - profile indicates the profile of wifi.
|
|
* @returns { Promise<void> } the promise returned by setWifiProfile.
|
|
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
|
|
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
|
|
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
|
|
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @systemapi
|
|
* @stagemodelonly
|
|
* @since 10
|
|
*/
|
|
function setWifiProfile(admin: Want, profile: WifiProfile): Promise<void>;
|
|
|
|
/**
|
|
* Sets the Wi-Fi profile.
|
|
*
|
|
* @permission ohos.permission.ENTERPRISE_MANAGE_WIFI
|
|
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
|
|
* The admin must have the corresponding permission.
|
|
* @param { WifiProfile } profile - profile indicates the profile of Wi-Fi.
|
|
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
|
|
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
|
|
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @stagemodelonly
|
|
* @since 12
|
|
*/
|
|
function setWifiProfileSync(admin: Want, profile: WifiProfile): void;
|
|
|
|
/**
|
|
* Sets the Wi-Fi disabled.
|
|
* This function can be called by a super administrator.
|
|
*
|
|
* @permission ohos.permission.ENTERPRISE_MANAGE_WIFI
|
|
* @param { Want } admin - admin indicates the enterprise admin extension ability information.
|
|
* The admin must have the corresponding permission.
|
|
* @param { boolean } disabled - true if set the Wi-Fi disabled, otherwise false.
|
|
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
|
|
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
|
|
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
|
|
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @systemapi
|
|
* @stagemodelonly
|
|
* @since 11
|
|
*/
|
|
function setWifiDisabled(admin: Want, disabled: boolean): void;
|
|
|
|
/**
|
|
* Gets state of whether the Wi-Fi is disabled.
|
|
* This function can be called by a super administrator.
|
|
*
|
|
* @permission ohos.permission.ENTERPRISE_MANAGE_WIFI
|
|
* @param { Want } admin - admin indicates the administrator ability information.If the admin is not empty, it must
|
|
* have the corresponding permission.
|
|
* @returns { boolean } true if the Wi-Fi is disabled, otherwise false.
|
|
* @throws { BusinessError } 9200001 - The application is not an administrator application of the device.
|
|
* @throws { BusinessError } 9200002 - The administrator application does not have permission to manage the device.
|
|
* @throws { BusinessError } 201 - Permission verification failed. The application does not have the permission required to call the API.
|
|
* @throws { BusinessError } 202 - Permission verification failed. A non-system application calls a system API.
|
|
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1. Mandatory parameters are left unspecified;
|
|
* 2. Incorrect parameter types; 3. Parameter verification failed.
|
|
* @syscap SystemCapability.Customization.EnterpriseDeviceManager
|
|
* @systemapi
|
|
* @stagemodelonly
|
|
* @since 11
|
|
*/
|
|
function isWifiDisabled(admin: Want): boolean;
|
|
}
|
|
|
|
export default wifiManager;
|