程序包 ohos.wifi

类 WifiDeviceConfig

java.lang.Object

ohos.wifi.WifiDeviceConfig

所有已实现的接口:

Sequenceable

public final class WifiDeviceConfig
extends Object
implements Sequenceable

Provides the configuration of a Wi-Fi access point.

Using this to connect to a Wi-Fi access point with specified configuration, including the SSID, encryption mode, and password.

从以下版本开始:

5

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

Sequenceable.Producer<T>

构造器概要

构造器

构造器	说明
WifiDeviceConfig()	A constructor used to create a WifiDeviceConfig instance with default parameters.

方法概要

限定符和类型	方法	说明
String	getBssid()	Obtains the BSSID in the Wi-Fi configuration.
String	getPreSharedKey()	Obtains the password in the Wi-Fi configuration.
int	getSecurityType()	Obtains the encryption mode in the Wi-Fi configuration.
String	getSsid()	Obtains the SSID in the Wi-Fi configuration.
boolean	isHiddenSsid()	Checks whether the Wi-Fi access point broadcasts the SSID.
boolean	isRestricted()	Checks whether the data volume is not restricted in this network.
boolean	marshalling(Parcel out)	Writes a Sequenceable object into a Parcel for Wifi Device Config.
void	setHiddenSsid(boolean isHiddenSsid)	Hides an SSID for a Wi-Fi access point.
void	setPreSharedKey(String preSharedKey)	Sets the password of a Wi-Fi access point.
void	setRestricted(boolean isDataRestricted)	Sets whether to restrict the data volume in this network.
void	setSecurityType(int securityType)	Sets the encryption mode of a Wi-Fi access point.
void	setSsid(String ssid)	Sets the SSID name of a Wi-Fi access point.
boolean	unmarshalling(Parcel in)	Restores a Sequenceable object from a Parcel for Wifi Device Config.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 ohos.utils.Sequenceable

hasFileDescriptor

构造器详细资料

WifiDeviceConfig

public WifiDeviceConfig()

A constructor used to create a WifiDeviceConfig instance with default parameters.

从以下版本开始:

5

方法详细资料

marshalling

public boolean marshalling(Parcel out)

Writes a Sequenceable object into a Parcel for Wifi Device Config.

指定者:

marshalling 在接口中 Sequenceable

参数:

out - Indicates the Parcel object to which the Sequenceable object will be written.

返回:

Returns true if the marshalling is successful; returns false otherwise.

从以下版本开始:

5

unmarshalling

public boolean unmarshalling(Parcel in)

Restores a Sequenceable object from a Parcel for Wifi Device Config.

指定者:

unmarshalling 在接口中 Sequenceable

参数:

in - Indicates the Parcel object into which the Sequenceable object has been written.

返回:

Returns true if the unmarshalling is successful; returns false otherwise.

从以下版本开始:

5

getSsid

public String getSsid()

Obtains the SSID in the Wi-Fi configuration.

The SSID is in UTF-8 format.

返回:

Returns the SSID.

从以下版本开始:

5

setSsid

public void setSsid(String ssid)

Sets the SSID name of a Wi-Fi access point.

The SSID must be in UTF-8 format and can contain a maximum of 32 characters.

参数:

ssid - Indicates the SSID name to be set.

从以下版本开始:

5

getBssid

public String getBssid()

Obtains the BSSID in the Wi-Fi configuration.

The BSSID is in XX:XX:XX:XX:XX:XX format.

返回:

Returns the BSSID; returns null if BSSID is not configured.

从以下版本开始:

5

getPreSharedKey

public String getPreSharedKey()

Obtains the password in the Wi-Fi configuration.

If PSK encryption is used, a password is mandatory.

返回:

Returns the password; returns null if no password is configured.

从以下版本开始:

5

setPreSharedKey

public void setPreSharedKey(String preSharedKey)

Sets the password of a Wi-Fi access point.

If the PSK encryption mode is used, a password is mandatory.

Note: The password can only contain ASCII characters.

参数:

preSharedKey - Indicates the password of the Wi-Fi access point.

从以下版本开始:

5

isHiddenSsid

public boolean isHiddenSsid()

Checks whether the Wi-Fi access point broadcasts the SSID.

During a Wi-Fi scanning, the SSID of a Wi-Fi access point that is not hidden is contained in the request frame.

返回:

Returns true if a hidden SSID is configured; returns false otherwise.

从以下版本开始:

5

setHiddenSsid

public void setHiddenSsid(boolean isHiddenSsid)

Hides an SSID for a Wi-Fi access point.

参数:

isHiddenSsid - Specifies whether to hide the SSID. The value true indicates that the SSID is hidden, and the value false indicates that the SSID is not hidden.

从以下版本开始:

5

getSecurityType

public int getSecurityType()

Obtains the encryption mode in the Wi-Fi configuration.

An example encryption mode is WifiSecurity#PSK.

返回:

Returns the encryption mode.

从以下版本开始:

5

另请参阅:

WifiSecurity.PSK

setSecurityType

public void setSecurityType(int securityType)

Sets the encryption mode of a Wi-Fi access point.

If the PSK encryption mode is used, a password must be set using setPreSharedKey(java.lang.String).

参数:

securityType - Indicates the encryption mode to be set, such as WifiSecurity#PSK.

从以下版本开始:

5

另请参阅:

WifiSecurity.PSK

isRestricted

public boolean isRestricted()

Checks whether the data volume is not restricted in this network.

返回:

Returns true if the data volume is not restricted in this network; returns false otherwise.

从以下版本开始:

5

setRestricted

public void setRestricted(boolean isDataRestricted)

Sets whether to restrict the data volume in this network.

参数:

isDataRestricted - Specifies whether to restrict the data volume in this network. The value true indicates that the data volume is restricted, and value false indicates that the data volume is not restricted.

从以下版本开始:

5