Class WiFiManager

Definition

Namespace:

Tizen.Network.WiFi

Assembly:

Tizen.Network.WiFi.dll

A manager class which allows applications to connect to a Wireless Local Area Network (WLAN) and transfer data over the network. The Wi-Fi Manager enables your application to activate and deactivate a local Wi-Fi device, and to connect to a WLAN network in the infrastructure mode.

public static class WiFiManager

Inheritance

object

WiFiManager

Properties

ConnectionState

The network connection state.

Declaration

public static WiFiConnectionState ConnectionState { get; }

Property Value

Type	Description
WiFiConnectionState	Represents the connection state of the Wi-Fi.

InterfaceName

The name of the network interface.

Declaration

public static string InterfaceName { get; }

Property Value

Type	Description
string	Interface name of the Wi-Fi.

IsActive

A property to check whether Wi-Fi is activated.

Declaration

public static bool IsActive { get; }

Property Value

Type	Description
bool	Boolean value to check whether Wi-Fi is activated or not.

MacAddress

The local MAC address.

Declaration

public static string MacAddress { get; }

Property Value

Type	Description
string	Represents the MAC address of the Wi-Fi.

ScanState

The Wi-Fi scan state.

Declaration

public static WiFiScanState ScanState { get; }

Property Value

Type	Description
WiFiScanState	Represents the scan state of the Wi-Fi.

Methods

ActivateAsync()

Activates the Wi-Fi asynchronously.

Declaration

public static Task ActivateAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A task indicating whether the activate method is done or not.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
NowInProgressException	Thrown when the Wi-Fi activation is now in progress.
System.UnauthorizedAccessException	Thrown when the permission is denied.
System.InvalidOperationException	Thrown when the method failed due to an invalid operation.

ActivateWithPickerAsync()

Activates the Wi-Fi asynchronously and displays the Wi-Fi picker (popup) when the Wi-Fi is not automatically connected.

Declaration

public static Task ActivateWithPickerAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A task indicating whether the ActivateWithPicker method is done or not.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
NowInProgressException	Thrown when the Wi-Fi activation is now in progress.
System.UnauthorizedAccessException	Thrown when the permission is denied.
System.InvalidOperationException	Thrown when the method failed due to an invalid operation.

BssidScanAsync()

Starts BSSID scan asynchronously.

Declaration

public static Task BssidScanAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A task indicating whether the BssidScanAsync method is done or not.

Remarks

This method must be called from MainThread.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
System.UnauthorizedAccessException	Thrown when the permission is denied.
System.InvalidOperationException	Thrown when the method failed due to an invalid operation.

DeactivateAsync()

Deactivates the Wi-Fi asynchronously.

Declaration

public static Task DeactivateAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A task indicating whether the deactivate method is done or not.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
NowInProgressException	Thrown when the Wi-Fi deactivation is now in progress.
System.UnauthorizedAccessException	Thrown when the permission is denied.
System.InvalidOperationException	Thrown when the method failed due to an invalid operation.

GetConnectedAP()

Gets the object of the connected WiFiAP.

Declaration

public static WiFiAP GetConnectedAP()

Returns

Type	Description
WiFiAP	The connected Wi-Fi access point (AP) information.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
System.UnauthorizedAccessException	Thrown when the permission is denied.
System.OutOfMemoryException	Thrown when system is out of memory.
System.InvalidOperationException	Thrown when the method failed due to an invalid operation.

GetFoundAPs()

Gets the result of the scan.

Declaration

public static IEnumerable<WiFiAP> GetFoundAPs()

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><WiFiAP>	A list of the WiFiAP objects.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
System.UnauthorizedAccessException	Thrown when the permission is denied.
System.InvalidOperationException	Thrown when the method failed due to an invalid operation.

GetFoundBssids()

Gets the result of the BssidScanAsync() API.

Declaration

public static IEnumerable<WiFiAP> GetFoundBssids()

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><WiFiAP>	A list of the WiFiAP objects.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
System.UnauthorizedAccessException	Thrown when the permission is denied.
System.InvalidOperationException	Thrown when the method failed due to an invalid operation.

GetFoundSpecificAPs()

Gets the result of ScanSpecificAPAsync(string essid) API.

Declaration

public static IEnumerable<WiFiAP> GetFoundSpecificAPs()

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><WiFiAP>	A list containing the WiFiAP objects.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
System.UnauthorizedAccessException	Thrown when the permission is denied.
System.InvalidOperationException	Thrown when the method failed due to an invalid operation.

GetWiFiConfigurations()

Gets the list of Wi-Fi configurations.

Declaration

public static IEnumerable<WiFiConfiguration> GetWiFiConfigurations()

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><WiFiConfiguration>	A list containing the WiFiConfiguration objects.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
System.UnauthorizedAccessException	Thrown when the permission is denied.
System.OutOfMemoryException	Thrown when system is out of memory.
System.InvalidOperationException	Thrown when the method failed due to an invalid operation.

SaveWiFiConfiguration(WiFiConfiguration)

Saves the Wi-Fi configuration of the access point.

Declaration

public static void SaveWiFiConfiguration(WiFiConfiguration configuration)

Parameters

Type	Name	Description
WiFiConfiguration	configuration	The configuration to be stored.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
System.UnauthorizedAccessException	Thrown when the permission is denied.
System.ArgumentNullException	Thrown when WiFiConfiguration is passed as null.
System.ArgumentException	Thrown when the method failed due to an invalid parameter.
System.InvalidOperationException	Thrown when the method failed due to an invalid operation.

ScanAsync()

Starts the scan asynchronously.

Declaration

public static Task ScanAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A task indicating whether the scan method is done or not.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
System.UnauthorizedAccessException	Thrown when the permission is denied.
System.InvalidOperationException	Thrown when the method failed due to an invalid operation.

ScanSpecificAPAsync(string)

Starts a specific access point scan asynchronously.

Declaration

public static Task ScanSpecificAPAsync(string essid)

Parameters

Type	Name	Description
string	essid	The ESSID of the hidden AP.

Returns

Type	Description
System.Threading.Tasks.Task	A task indicating whether the ScanSpecificAP method is done or not.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
System.UnauthorizedAccessException	Thrown when the permission is denied.
System.ArgumentException	Thrown when the method failed due to an invalid parameter.
System.InvalidOperationException	Thrown when the method failed due to an invalid operation.

Events

BackgroundScanFinished

BackgroundScanFinished is raised when the background scan is finished. The background scan starts automatically when Wi-Fi is activated. The callback will be invoked periodically.

Declaration

public static event EventHandler BackgroundScanFinished

Event Type

Type	Description
System.EventHandler

ConnectionStateChanged

ConnectionStateChanged is raised when the connection state is changed.

Declaration

public static event EventHandler<ConnectionStateChangedEventArgs> ConnectionStateChanged

Event Type

Type	Description
System.EventHandler<TEventArgs><ConnectionStateChangedEventArgs>

DeviceStateChanged

DeviceStateChanged is raised when the device state is changed.

Declaration

public static event EventHandler<DeviceStateChangedEventArgs> DeviceStateChanged

Event Type

Type	Description
System.EventHandler<TEventArgs><DeviceStateChangedEventArgs>

RssiLevelChanged

RssiLevelChanged is raised when the RSSI of the connected Wi-Fi is changed.

Declaration

public static event EventHandler<RssiLevelChangedEventArgs> RssiLevelChanged

Event Type

Type	Description
System.EventHandler<TEventArgs><RssiLevelChangedEventArgs>

ScanStateChanged

ScanStateChanged is raised when the scan state is changed.

Declaration

public static event EventHandler<ScanStateChangedEventArgs> ScanStateChanged

Event Type

Type	Description
System.EventHandler<TEventArgs><ScanStateChangedEventArgs>