namespace Tizen.Network.WiFi
{
/// <summary>
- /// An extended EventArgs class which contains changed connection state.
+ /// An extended EventArgs class which contains the changed connection state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class ConnectionStateChangedEventArgs : EventArgs
}
/// <summary>
- /// The wifi connection state.
+ /// The Wi-Fi connection state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public WiFiConnectionState State
}
/// <summary>
- /// The access point
+ /// The access point.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public WiFiAP AP
namespace Tizen.Network.WiFi
{
/// <summary>
- /// An extended EventArgs class which contains changed device state.
+ /// An extended EventArgs class which contains the changed device state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class DeviceStateChangedEventArgs : EventArgs
}
/// <summary>
- /// The wifi device state.
+ /// The Wi-Fi device state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public WiFiDeviceState State
namespace Tizen.Network.WiFi
{
/// <summary>
- /// An abstract class for WiFi EAP information.
+ /// An abstract class for the Wi-Fi EAP information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
internal interface IWiFiEap
string CaCertificationFile { get; set; }
/// <summary>
- /// The EAP type of wifi.
+ /// The EAP type of the Wi-Fi.
/// </summary>
/// <since_tizen> 3 </since_tizen>
WiFiEapType EapType { get; set; }
/// <summary>
- /// The type of EAP phase2 authentication of Wi-Fi.
+ /// The type of EAP phase2 authentication of the Wi-Fi.
/// </summary>
/// <since_tizen> 3 </since_tizen>
WiFiAuthenticationType AuthenticationType { get; set; }
namespace Tizen.Network.WiFi
{
/// <summary>
- /// An extended EventArgs class which contains changed RSSI level.
+ /// An extended EventArgs class which contains the changed RSSI level.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class RssiLevelChangedEventArgs : EventArgs
}
/// <summary>
- /// The wifi RSSI level.
+ /// The Wi-Fi RSSI level.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public WiFiRssiLevel Level
namespace Tizen.Network.WiFi
{
/// <summary>
- /// A class for managing the network information of the access point(AP).
+ /// A class for managing the network information of the access point (AP).
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class WiFiAP : IDisposable
private bool _disposed = false;
/// <summary>
- /// The network information of the access point(AP).
+ /// The network information of the access point (AP).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>WiFiNetwork instance containing network information of AP.</value>
+ /// <value>The WiFiNetwork instance containing the network information of the AP.</value>
public WiFiNetwork NetworkInformation
{
get
}
/// <summary>
- /// The security information of the access point(AP).
+ /// The security information of the access point (AP).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>WiFiSecurity instance containing security information of AP.</value>
+ /// <value>The WiFiSecurity instance containing security information of the AP.</value>
public WiFiSecurity SecurityInformation
{
get
/// <param name="essid">The Extended Service Set Identifier of the access point.</param>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="ArgumentNullException">Thrown when Essid is passed as null.</exception>
- /// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
+ /// <exception cref="ArgumentNullException">Thrown when the ESSID is passed as null.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
/// <exception cref="OutOfMemoryException">Thrown when the system is out of memory.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public WiFiAP(string essid)
{
Log.Debug(Globals.LogTag, "New WiFiAP. Essid: " + essid);
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="essid">The Extended Service Set Identifier of the access point.</param>
- /// <param name="hidden">The value to set hidden AP</param>
+ /// <param name="hidden">The value to set a hidden AP.</param>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="ArgumentNullException">Thrown when Essid is passed as null.</exception>
- /// <exception cref="ArgumentException">Thrown when it is failed due to an invalid parameter.</exception>
+ /// <exception cref="ArgumentNullException">Thrown when the ESSID is passed as null.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
/// <exception cref="OutOfMemoryException">Thrown when the system is out of memory.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public WiFiAP(string essid, bool hidden)
{
createHandle(essid, hidden);
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="ObjectDisposedException">Thrown when object instance is disposed or released.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="ObjectDisposedException">Thrown when the object instance is disposed or released.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public void Refresh()
{
Log.Debug(Globals.LogTag, "Refresh");
/// Connects the access point asynchronously.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns> A task indicating whether the Connect method is done or not.</returns>
+ /// <returns> A task indicating whether the connect method is done or not.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.set</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="ObjectDisposedException">Thrown when object instance is disposed or released.</exception>
+ /// <exception cref="ObjectDisposedException">Thrown when the object instance is disposed or released.</exception>
/// <exception cref="OutOfMemoryException">Thrown when the system is out of memory.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public Task ConnectAsync()
{
Log.Debug(Globals.LogTag, "ConnectAsync");
}
/// <summary>
- /// Connects the access point with WPS asynchronously.
+ /// Connects the access point with the WPS asynchronously.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="info">A WpsInfo instance which is of type WpsPbcInfo or WpsPinInfo.</param>
+ /// <param name="info">A WpsInfo instance which is type of WpsPbcInfo or WpsPinInfo.</param>
/// <returns>A task indicating whether the ConnectWps method is done or not.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.profile</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="ObjectDisposedException">Thrown when object instance is disposed or released.</exception>
- /// <exception cref="ArgumentNullException">Thrown when WpsPinInfo object is constructed with null pin.</exception>
- /// <exception cref="ArgumentOutOfRangeException">Thrown when WpsPinInfo object is constructed with pin which is an empty string or more than 7 characters.</exception>
+ /// <exception cref="ObjectDisposedException">Thrown when the object instance is disposed or released.</exception>
+ /// <exception cref="ArgumentNullException">Thrown when the WpsPinInfo object is constructed with a null pin.</exception>
+ /// <exception cref="ArgumentOutOfRangeException">Thrown when the WpsPinInfo object is constructed with a pin which is an empty string or more than 7 characters.</exception>
/// <exception cref="OutOfMemoryException">Thrown when the system is out of memory.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public Task ConnectWpsAsync(WpsInfo info)
{
Log.Debug(Globals.LogTag, "ConnectWpsAsync");
}
/// <summary>
- /// Connects the access point with WPS without ssid asynchronously.
+ /// Connects the access point with WPS without SSID asynchronously.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="info">A WpsInfo instance which is of type WpsPbcInfo or WpsPinInfo.</param>
/// <privilege>http://tizen.org/privilege/network.set</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <privilege>http://tizen.org/privilege/network.profile</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="ArgumentNullException">Thrown when WpsPinInfo object is constructed with null pin.</exception>
- /// <exception cref="ArgumentOutOfRangeException">Thrown when WpsPinInfo object is constructed with pin which is not of 4 or 8 characters long.</exception>
+ /// <exception cref="ArgumentNullException">Thrown when the WpsPinInfo object is constructed with a null pin.</exception>
+ /// <exception cref="ArgumentOutOfRangeException">Thrown when the WpsPinInfo object is constructed with a pin which is not of 4 or 8 characters long.</exception>
/// <exception cref="OutOfMemoryException">Thrown when the system is out of memory.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public static Task<WiFiAP> ConnectWpsWithoutSsidAsync(WpsInfo info)
{
TaskCompletionSource<WiFiAP> task = new TaskCompletionSource<WiFiAP>();
/// Disconnects the access point asynchronously.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns> A task indicating whether the Disconnect method is done or not.</returns>
+ /// <returns> A task indicating whether the disconnect method is done or not.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.set</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="ObjectDisposedException">Thrown when object instance is disposed or released.</exception>
+ /// <exception cref="ObjectDisposedException">Thrown when the object instance is disposed or released.</exception>
/// <exception cref="OutOfMemoryException">Thrown when the system is out of memory.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public Task DisconnectAsync()
{
Log.Debug(Globals.LogTag, "DisconnectAsync");
}
/// <summary>
- /// Deletes the information of stored access point and disconnects it when it is connected.<br>
- /// If an AP is connected, then connection information will be stored. This information is used when a connection to that AP is established automatically.
+ /// Deletes the information of a stored access point and disconnects it when the AP is connected.<br>
+ /// 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.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.profile</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="ObjectDisposedException">Thrown when object instance is disposed or released.</exception>
+ /// <exception cref="ObjectDisposedException">Thrown when the object instance is disposed or released.</exception>
/// <exception cref="OutOfMemoryException">Thrown when the system is out of memory.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public void ForgetAP()
{
Log.Debug(Globals.LogTag, "ForgetAP");
}
/// <summary>
- /// An abstract class which is used to represent WPS information of access point.
+ /// An abstract class which is used to represent the WPS information of the access point.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public abstract class WpsInfo
}
/// <summary>
- /// A class which is used to represent WPS PBC information of access point.
+ /// A class which is used to represent WPS PBC information of the access point.
/// </summary>
public class WpsPbcInfo : WpsInfo
{
}
/// <summary>
- /// A class which is used to represent WPS PIN information of access point.
+ /// A class which is used to represent WPS PIN information of the access point.
/// </summary>
public class WpsPinInfo : WpsInfo
{
private WiFiEapConfiguration _eapConfig;
/// <summary>
- /// The name of access point(AP).
+ /// The name of the access point (AP).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Name assigned to AP in WiFi configuration.</value>
+ /// <value>Name assigned to AP in the Wi-Fi configuration.</value>
public string Name
{
get
}
/// <summary>
- /// The security type of access point(AP).
+ /// The security type of the access point (AP).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Security type of AP in WiFi configuration.</value>
+ /// <value>Security type of AP in the Wi-Fi configuration.</value>
public WiFiSecurityType SecurityType
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Proxy address of the access point.</value>
- /// <exception cref="NotSupportedException">Thrown while setting this property when WiFi is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown while setting this property when Wi-Fi is not supported.</exception>
/// <exception cref="ArgumentException">Thrown while setting this property due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown while setting this value due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown while setting this value due to an invalid operation.</exception>
public string ProxyAddress
{
get
}
/// <summary>
- /// A property check whether the access point(AP) is hidden or not.
+ /// A property check whether the access point (AP) is hidden.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Boolean value indicating whether AP is hidden or not.</value>
- /// <exception cref="NotSupportedException">Thrown while setting this property when WiFi is not supported.</exception>
+ /// <value>Boolean value indicating whether the AP is hidden.</value>
+ /// <exception cref="NotSupportedException">Thrown while setting this property when the Wi-Fi is not supported.</exception>
/// <exception cref="ArgumentException">Thrown while setting this property due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown while setting this value due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown while setting this value due to an invalid operation.</exception>
public bool IsHidden
{
get
}
/// <summary>
- /// The EAP Configuration.
+ /// EAP configuration.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>EAP configuration assigned to WiFi.</value>
+ /// <value>EAP configuration assigned to the Wi-Fi.</value>
public WiFiEapConfiguration EapConfiguration
{
get
}
/// <summary>
- /// Creates a WiFiConfiguration object with the given name, passphrase and securetype.
+ /// Creates a WiFiConfiguration object with the given name, passphrase, and securetype.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="name">Name of the WiFi.</param>
- /// <param name="passPhrase">Password to access the WiFi.</param>
- /// <param name="type">Security type of the WiFi.</param>
+ /// <param name="name">Name of the Wi-Fi.</param>
+ /// <param name="passPhrase">Password to access the Wi-Fi.</param>
+ /// <param name="type">Security type of the Wi-Fi.</param>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
/// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
/// <exception cref="ArgumentNullException">Thrown when the object is constructed with name as null.</exception>
/// <exception cref="OutOfMemoryException">Thrown when the system is out of memory.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when it is failed due to invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public WiFiConfiguration(string name, string passPhrase, WiFiSecurityType type)
{
if (name == null)
}
/// <summary>
- /// A method to destroy the managed objects in WiFiConfiguration.
+ /// A method to destroy the managed objects in the WiFiConfiguration.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public void Dispose()
namespace Tizen.Network.WiFi
{
/// <summary>
- /// A class for managing the EAP information of access point(AP).
+ /// A class for managing the EAP information of the access point (AP).
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class WiFiEap : IWiFiEap
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>CA certification file of EAP.</value>
- /// <exception cref="NotSupportedException">Thrown while setting this value when WiFi is not supported.</exception>
- /// <exception cref="ArgumentNullException">Thrown while setting this value when file value is null.</exception>
+ /// <exception cref="NotSupportedException">Thrown while setting this value when Wi-Fi is not supported.</exception>
+ /// <exception cref="ArgumentNullException">Thrown while setting this value when the file value is null.</exception>
/// <exception cref="ArgumentException">Thrown while setting this property due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown while setting this value due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown while setting this value due to an invalid operation.</exception>
public string CaCertificationFile
{
get
}
/// <summary>
- /// The EAP type of wifi.
+ /// The EAP type of Wi-Fi.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Type of EAP.</value>
- /// <exception cref="NotSupportedException">Thrown while setting this value when WiFi is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown while setting this value when Wi-Fi is not supported.</exception>
/// <exception cref="ArgumentException">Thrown while setting this property due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown while setting this value due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown while setting this value due to an invalid operation.</exception>
public WiFiEapType EapType
{
get
}
/// <summary>
- /// The type of EAP phase2 authentication of Wi-Fi.
+ /// The type of EAP phase 2 authentication of the Wi-Fi.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Authentication type of WiFi.</value>
- /// <exception cref="NotSupportedException">Thrown while setting this value when WiFi is not supported.</exception>
+ /// <value>Authentication type of the Wi-Fi.</value>
+ /// <exception cref="NotSupportedException">Thrown while setting this value when Wi-Fi is not supported.</exception>
/// <exception cref="ArgumentException">Thrown while setting this property due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown while setting this value due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown while setting this value due to an invalid operation.</exception>
public WiFiAuthenticationType AuthenticationType
{
get
/// <since_tizen> 3 </since_tizen>
/// <returns>The file path of private key.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when the system is out of memory. </exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when the system is out of memory.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method fails due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method fails due to an invalid operation.</exception>
public string GetPrivateKeyFile()
{
IntPtr strPtr;
/// <param name="privateKeyFile">The file path of private key.</param>
/// <param name="password">The password.</param>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="ArgumentNullException">Thrown when file path of private key is null.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="ArgumentNullException">Thrown when the file path of private key is null.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due an to invalid operation.</exception>
public void SetPrivateKeyFile(string privateKeyFile, string password)
{
if (privateKeyFile == null)
}
/// <summary>
- /// Gets the Client Certificate of EAP.
+ /// Gets the client certificate of EAP.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>The file path of Client Certificate.</returns>
+ /// <returns>The file path of client certificate.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when the system is out of memory. </exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when the system is out of memory.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due an to invalid operation.</exception>
public string GetClientCertFile()
{
IntPtr strPtr;
}
/// <summary>
- /// Sets the CA Certificate of EAP.
+ /// Sets the CA certificate of EAP.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="clientCertFile">The file path of Client Certificate.</param>
+ /// <param name="clientCertFile">The file path of client certificate.</param>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="ArgumentNullException">Thrown when file path of Client Certificate is null.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="ArgumentNullException">Thrown when the file path of client certificate is null.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public void SetClientCertFile(string clientCertFile)
{
if (clientCertFile == null)
/// <since_tizen> 3 </since_tizen>
/// <returns>The user name</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when the system is out of memory. </exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when the system is out of memory.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public string GetUserName()
{
IntPtr strptr;
/// <since_tizen> 3 </since_tizen>
/// <returns>True if password is set, false if password is not set.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="OutOfMemoryException">Thrown when the system is out of memory. </exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when the system is out of memory.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public bool IsPasswordSet()
{
IntPtr strptr;
/// <since_tizen> 3 </since_tizen>
/// <param name="userName">The user name</param>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="ArgumentNullException">Thrown when the user name is passed as null. </exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="ArgumentNullException">Thrown when the user name is passed as null.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public void SetUserName(string userName)
{
if (userName == null)
/// <since_tizen> 3 </since_tizen>
/// <param name="password">The password</param>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="ArgumentNullException">Thrown when the password is passed as null. </exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="ArgumentNullException">Thrown when the password is passed as null.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public void SetPassword(string password)
{
if (password == null)
private Interop.WiFi.SafeWiFiConfigHandle _configHandle;
/// <summary>
- /// The file path of CA Certificate of EAP.
+ /// The file path of CA certificate of EAP.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>CA certification file of EAP.</value>
- /// <exception cref="NotSupportedException">Thrown while setting this value when WiFi is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown while setting this value when Wi-Fi is not supported.</exception>
/// <exception cref="ArgumentException">Thrown while setting this property due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown while setting this value due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown while setting this value due to an invalid operation.</exception>
public string CaCertificationFile
{
get
}
/// <summary>
- /// The EAP type of wifi.
+ /// The EAP type of the Wi-Fi.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Type of EAP.</value>
- /// <exception cref="NotSupportedException">Thrown while setting this value when WiFi is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown while setting this value when Wi-Fi is not supported.</exception>
/// <exception cref="ArgumentException">Thrown while setting this property due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown while setting this value due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown while setting this value due to an invalid operation.</exception>
public WiFiEapType EapType
{
get
}
/// <summary>
- /// The type of EAP phase2 authentication of Wi-Fi.
+ /// The type of EAP phase2 authentication of the Wi-Fi.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Authentication type of WiFi.</value>
- /// <exception cref="NotSupportedException">Thrown while setting this value when WiFi is not supported.</exception>
+ /// <value>Authentication type of the Wi-Fi.</value>
+ /// <exception cref="NotSupportedException">Thrown while setting this value when Wi-Fi is not supported.</exception>
/// <exception cref="ArgumentException">Thrown while setting this property due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown while setting this value due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown while setting this value due to an invalid operation.</exception>
public WiFiAuthenticationType AuthenticationType
{
get
}
/// <summary>
- /// The anonymous identity of access point(AP).
+ /// The anonymous identity of the access point (AP).
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Represents the anonymous identity of the access point.</value>
- /// <exception cref="NotSupportedException">Thrown while setting this value when WiFi is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown while setting this value when Wi-Fi is not supported.</exception>
/// <exception cref="ArgumentException">Thrown while setting this property due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown while setting this value due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown while setting this value due to an invalid operation.</exception>
public string AnonymousIdentify
{
get
}
/// <summary>
- /// The identity of access point(AP).
+ /// The identity of the access point (AP).
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Represents the identity of the access point.</value>
- /// <exception cref="NotSupportedException">Thrown while setting this value when WiFi is not supported.</exception>
+ /// <exception cref="NotSupportedException">Thrown while setting this value when Wi-Fi is not supported.</exception>
/// <exception cref="ArgumentException">Thrown while setting this property due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown while setting this value due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown while setting this value due to an invalid operation.</exception>
public string Identity
{
get
}
/// <summary>
- /// The subject match of access point(AP).
+ /// The subject match of the access point (AP).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Represents the subject match of AP.</value>
- /// <exception cref="NotSupportedException">Thrown while setting this value when WiFi is not supported.</exception>
+ /// <value>Represents the subject match of the AP.</value>
+ /// <exception cref="NotSupportedException">Thrown while setting this value when Wi-Fi is not supported.</exception>
/// <exception cref="ArgumentException">Thrown while setting this property due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown while setting this value due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown while setting this value due to an invalid operation.</exception>
public string SubjectMatch
{
get
}
/// <summary>
- /// Gets access point client cert file from configuration.
+ /// Gets the access point client certificate file from the configuration.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>The certification authority(CA) certificates file of access point.</returns>
+ /// <returns>The certification authority (CA) certificates file of the access point.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public string GetClientCertFile()
{
IntPtr strPtr;
}
/// <summary>
- /// Sets access point client cert file to configuration.
+ /// Sets the access point client certificate file to configuration.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="privateKey">The private key file.</param>
- /// <param name="clientCert">The certification authority(CA) certificates file of access point.</param>
+ /// <param name="clientCert">The certification authority(CA) certifies the files of access points.</param>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public void SetClientCertFile(string privateKey, string clientCert)
{
int ret = Interop.WiFi.Config.SetEapClientCertFile(_configHandle, privateKey, clientCert);
namespace Tizen.Network.WiFi
{
/// <summary>
- /// Enumeration for Wi-Fi EAP type.
+ /// Enumeration for the Wi-Fi EAP types.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum WiFiEapType
{
/// <summary>
- /// EAP PEAP type
+ /// EAP PEAP type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Peap = 0,
/// <summary>
- /// EAP TLS type
+ /// EAP TLS type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Tls = 1,
/// <summary>
- /// EAP TTLS type
+ /// The EAP TTLS type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Ttls = 2,
/// <summary>
- /// EAP SIM type
+ /// EAP SIM type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Sim = 3,
/// <summary>
- /// EAP AKA type
+ /// EAP AKA type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Aka = 4
}
/// <summary>
- /// Enumeration for Wi-Fi RSSI level.
+ /// Enumeration for the Wi-Fi RSSI levels.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum WiFiRssiLevel
{
/// <summary>
- /// Level 0
+ /// Level 0.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Level0 = 0,
/// <summary>
- /// Level 1
+ /// Level 1.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Level1 = 1,
/// <summary>
- /// Level 2
+ /// Level 2.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Level2 = 2,
/// <summary>
- /// Level 3
+ /// Level 3.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Level3 = 3,
/// <summary>
- /// Level 4
+ /// Level 4.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Level4 = 4
}
/// <summary>
- /// Enumeration for Wi-Fi connection state.
+ /// Enumeration for the Wi-Fi connection states.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum WiFiConnectionState
{
/// <summary>
- /// Connection failed state
+ /// Connection failed state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Failure = -1,
/// <summary>
- /// Disconnected state
+ /// Disconnected state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Disconnected = 0,
/// <summary>
- /// Association state
+ /// Association state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Association = 1,
/// <summary>
- /// Configuration state
+ /// Configuration state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Congfiguration = 2,
/// <summary>
- /// Connected state
+ /// Connected state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Connected = 3
}
/// <summary>
- /// Enumeration for Wi-Fi device state.
+ /// Enumeration for the Wi-Fi device states.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum WiFiDeviceState
{
/// <summary>
- /// Wi-Fi is Deactivated
+ /// Wi-Fi is deactivated.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Deactivated = 0,
/// <summary>
- /// Wi-Fi is activated
+ /// Wi-Fi is activated.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Activated = 1
}
/// <summary>
- /// Enumeration for Wi-Fi proxy type.
+ /// Enumeration for the Wi-Fi proxy types.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum WiFiProxyType
{
/// <summary>
- /// Direct connection
+ /// Direct connection.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Direct = 0,
/// <summary>
- /// Auto configuration(Use PAC file). If URL property is not set, DHCP/WPAD auto-discover will be tried
+ /// Auto configuration(Use PAC file). If the URL property is not set, DHCP/WPAD auto-discover will be tried.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Auto = 1,
/// <summary>
- /// Manual configuration
+ /// Manual configuration.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Manual = 2
}
/// <summary>
- /// Enumeration for Wi-Fi authentication type.
+ /// Enumeration for the Wi-Fi authentication types.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum WiFiAuthenticationType
{
/// <summary>
- /// EAP phase2 authentication none
+ /// EAP phase 2 authentication none.
/// </summary>
/// <since_tizen> 3 </since_tizen>
None = 0,
/// <summary>
- /// EAP phase2 authentication PAP
+ /// EAP phase 2 authentication PAP.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Pap = 1,
/// <summary>
- /// EAP phase2 authentication MSCHAP
+ /// EAP phase 2 authentication MSCHAP.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Mschap = 2,
/// <summary>
- /// EAP phase2 authentication MSCHAPv2
+ /// EAP phase 2 authentication MSCHAPv2.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Mschapv2 = 3,
/// <summary>
- /// EAP phase2 authentication GTC
+ /// EAP phase 2 authentication GTC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Gtc = 4,
/// <summary>
- /// EAP phase2 authentication MD5
+ /// EAP phase 2 authentication MD5.
/// </summary>
/// <since_tizen> 3 </since_tizen>
Md5 = 5
namespace Tizen.Network.WiFi
{
/// <summary>
- /// A class for managing WiFiManager handle.
+ /// A class for managing the WiFiManager handle.
/// </summary>
[EditorBrowsable(EditorBrowsableState.Never)]
public sealed class SafeWiFiManagerHandle : SafeHandle
}
/// <summary>
- /// A manager class which allows applications to connect to a Wireless Local Area Network (WLAN) and to transfer data over the network.<br>
+ /// A manager class which allows applications to connect to a Wireless Local Area Network (WLAN) and transfer data over the network.<br>
/// 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.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// The local MAC address.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Represents the mac address of the WiFi.</value>
+ /// <value>Represents the MAC address of the Wi-Fi.</value>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
static public string MacAddress
{
/// The name of the network interface.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Interface name of WiFi.</value>
+ /// <value>Interface name of the Wi-Fi.</value>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
static public string InterfaceName
{
/// The network connection state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Represents the connection state of WiFi.</value>
+ /// <value>Represents the connection state of the Wi-Fi.</value>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
static public WiFiConnectionState ConnectionState
{
}
/// <summary>
- /// A property to Check whether Wi-Fi is activated.
+ /// A property to check whether Wi-Fi is activated.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Boolean value to check whether WiFi is activated or not.</value>
+ /// <value>Boolean value to check whether Wi-Fi is activated or not.</value>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
static public bool IsActive
{
}
/// <summary>
- /// RssiLevelChanged is raised when the RSSI of connected Wi-Fi is changed.
+ /// RssiLevelChanged is raised when the RSSI of the connected Wi-Fi is changed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <summary>
/// BackgroundScanFinished is raised when the background scan is finished.
- /// The background scan starts automatically when wifi is activated. The callback will be invoked periodically.
+ /// The background scan starts automatically when Wi-Fi is activated. The callback will be invoked periodically.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
}
/// <summary>
- /// Gets the WiFi safe handle.
+ /// Gets the Wi-Fi safe handle.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>The instance of SafeWiFiManagerHandle</returns>
+ /// <returns>The instance of the SafeWiFiManagerHandle.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
/// <exception cref="OutOfMemoryException">Thrown when the system is out of memory.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
[EditorBrowsable(EditorBrowsableState.Never)]
public static SafeWiFiManagerHandle GetWiFiHandle()
{
/// Gets the result of the scan.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns> A list of WiFiAP objects.</returns>
+ /// <returns>A list of the WiFiAP objects.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
static public IEnumerable<WiFiAP> GetFoundAPs()
{
return WiFiManagerImpl.Instance.GetFoundAPs();
}
/// <summary>
- /// Gets the result of specific AP scan.
+ /// Gets the result of a specific AP scan.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns> A list contains the WiFiAP objects.</returns>
+ /// <returns>A list containing the WiFiAP objects.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
static public IEnumerable<WiFiAP> GetFoundSpecificAPs()
{
return WiFiManagerImpl.Instance.GetFoundSpecificAPs();
}
/// <summary>
- /// Gets the list of wifi configurations.
+ /// Gets the list of Wi-Fi configurations.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>A list contains the WiFiConfiguration objects.</returns>
+ /// <returns>A list containing the WiFiConfiguration objects.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.profile</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
/// <exception cref="OutOfMemoryException">Thrown when system is out of memory.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
static public IEnumerable<WiFiConfiguration> GetWiFiConfigurations()
{
return WiFiManagerImpl.Instance.GetWiFiConfigurations();
}
/// <summary>
- /// Saves Wi-Fi configuration of access point.
+ /// Saves the Wi-Fi configuration of the access point.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="configuration">The configuration to be stored</param>
+ /// <param name="configuration">The configuration to be stored.</param>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.profile</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
/// <exception cref="ArgumentNullException">Thrown when WiFiConfiguration is passed as null.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
static public void SaveWiFiConfiguration(WiFiConfiguration configuration)
{
WiFiManagerImpl.Instance.SaveWiFiNetworkConfiguration(configuration);
/// Gets the object of the connected WiFiAP.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns> The connected wifi access point(AP) information.</returns>
+ /// <returns>The connected Wi-Fi access point (AP) information.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
/// <exception cref="OutOfMemoryException">Thrown when system is out of memory.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
static public WiFiAP GetConnectedAP()
{
return WiFiManagerImpl.Instance.GetConnectedAP();
}
/// <summary>
- /// Activates Wi-Fi asynchronously.
+ /// Activates the Wi-Fi asynchronously.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns> A task indicating whether the Activate method is done or not.</returns>
+ /// <returns> A task indicating whether the activate method is done or not.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.set</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
static public Task ActivateAsync()
{
return WiFiManagerImpl.Instance.ActivateAsync();
}
/// <summary>
- /// Activates Wi-Fi asynchronously and displays Wi-Fi picker (popup) when Wi-Fi is not automatically connected.
+ /// Activates the Wi-Fi asynchronously and displays the Wi-Fi picker (popup) when the Wi-Fi is not automatically connected.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns> A task indicating whether the ActivateWithPicker method is done or not.</returns>
+ /// <returns>A task indicating whether the ActivateWithPicker method is done or not.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.set</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
static public Task ActivateWithPickerAsync()
{
return WiFiManagerImpl.Instance.ActivateWithWiFiPickerTestedAsync();
}
/// <summary>
- /// Deactivates Wi-Fi asynchronously.
+ /// Deactivates the Wi-Fi asynchronously.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns> A task indicating whether the Deactivate method is done or not.</returns>
+ /// <returns>A task indicating whether the deactivate method is done or not.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.set</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
static public Task DeactivateAsync()
{
return WiFiManagerImpl.Instance.DeactivateAsync();
}
/// <summary>
- /// Starts scan asynchronously.
+ /// Starts the scan asynchronously.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns> A task indicating whether the Scan method is done or not.</returns>
+ /// <returns>A task indicating whether the scan method is done or not.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.set</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
static public Task ScanAsync()
{
return WiFiManagerImpl.Instance.ScanAsync();
}
/// <summary>
- /// Starts specific access point scan, asynchronously.
+ /// Starts a specific access point scan asynchronously.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns> A task indicating whether the ScanSpecificAP method is done or not.</returns>
- /// <param name="essid">The essid of hidden ap</param>
+ /// <returns>A task indicating whether the ScanSpecificAP method is done or not.</returns>
+ /// <param name="essid">The ESSID of the hidden AP.</param>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <privilege>http://tizen.org/privilege/network.set</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when the method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when the permission is denied.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
static public Task ScanSpecificAPAsync(string essid)
{
return WiFiManagerImpl.Instance.ScanSpecificAPAsync(essid);
private string _essid;
/// <summary>
- /// The Extended Service Set Identifier(ESSID).
+ /// The Extended Service Set Identifier (ESSID).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Essid of the WiFi.</value>
+ /// <value>ESSID of the Wi-Fi.</value>
public string Essid
{
get
}
/// <summary>
- /// The Basic Service Set Identifier(BSSID).
+ /// The Basic Service Set Identifier (BSSID).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Bssid of the WiFi.</value>
+ /// <value>BSSID of the Wi-Fi.</value>
public string Bssid
{
get
}
/// <summary>
- /// The address informaiton for IPv4.
+ /// The address information for IPv4.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>IP address information for IPv4 type.</value>
/// The proxy address.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Represents proxy address of WiFi.</value>
- /// <exception cref="NotSupportedException">Thrown while setting this property when WiFi is not supported.</exception>
+ /// <value>Represents the proxy address of the Wi-Fi.</value>
+ /// <exception cref="NotSupportedException">Thrown while setting this property when Wi-Fi is not supported.</exception>
/// <exception cref="ArgumentException">Thrown while setting this property due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown while setting this value due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown while setting this value due to an invalid operation.</exception>
public string ProxyAddress
{
get
}
/// <summary>
- /// The proxy type(IPv6).
+ /// The proxy type (IPv6).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Represents proxy type of WiFi.</value>
- /// <exception cref="NotSupportedException">Thrown while setting this property when WiFi is not supported.</exception>
+ /// <value>Represents the proxy type of the Wi-Fi.</value>
+ /// <exception cref="NotSupportedException">Thrown while setting this property when Wi-Fi is not supported.</exception>
/// <exception cref="ArgumentException">Thrown while setting this property due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown while setting this value due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown while setting this value due to an invalid operation.</exception>
public WiFiProxyType ProxyType
{
get
}
/// <summary>
- /// The frequency band(MHz).
+ /// The frequency band (MHz).
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Represents the frequency band value.</value>
}
/// <summary>
- /// The Received signal strength indication(RSSI).
+ /// The received signal strength indicator (RSSI).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Represents Rssi of WiFi(dbm).</value>
+ /// <value>Represents RSSI of Wi-Fi (dbm).</value>
public int Rssi
{
get
/// The max speed (Mbps).
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Represents max speed value.</value>
+ /// <value>Represents the max speed value.</value>
public int MaxSpeed
{
get
}
/// <summary>
- /// A property to check whether the access point is favorite or not.
+ /// A property to check whether the access point is a favorite or not.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Boolean value to check if the access point is favorite or not.</value>
+ /// <value>Boolean value to check if the access point is a favorite or not.</value>
public bool IsFavorite
{
get
}
/// <summary>
- /// A property to check whether the access point is passpoint or not.
+ /// A property to check whether the access point is a passpoint or not.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Boolean value to check if the access point is passpoint or not.</value>
+ /// <value>Boolean value to check if the access point is a passpoint or not.</value>
public bool IsPasspoint
{
get
/// The connection state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Represents the connection state of WiFi.</value>
+ /// <value>Represents the connection state of the Wi-Fi.</value>
public WiFiConnectionState ConnectionState
{
get
}
/// <summary>
- /// Gets the all IPv6 addresses of the access point
+ /// Gets all IPv6 addresses of the access point.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>A list of IPv6 addresses of the access point.</returns>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the Wi-Fi is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public IEnumerable<System.Net.IPAddress> GetAllIPv6Addresses()
{
Log.Debug(Globals.LogTag, "GetAllIPv6Addresses");
namespace Tizen.Network.WiFi
{
/// <summary>
- /// A class for managing the WiFi security information.
+ /// A class for managing the Wi-Fi security information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class WiFiSecurity
/// The type of Wi-Fi security.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Represents the security type of WiFi.</value>
- /// <exception cref="NotSupportedException">Thrown while setting this property when WiFi is not supported.</exception>
+ /// <value>Represents the security type of the Wi-Fi.</value>
+ /// <exception cref="NotSupportedException">Thrown while setting this property when Wi-Fi is not supported.</exception>
/// <exception cref="ArgumentException">Thrown while setting this property due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown while setting this value due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown while setting this value due to an invalid operation.</exception>
public WiFiSecurityType SecurityType
{
get
}
/// <summary>
- /// The type of Wi-Fi encryption
+ /// The type of Wi-Fi encryption.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Represents the encryption type of WiFi.</value>
- /// <exception cref="NotSupportedException">Thrown while setting this property when WiFi is not supported.</exception>
+ /// <value>Represents the encryption type of the Wi-Fi.</value>
+ /// <exception cref="NotSupportedException">Thrown while setting this property when Wi-Fi is not supported.</exception>
/// <exception cref="ArgumentException">Thrown while setting this property due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown while setting this value due to invalid operation.</exception>
+ /// <exception cref="InvalidOperationException">Thrown while setting this value due to an invalid operation.</exception>
public WiFiEncryptionType EncryptionType
{
get
}
/// <summary>
- /// The EAP information
+ /// The EAP information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Eap information of WiFi.</value>
+ /// <value>EAP information of the Wi-Fi.</value>
public WiFiEap EapInformation
{
get
/// A property to check whether the passphrase is required or not.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Boolean value to check if passphrase is required or not.</value>
+ /// <value>Boolean value to check if the passphrase is required or not.</value>
public bool IsPassphraseRequired
{
get
}
/// <summary>
- /// A property to check whether the Wi-Fi Protected Setup(WPS) is supported or not.
+ /// A property to check whether Wi-Fi Protected Setup (WPS) is supported.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Boolean value to check if wps is supported or not.</value>
+ /// <value>Boolean value to check if WPS is supported.</value>
public bool IsWpsSupported
{
get
/// <since_tizen> 3 </since_tizen>
/// <param name="passphrase">The passphrase of the access point.</param>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="NotSupportedException">Thrown when WiFi is not supported.</exception>
- /// <exception cref="ArgumentNullException">Thrown when passphrase is passed as null.</exception>
- /// <exception cref="ArgumentException">Thrown when method is failed due to an invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when Wi-Fi is not supported.</exception>
+ /// <exception cref="ArgumentNullException">Thrown when the passphrase is passed as null.</exception>
+ /// <exception cref="ArgumentException">Thrown when the method failed due to an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
public void SetPassphrase(string passphrase)
{
if (passphrase == null)
projects / platform / core / csapi / tizenfx.git / commitdiff