Class WiFiEap

Definition

Namespace:

Tizen.Network.WiFi

Assembly:

Tizen.Network.WiFi.dll

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

public class WiFiEap

Inheritance

object

WiFiEap

Properties

AuthenticationType

The type of EAP phase 2 authentication of the Wi-Fi.

Declaration

public WiFiAuthenticationType AuthenticationType { get; set; }

Property Value

Type	Description
WiFiAuthenticationType	Authentication type of the Wi-Fi.

Exceptions

Type	Condition
System.NotSupportedException	Thrown while setting this value when Wi-Fi is not supported.
System.ArgumentException	Thrown while setting this property due to an invalid parameter.
System.InvalidOperationException	Thrown while setting this value due to an invalid operation.

CaCertificationFile

The file path of CA Certificate of EAP.

Declaration

public string CaCertificationFile { get; set; }

Property Value

Type	Description
string	CA certification file of EAP.

Exceptions

Type	Condition
System.NotSupportedException	Thrown while setting this value when Wi-Fi is not supported.
System.ArgumentNullException	Thrown while setting this value when the file value is null.
System.ArgumentException	Thrown while setting this property due to an invalid parameter.
System.InvalidOperationException	Thrown while setting this value due to an invalid operation.

EapType

The EAP type of Wi-Fi.

Declaration

public WiFiEapType EapType { get; set; }

Property Value

Type	Description
WiFiEapType	Type of EAP.

Exceptions

Type	Condition
System.NotSupportedException	Thrown while setting this value when Wi-Fi is not supported.
System.ArgumentException	Thrown while setting this property due to an invalid parameter.
System.InvalidOperationException	Thrown while setting this value due to an invalid operation.

Methods

GetClientCertFile()

Gets the client certificate of EAP.

Declaration

public string GetClientCertFile()

Returns

Type	Description
string	The file path of client certificate.

Exceptions

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

GetPrivateKeyFile()

Gets the private key file of EAP.

Declaration

public string GetPrivateKeyFile()

Returns

Type	Description
string	The file path of private key.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
System.OutOfMemoryException	Thrown when the system is out of memory.
System.ArgumentException	Thrown when the method fails due to an invalid parameter.
System.InvalidOperationException	Thrown when the method fails due to an invalid operation.

GetUserName()

Gets the username of EAP passphrase.

Declaration

public string GetUserName()

Returns

Type	Description
string	The user name

Exceptions

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

IsPasswordSet()

Returns whether the password is set or not.

Declaration

public bool IsPasswordSet()

Returns

Type	Description
bool	True if password is set, false if password is not set.

Exceptions

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

SetClientCertFile(string)

Sets the CA certificate of EAP.

Declaration

public void SetClientCertFile(string clientCertFile)

Parameters

Type	Name	Description
string	clientCertFile	The file path of client certificate.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
System.ArgumentNullException	Thrown when the file path of client certificate is 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.

SetPassword(string)

Sets the password of EAP.

Declaration

public void SetPassword(string password)

Parameters

Type	Name	Description
string	password	The password

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
System.ArgumentNullException	Thrown when the password 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.

SetPrivateKeyFile(string, string)

Sets the private key information of EAP.

Declaration

public void SetPrivateKeyFile(string privateKeyFile, string password)

Parameters

Type	Name	Description
string	privateKeyFile	The file path of private key.
string	password	The password.

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
System.ArgumentNullException	Thrown when the file path of private key is null.
System.ArgumentException	Thrown when the method failed due to an invalid parameter.
System.InvalidOperationException	Thrown when the method failed due an to invalid operation.

SetUserName(string)

Sets the user name of EAP.

Declaration

public void SetUserName(string userName)

Parameters

Type	Name	Description
string	userName	The user name

Exceptions

Type	Condition
System.NotSupportedException	Thrown when the Wi-Fi is not supported.
System.ArgumentNullException	Thrown when the user name 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.