Class WiFiAP

Definition

Namespace:: Tizen.Network.WiFi

Assembly:: Tizen.Network.WiFi.dll

A class for managing the network information of the access point (AP).

public class WiFiAP : IDisposable

Inheritance: object

WiFiAP

Constructors

View Source

WiFiAP(string, bool)

Creates an object for the hidden access point.

Declaration

public WiFiAP(string essid, bool hidden)

Parameters

Type	Name	Description
string	essid	The Extended Service Set Identifier of the access point.
bool	hidden	The value to set a hidden AP.

View Source

WiFiAP(string)

Creates an object for the access point.

Declaration

public WiFiAP(string essid)

Parameters

Type	Name	Description
string	essid	The Extended Service Set Identifier of the access point.

Properties

View Source

NetworkInformation

The network information of the access point (AP).

Declaration

public WiFiNetwork NetworkInformation { get; }

Property Value

Type	Description
WiFiNetwork	The WiFiNetwork instance containing the network information of the AP.

View Source

SecurityInformation

The security information of the access point (AP).

Declaration

public WiFiSecurity SecurityInformation { get; }

Property Value

Type	Description
WiFiSecurity	The WiFiSecurity instance containing security information of the AP.

Methods

View Source

CancelWps()

Stops ongoing WPS provisioning

Declaration

public static void CancelWps()

View Source

ConnectAsync()

Connects the access point asynchronously.

Declaration

public Task ConnectAsync()

Returns

Type	Description
Task	A task indicating whether the connect method is done or not.

Remarks

This method must be called from MainThread.

Exceptions

Type	Condition
NowInProgressException	Thrown when the Wi-Fi connection is now in progress.
InvalidKeyException	Thrown when the key is wrong.

View Source

ConnectWpsAsync(WpsInfo)

Connects the access point with the WPS asynchronously.

Declaration

public Task ConnectWpsAsync(WpsInfo info)

Parameters

Type	Name	Description
WpsInfo	info	A WpsInfo instance which is type of WpsPbcInfo or WpsPinInfo.

Returns

Type	Description
Task	A task indicating whether the ConnectWps method is done or not.

Remarks

This method must be called from MainThread.

Exceptions

Type	Condition
NowInProgressException	Thrown when the Wi-Fi connection is now in progress.

View Source

ConnectWpsWithoutSsidAsync(WpsInfo)

Connects the access point with WPS without SSID asynchronously.

Declaration

public static Task<WiFiAP> ConnectWpsWithoutSsidAsync(WpsInfo info)

Parameters

Type	Name	Description
WpsInfo	info	A WpsInfo instance which is of type WpsPbcInfo or WpsPinInfo.

Returns

Type	Description
Task<><WiFiAP>	A task which contains Connected access point information.

Remarks

If WpsPinInfo is used, its object has to be constructed with a pin which must be 4 or 8 characters long. \n This method must be called from MainThread.

Exceptions

Type	Condition
NowInProgressException	Thrown when the Wi-Fi connection is now in progress.

View Source

DisconnectAsync()

Disconnects the access point asynchronously.

Declaration

public Task DisconnectAsync()

Returns

Type	Description
Task	A task indicating whether the disconnect method is done or not.

Remarks

This method must be called from MainThread.

View Source

Dispose()

A method to destroy the managed WiFiAP objects.

Declaration

public void Dispose()

View Source

~WiFiAP()

Destroy the WiFiAP object

Declaration

protected ~WiFiAP()

View Source

ForgetAP()

Deletes the information of a stored access point and disconnects it when the AP is connected. If an AP is connected, then the connection information will be stored. This information is used when a connection to that AP is established automatically.

Declaration

public void ForgetAP()

View Source

ForgetAPAsync()

Deletes the information of a stored access point and disconnects it when the AP is connected asyncronously. If an AP is connected, then the connection information will be stored. This information is used when a connection to that AP is established automatically.