PS1: Edited mismatched indentaion in doxygen tag.
PS5: Restored unchanged files.
PS6: Remove \r
Change-Id: I05dc28b9f9f33f9d4e86bb35a511169745ca3d0a
namespace Tizen.Network.Connection
{
/// <summary>
- /// This Class is CellularProfile. It provides functions to manage the cellular profile.
+ /// This is the CellularProfile class. It provides functions to manage the cellular profile.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class CellularProfile : ConnectionProfile
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Cellular access point name.</value>
- /// <exception cref="System.NotSupportedException">Thrown during set when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown during set when value is invalid parameter.</exception>
- /// <exception cref="System.ArgumentNullException">Thrown during set when value is null.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown during set when profile instance is invalid or when method failed due to invalid operation.</exception>
- /// <exception cref="System.ObjectDisposedException">Thrown when operation is performed on a disposed object.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown during set when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown during set when a value is an invalid parameter.</exception>
+ /// <exception cref="System.ArgumentNullException">Thrown during set when a value is null.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
+ /// <exception cref="System.ObjectDisposedException">Thrown when an operation is performed on a disposed object.</exception>
public string Apn
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Cellular home URL.</value>
- /// <exception cref="System.NotSupportedException">Thrown during set when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown during set when value is invalid parameter.</exception>
- /// <exception cref="System.ArgumentNullException">Thrown during set when value is null.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown during set when profile instance is invalid or when method failed due to invalid operation.</exception>
- /// <exception cref="System.ObjectDisposedException">Thrown when operation is performed on a disposed object.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown during set when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown during set when a value is an invalid parameter.</exception>
+ /// <exception cref="System.ArgumentNullException">Thrown during set when a value is null.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
+ /// <exception cref="System.ObjectDisposedException">Thrown when an operation is performed on a disposed object.</exception>
public string HomeUri
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Cellular service type.</value>
- /// <exception cref="System.NotSupportedException">Thrown during set when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown during set when value is invalid parameter.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown during set when profile instance is invalid or when method failed due to invalid operation.</exception>
- /// <exception cref="System.ObjectDisposedException">Thrown when operation is performed on a disposed object.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown during set when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown during set when a value is an invalid parameter.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
+ /// <exception cref="System.ObjectDisposedException">Thrown when an operation is performed on a disposed object.</exception>
public CellularServiceType ServiceType
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Cellular pdn type.</value>
- /// <exception cref="System.NotSupportedException">Thrown during set when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown during set when value is invalid parameter.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown during set when profile instance is invalid or when method failed due to invalid operation.</exception>
- /// <exception cref="System.ObjectDisposedException">Thrown when operation is performed on a disposed object.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown during set when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown during set when a value is an invalid parameter.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
+ /// <exception cref="System.ObjectDisposedException">Thrown when an operation is performed on a disposed object.</exception>
public CellularPdnType PdnType
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Cellular roaming pdn type.</value>
- /// <exception cref="System.NotSupportedException">Thrown during set when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown during set when value is invalid parameter.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown during set when profile instance is invalid or when method failed due to invalid operation.</exception>
- /// <exception cref="System.ObjectDisposedException">Thrown when operation is performed on a disposed object.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown during set when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown during set when a value is an invalid parameter.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
+ /// <exception cref="System.ObjectDisposedException">Thrown when a operation is performed on a disposed object.</exception>
public CellularPdnType RoamingPdnType
{
get
}
/// <summary>
- /// Cellular Authentication Information.
+ /// The cellular authentication information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Instance of CellularAuthInformation.</value>
- /// <exception cref="System.NotSupportedException">Thrown during set when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown during set when value is invalid parameter.</exception>
- /// <exception cref="System.ArgumentNullException">Thrown during set when value is null.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown during set when profile instance is invalid or when method failed due to invalid operation.</exception>
- /// <exception cref="System.ObjectDisposedException">Thrown when operation is performed on a disposed object.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown during set when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown during set when a value is an invalid parameter.</exception>
+ /// <exception cref="System.ArgumentNullException">Thrown during set when a value is null.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
+ /// <exception cref="System.ObjectDisposedException">Thrown when an operation is performed on a disposed object.</exception>
public CellularAuthInformation CellularAuthInfo
{
get
}
/// <summary>
- /// This Class is CellularAuthInformation. It provides the properties to get and set the cellular authentication information.
+ /// This is the CellularAuthInformation class. It provides the properties to get and set the cellular authentication information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class CellularAuthInformation
{
/// <summary>
- /// Default Constructor.Initializes an object of CellularAuthInformation.
+ /// Default constructor. Initializes an object of the CellularAuthInformation.
/// </summary>
public CellularAuthInformation()
{
/// <summary>
/// The user name.
- /// <since_tizen> 3 </since_tizen>
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <value>Cellular user name.</value>
public string UserName { get; set;}
/// <summary>
- /// The password
+ /// The password.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Cellular password.</value>
public string Password { get; set; }
/// <summary>
- /// The authentication type
+ /// The authentication type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Cellular authentication type.</value>
using System.Runtime.InteropServices;
/// <summary>
-/// The Connection API provides functions, enumerations to get the status of network and current profile and manage profiles.
+/// The Connection API provides functions and enumerations to get the status of network and current profile and manages profiles.
/// </summary>
namespace Tizen.Network.Connection
{
}
/// <summary>
- /// This class is ConnectionManager. It provides functions to manage data connections.
+ /// This is the ConnectionManager class. It provides functions to manage data connections.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public static class ConnectionManager
private static ConnectionItem _currentConnection = null;
/// <summary>
- /// Event that is called when the type of the current connection is changed.
+ /// An event is called when the type of the current connection is changed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
}
/// <summary>
- /// Event for ethernet cable is plugged [in/out] event.
+ /// An event for the ethernet cable is plugged [in/out] event.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
}
/// <summary>
- /// Event that is called when the IP address is changed.
+ /// An event is called when the IP address is changed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
}
/// <summary>
- /// Event that is called when the proxy address is changed.
+ /// An event is called when the proxy address is changed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// Gets the connection handle.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <returns>Instance of SafeConnectionHandle</returns>
+ /// <returns>Instance of SafeConnectionHandle.</returns>
[EditorBrowsable(EditorBrowsableState.Never)]
public static SafeConnectionHandle GetConnectionHandle()
{
/// Gets the IP address of the current connection.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="family">The address family</param>
+ /// <param name="family">The address family.</param>
/// <returns>IP address of the connection (global address in case of IPv6).</returns>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when a value is an invalid parameter.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection instance is invalid or when method failed due to invalid operation.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a connection instance is invalid or when a method fails due to an invalid operation.</exception>
public static System.Net.IPAddress GetIPAddress(AddressFamily family)
{
return ConnectionInternalManager.Instance.GetIPAddress(family);
}
/// <summary>
- /// Gets the all IPv6 addresses of the current connection.
+ /// Gets all the IPv6 addresses of the current connection.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="type">The type of current network connection</param>
+ /// <param name="type">The type of current network connection.</param>
/// <returns>A list of IPv6 addresses of the connection.</returns>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when a value is an invalid parameter.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection instance is invalid or when method failed due to invalid operation.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a connection instance is invalid or when a method fails due to an invalid operation.</exception>
public static IEnumerable<System.Net.IPAddress> GetAllIPv6Addresses(ConnectionType type)
{
return ConnectionInternalManager.Instance.GetAllIPv6Addresses(type);
/// Gets the proxy address of the current connection.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="family">The address family</param>
+ /// <param name="family">The address family.</param>
/// <returns>Proxy address of the connection.</returns>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when a value is an invalid parameter.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection instance is invalid or when method failed due to invalid operation.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a connection instance is invalid or when a method fails due to an invalid operation.</exception>
public static string GetProxy(AddressFamily family)
{
return ConnectionInternalManager.Instance.GetProxy(family);
/// Gets the MAC address of the Wi-Fi or ethernet.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="type">The type of current network connection</param>
+ /// <param name="type">The type of current network connection.</param>
/// <returns>MAC address of the Wi-Fi or ethernet.</returns>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when value is an invalid parameter.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection instance is invalid or when method failed due to invalid operation.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a connection instance is invalid or when a method fails due to an invalid operation.</exception>
public static string GetMacAddress(ConnectionType type)
{
return ConnectionInternalManager.Instance.GetMacAddress(type);
/// Gets the statistics information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="connectionType">The type of connection (only WiFi and Cellular are supported)</param>
- /// <param name="statisticsType">The type of statistics</param>
- /// <returns>The statistics information associated with statisticsType</returns>
+ /// <param name="connectionType">The type of connection (only WiFi and Cellular are supported).</param>
+ /// <param name="statisticsType">The type of statistics.</param>
+ /// <returns>The statistics information associated with statisticsType.</returns>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when value is an invalid parameter.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection instance is invalid or when method failed due to invalid operation.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a connection instance is invalid or when a method fails due to invalid operation.</exception>
public static long GetStatistics(ConnectionType connectionType, StatisticsType statisticsType)
{
return ConnectionInternalManager.Instance.GetStatistics(connectionType, statisticsType);
/// Resets the statistics information.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="connectionType">The type of connection (only WiFi and Cellular are supported)</param>
- /// <param name="statisticsType">The type of statistics</param>
+ /// <param name="connectionType">The type of connection (only WiFi and Cellular are supported).</param>
+ /// <param name="statisticsType">The type of statistics.</param>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <privilege>http://tizen.org/privilege/network.set</privilege>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when a value is an invalid parameter.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection instance is invalid or when method failed due to invalid operation.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a connection instance is invalid or when a method fails due to an invalid operation.</exception>
public static void ResetStatistics(ConnectionType connectionType, StatisticsType statisticsType)
{
ConnectionInternalManager.Instance.ResetStatistics(connectionType, statisticsType);
/// <summary>
/// Adds a route to the routing table.
/// </summary>
- /// <param name="family">The address family</param>
- /// <param name="interfaceName">The name of network interface</param>
- /// <param name="hostAddress">The IP address of the host</param>
- /// <param name="gateway">The gateway address</param>
+ /// <param name="family">The address family.</param>
+ /// <param name="interfaceName">The name of the network interface.</param>
+ /// <param name="hostAddress">The IP address of the host.</param>
+ /// <param name="gateway">The gateway address.</param>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <privilege>http://tizen.org/privilege/network.set</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
- /// <exception cref="System.ArgumentNullException">Thrown when interfaceName or hostAddress or gateway is null.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when a value is an invalid parameter.</exception>
+ /// <exception cref="System.ArgumentNullException">Thrown when an interfaceName or a hostAddress or a gateway is null.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection instance is invalid or when method failed due to invalid operation.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a connection instance is invalid or when a method fails due to an invalid operation.</exception>
public static void AddRoute(AddressFamily family, string interfaceName, System.Net.IPAddress hostAddress, System.Net.IPAddress gateway)
{
ConnectionInternalManager.Instance.AddRoute(family, interfaceName, hostAddress, gateway);
/// <summary>
/// Removes a route from the routing table.
/// </summary>
- /// <param name="family">The address family</param>
- /// <param name="interfaceName">The name of network interface</param>
- /// <param name="hostAddress">The IP address of the host</param>
- /// <param name="gateway">The gateway address</param>
+ /// <param name="family">The address family.</param>
+ /// <param name="interfaceName">The name of network interface.</param>
+ /// <param name="hostAddress">The IP address of the host.</param>
+ /// <param name="gateway">The gateway address.</param>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <privilege>http://tizen.org/privilege/network.set</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
- /// <exception cref="System.ArgumentNullException">Thrown when interfaceName or hostAddress or gateway is null.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when a value is an invalid parameter.</exception>
+ /// <exception cref="System.ArgumentNullException">Thrown when an interfaceName or a hostAddress or a gateway is null.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection instance is invalid or when method failed due to invalid operation.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a connection instance is invalid or when a method fails due to an invalid operation.</exception>
public static void RemoveRoute(AddressFamily family, string interfaceName, System.Net.IPAddress hostAddress, System.Net.IPAddress gateway)
{
ConnectionInternalManager.Instance.RemoveRoute(family, interfaceName, hostAddress, gateway);
}
/// <summary>
- /// Type and state of the current profile for data connection
+ /// The type and state of the current profile for data connection.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Instance of ConnectionItem</value>
+ /// <value>Instance of ConnectionItem.</value>
public static ConnectionItem CurrentConnection
{
get
/// <since_tizen> 3 </since_tizen>
/// <param name="type">The type of profile. Cellular profile type is supported.</param>
/// <param name="keyword">The keyword included in profile name.</param>
- /// <returns>CellularProfile object</returns>
+ /// <returns>CellularProfile object.</returns>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
- /// <exception cref="System.ArgumentNullException">Thrown when keyword value is null.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when method failed due to invalid operation.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when a value is an invalid parameter.</exception>
+ /// <exception cref="System.ArgumentNullException">Thrown when a keyword value is null.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a method fails due to invalid operation.</exception>
public static CellularProfile CreateCellularProfile(ConnectionProfileType type, string keyword)
{
IntPtr profileHandle = IntPtr.Zero;
}
/// <summary>
- /// The state of cellular connection.
+ /// The state of the cellular connection.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Cellular network state.</value>
}
/// <summary>
- /// The state of the Wi-Fi.
+ /// The state of the Wi-Fi connection.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>WiFi connection state.</value>
}
/// <summary>
- /// The state of the Bluetooth.
+ /// The state of the Bluetooth connection.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Bluetooth connection state.</value>
}
/// <summary>
- /// Checks for ethernet cable is attached or not.
+ /// Checks if the ethernet cable is attached or not.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Ethernet cable state.</value>
} // class ConnectionManager
/// <summary>
- /// This class contains connection information such as connection type and state.
+ /// This class contains connection information, such as connection type and state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class ConnectionItem
} // class ConnectionItem
/// <summary>
- /// An extended EventArgs class which contains changed connection type.
+ /// An extended EventArgs class, which contains changed connection type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class ConnectionTypeEventArgs : EventArgs
}
/// <summary>
- /// An extended EventArgs class which contains changed ethernet cable state.
+ /// An extended EventArgs class, which contains changed ethernet cable state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class EthernetCableStateEventArgs : EventArgs
}
/// <summary>
- /// An extended EventArgs class which contains changed address.
+ /// An extended EventArgs class, which contains changed address.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class AddressEventArgs : EventArgs
}
/// <summary>
- /// The IPV4 address.
+ /// The IPV4 address.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>IP address in the format of IPV4 syntax.</value>
+ /// <value>IP address in the format of the IPV4 syntax.</value>
public string IPv4Address
{
get
}
/// <summary>
- /// The IPV6 address.
+ /// The IPV6 address.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>IP address in the format of IPV6 syntax.</value>
+ /// <value>IP address in the format of the IPV6 syntax.</value>
public string IPv6Address
{
get
namespace Tizen.Network.Connection
{
/// <summary>
- /// This Class is ConnectionProfile. It provides event and propeties of the connection profile.
+ /// This is the ConnectionProfile class. It provides event and propeties of the connection profile.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class ConnectionProfile : IDisposable
}
/// <summary>
- /// The event that is called when the state of profile is changed.
+ /// The event is called when the state of profile is changed.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
/// The name of the network interface.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <value>Network interface name, e.g. eth0 and pdp0.</value>
+ /// <value>Network interface name, for example, eth0 and pdp0.</value>
public string InterfaceName
{
get
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when profile instance is invalid or when method failed due to invalid operation</exception>
- /// <exception cref="System.ObjectDisposedException">Thrown when operation is performed on a disposed object.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when a value is an invalid parameter.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
+ /// <exception cref="System.ObjectDisposedException">Thrown when an operation is performed on a disposed object.</exception>
public void Refresh()
{
CheckDisposed();
}
/// <summary>
- /// Get the network state.
+ /// Gets the network state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="family">The address family</param>
+ /// <param name="family">The address family.</param>
/// <returns>The network state.</returns>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when profile instance is invalid or when method failed due to invalid operation</exception>
- /// <exception cref="System.ObjectDisposedException">Thrown when operation is performed on a disposed object.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when a value is an invalid parameter.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
+ /// <exception cref="System.ObjectDisposedException">Thrown when an operation is performed on a disposed object.</exception>
public ProfileState GetState(AddressFamily family)
{
CheckDisposed();
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Proxy type of the connection.</value>
- /// <exception cref="System.NotSupportedException">Thrown during set when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown during set when value is invalid parameter.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown during set when profile instance is invalid or when method failed due to invalid operation.</exception>
- /// <exception cref="System.ObjectDisposedException">Thrown during set when operation is performed on a disposed object.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown during set when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown during set when a value is an invalid parameter.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
+ /// <exception cref="System.ObjectDisposedException">Thrown during set when a operation is performed on a disposed object.</exception>
public ProxyType ProxyType
{
get
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Proxy address of the connection.</value>
- /// <exception cref="System.NotSupportedException">Thrown during set when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown during set when value is invalid parameter.</exception>
- /// <exception cref="System.ArgumentNullException">Thrown during set when value is null.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown during set when profile instance is invalid or when method failed due to invalid operation.</exception>
- /// <exception cref="System.ObjectDisposedException">Thrown when operation is performed on a disposed object.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown during set when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown during set when a value is an invalid parameter.</exception>
+ /// <exception cref="System.ArgumentNullException">Thrown during set when a value is null.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
+ /// <exception cref="System.ObjectDisposedException">Thrown when an operation is performed on a disposed object.</exception>
public string ProxyAddress
{
get
}
/// <summary>
- /// The address information (IPv4)
+ /// The address information (IPv4).
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Instance of IAddressInformation with IPV4 address.</value>
}
/// <summary>
- /// The address information (IPv6)
+ /// The address information (IPv6).
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Instance of IAddressInformation with IPV6 address.</value>
}
/// <summary>
- /// An extended EventArgs class which contains changed profile state.
+ /// An extended EventArgs class, which contains changed profile state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class ProfileStateEventArgs : EventArgs
namespace Tizen.Network.Connection
{
/// <summary>
- /// This class is ConnectionProfileManager. It provides functions to add, get, connect or modify the connection profile.
+ /// This is the ConnectionProfileManager class. It provides functions to add, get, connect, or modify the connection profile.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public static class ConnectionProfileManager
{
/// <summary>
- /// Adds a new profile
+ /// Adds a new profile.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="profile">The cellular profile object</param>
+ /// <param name="profile">The cellular profile object.</param>
/// <privilege>http://tizen.org/privilege/network.profile</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
- /// <exception cref="System.ArgumentNullException">Thrown when value is null.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when a value is an invalid parameter.</exception>
+ /// <exception cref="System.ArgumentNullException">Thrown when a value is null.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection or profile instance is invalid or when method failed due to invalid operation</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when connection or profile instance is invalid or when a method fails due to an invalid operation.</exception>
public static void AddCellularProfile(CellularProfile profile)
{
Log.Debug(Globals.LogTag, "AddCellularProfile");
}
/// <summary>
- /// Gets the list of profile with profile list type
+ /// Gets the list of the profile with the profile list type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="type">The type of profile</param>
+ /// <param name="type">The type of profile.</param>
/// <returns>List of connection profile objects.</returns>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when value is an invalid parameter.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection instance has been disposed.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a connection instance has been disposed.</exception>
public static Task<IEnumerable<ConnectionProfile>> GetProfileListAsync(ProfileListType type)
{
Log.Debug(Globals.LogTag, "GetProfileListAsync");
}
/// <summary>
- /// Opens a connection of profile, asynchronously.
+ /// Opens a connection of profile asynchronously.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="profile">The connection profile object</param>
+ /// <param name="profile">The connection profile object.</param>
/// <returns>A task indicates whether the ConnectProfileAsync method is done successfully or not.</returns>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <privilege>http://tizen.org/privilege/network.set</privilege>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
- /// <exception cref="System.ArgumentNullException">Thrown when value is null.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when value is an invalid parameter.</exception>
+ /// <exception cref="System.ArgumentNullException">Thrown when a value is null.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection or profile instance is invalid or when method failed due to invalid operation</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a connection or a profile instance is invalid or when a method fails due to an invalid operation.</exception>
public static Task ConnectProfileAsync(ConnectionProfile profile)
{
Log.Debug(Globals.LogTag, "ConnectProfile");
/// Closes a connection of profile.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="profile">The connection profile object</param>
+ /// <param name="profile">The connection profile object.</param>
/// <returns>A task indicates whether the DisconnectProfileAsync method is done successfully or not.</returns>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <privilege>http://tizen.org/privilege/network.set</privilege>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
- /// <exception cref="System.ArgumentNullException">Thrown when value is null.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when a value is an invalid parameter.</exception>
+ /// <exception cref="System.ArgumentNullException">Thrown when a value is null.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection or profile instance is invalid or when method failed due to invalid operation</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a connection or a profile instance is invalid or when a method fails due to invalid operation.</exception>
public static Task DisconnectProfileAsync(ConnectionProfile profile)
{
Log.Debug(Globals.LogTag, "DisconnectProfileAsync");
/// Removes an existing profile.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="profile">The connection profile object</param>
+ /// <param name="profile">The connection profile object.</param>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <privilege>http://tizen.org/privilege/network.profile</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
- /// <exception cref="System.ArgumentNullException">Thrown when value is null.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when value is an invalid parameter.</exception>
+ /// <exception cref="System.ArgumentNullException">Thrown when a value is null.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection or profile instance is invalid or when method failed due to invalid operation</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a connection or a profile instance is invalid or when a method fails due to invalid operation.</exception>
public static void RemoveProfile(ConnectionProfile profile)
{
Log.Debug(Globals.LogTag, "RemoveProfile. Id: " + profile.Id + ", Name: " + profile.Name + ", Type: " + profile.Type);
/// When you call this function, your changes affect the ConnectionProfileManager and the existing profile is updated.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="profile">The connection profile object</param>
+ /// <param name="profile">The connection profile object.</param>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <privilege>http://tizen.org/privilege/network.profile</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
- /// <exception cref="System.ArgumentNullException">Thrown when value is null.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when a value is an invalid parameter.</exception>
+ /// <exception cref="System.ArgumentNullException">Thrown when a value is null.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection or profile instance is invalid or when method failed due to invalid operation</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a connection or a profile instance is invalid or when a method fails due to an invalid operation.</exception>
public static void UpdateProfile(ConnectionProfile profile)
{
Log.Debug(Globals.LogTag, "UpdateProfile");
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when a value is an invalid parameter.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection instance is invalid or when method failed due to invalid operation</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a connection instance is invalid or when a method fails due to an invalid operation.</exception>
public static ConnectionProfile GetCurrentProfile()
{
Log.Debug(Globals.LogTag, "GetCurrentProfile");
}
/// <summary>
- /// Gets the default profile which provides the given cellular service.
+ /// Gets the default profile, which provides the given cellular service.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="type">The cellular service type</param>
+ /// <param name="type">The cellular service type.</param>
/// <returns>Connection profile object.</returns>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when a value is an invalid parameter.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection instance is invalid or when method failed due to invalid operation</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a connection instance is invalid or when a method fails due to an invalid operation.</exception>
public static ConnectionProfile GetDefaultCellularProfile(CellularServiceType type)
{
Log.Debug(Globals.LogTag, "GetDefaultCurrentProfile");
}
/// <summary>
- /// Sets the default profile which provides the given cellular service.
+ /// Sets the default profile, which provides the given cellular service.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="type">The cellular service type</param>
- /// <param name="profile">The connection profile object</param>
+ /// <param name="type">The cellular service type.</param>
+ /// <param name="profile">The connection profile object.</param>
/// <returns>A task indicates whether the SetDefaultCellularProfile method is done successfully or not.</returns>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <privilege>http://tizen.org/privilege/network.profile</privilege>
/// <feature>http://tizen.org/feature/network.wifi</feature>
/// <feature>http://tizen.org/feature/network.tethering.bluetooth</feature>
/// <feature>http://tizen.org/feature/network.ethernet</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when permission is denied.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
- /// <exception cref="System.ArgumentNullException">Thrown when value is null.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when a permission is denied.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when a value is an invalid parameter.</exception>
+ /// <exception cref="System.ArgumentNullException">Thrown when a value is null.</exception>
/// <exception cref="System.OutOfMemoryException">Thrown when memory is not enough to continue execution.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when connection or profile instance is invalid or when method failed due to invalid operation</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a connection or a profile instance is invalid or when a method fails due to invalid operation.</exception>
public static Task SetDefaultCellularProfile(CellularServiceType type, ConnectionProfile profile)
{
Log.Debug(Globals.LogTag, "SetDefaultCellularProfile");
}
/// <summary>
- /// An extended EventArgs class which contains the state of changed connection profile.
+ /// An extended EventArgs class, which contains the state of changed connection profile.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class ConnectionProfileStateEventArgs : EventArgs
namespace Tizen.Network.Connection
{
/// <summary>
- /// Enumeration for connection type.
+ /// Enumeration for the connection type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum ConnectionType
}
/// <summary>
- /// Enumeration for address family.
+ /// Enumeration for the address family.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum AddressFamily
}
/// <summary>
- /// Enumeration for cellular network state.
+ /// Enumeration for the cellular network state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CellularState
}
/// <summary>
- /// Enumeration for connection state.
+ /// Enumeration for the connection state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum ConnectionState
}
/// <summary>
- /// This enumeration defines the attached or detached state of ethernet cable.
+ /// Enumeration for the attached or detached state of the ethernet cable.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum EthernetCableState
}
/// <summary>
- /// Enumeration for statistics type.
+ /// Enumeration for the statistics type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum StatisticsType
}
/// <summary>
- /// Enumeration for network connection type.
+ /// Enumeration for the network connection type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum ConnectionProfileType
}
/// <summary>
- /// Enumeration for profile state type.
+ /// Enumeration for the profile state type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum ProfileState
}
/// <summary>
- /// Enumeration for proxy method type.
+ /// Enumeration for the proxy method type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum ProxyType
}
/// <summary>
- /// Enumeration for IP configuration type.
+ /// Enumeration for the IP configuration type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum IPConfigType
}
/// <summary>
- /// Enumeration for cellular service type.
+ /// Enumeration for the cellular service type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CellularServiceType
}
/// <summary>
- /// Enumeration for cellular pdn type.
+ /// Enumeration for the cellular pdn type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CellularPdnType
}
/// <summary>
- /// Enumeration for DNS configuration type.
+ /// Enumeration for the DNS configuration type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum DnsConfigType
/// <summary>
- /// Enumeration for connection errors.
+ /// Enumeration for the connection errors.
/// </summary>
/// <since_tizen> 3 </since_tizen>
// To do : have to assign valid error code
}
/// <summary>
- /// Enumeration for profile list type.
+ /// Enumeration for the profile list type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum ProfileListType
}
/// <summary>
- /// Enumeration for security type of Wi-Fi.
+ /// Enumeration for the security type of Wi-Fi.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum WiFiSecurityType
}
/// <summary>
- /// Enumeration for encryption modes.
+ /// Enumeration for the encryption modes.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum WiFiEncryptionType
}
/// <summary>
- /// Enumeration for connection profile state.
+ /// Enumeration for the connection profile state.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum ConnectionProfileState
}
/// <summary>
- /// Enumeration for cellular authentication type.
+ /// Enumeration for the cellular authentication type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public enum CellularAuthType
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>First DNS address of the connection.</value>
- /// <exception cref="System.NotSupportedException">Thrown during set when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown during set when value is invalid parameter.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown during set when profile instance is invalid or when method failed due to invalid operation.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown during set when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown during set when a value is an invalid parameter.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
System.Net.IPAddress Dns1 { get; set; }
/// <summary>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Second DNS address of the connection.</value>
- /// <exception cref="System.NotSupportedException">Thrown during set when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown during set when value is invalid parameter.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown during set when profile instance is invalid or when method failed due to invalid operation.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown during set when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown during set when a value is an invalid parameter.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
System.Net.IPAddress Dns2 { get; set; }
/// <summary>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Gateway address of the connection.</value>
- /// <exception cref="System.NotSupportedException">Thrown during set when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown during set when value is invalid parameter.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown during set when profile instance is invalid or when method failed due to invalid operation.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown during set when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown during set when a value is an invalid parameter.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
System.Net.IPAddress Gateway { get; set; }
/// <summary>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Subnet mask of the connection.</value>
- /// <exception cref="System.NotSupportedException">Thrown during set when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown during set when value is invalid parameter.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown during set when profile instance is invalid or when method failed due to invalid operation.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown during set when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown during set when a value is an invalid parameter.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
System.Net.IPAddress SubnetMask { get; set; }
/// <summary>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>IP address of the connection.</value>
- /// <exception cref="System.NotSupportedException">Thrown during set when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown during set when value is invalid parameter.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown during set when profile instance is invalid or when method failed due to invalid operation.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown during set when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown during set when a value is an invalid parameter.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
System.Net.IPAddress IP { get; set; }
/// <summary>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>IP config type of the connection.</value>
- /// <exception cref="System.NotSupportedException">Thrown during set when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown during set when value is invalid parameter.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown during set when profile instance is invalid or when method failed due to invalid operation.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown during set when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown during set when a value is an invalid parameter.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
IPConfigType IPConfigType { get; set; }
/// <summary>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Prefix length of the connection.</value>
- /// <exception cref="System.NotSupportedException">Thrown during set when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown during set when value is invalid parameter.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown during set when profile instance is invalid or when method failed due to invalid operation.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown during set when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown during set when a value is an invalid parameter.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
int PrefixLength { get; set; }
/// <summary>
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>Config type of the DNS.</value>
- /// <exception cref="System.NotSupportedException">Thrown during set when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown during set when value is invalid parameter.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown during set when profile instance is invalid or when method failed due to invalid operation.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown during set when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown during set when a value is an invalid parameter.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown during set when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
DnsConfigType DnsConfigType { get; set; }
/// <summary>
- /// The DHCP server address. It is only supported for IPV4 address family.
+ /// The DHCP server address. It is only supported for the IPV4 address family.
/// </summary>
/// <value>Server address of the DHCP.</value>
System.Net.IPAddress DhcpServerAddress { get; }
namespace Tizen.Network.Connection
{
/// <summary>
- /// This Class is WiFiProfile. It provides functions to manage the WiFi profile.
+ /// This is the WiFiProfile class. It provides functions to manage the WiFi profile.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public class WiFiProfile : ConnectionProfile
/// Sets the passphrase of the Wi-Fi WPA.
/// </summary>
/// <since_tizen> 3 </since_tizen>
- /// <param name="passphrase">The passphrase of Wi-Fi security</param>
+ /// <param name="passphrase">The passphrase of Wi-Fi security.</param>
/// <feature>http://tizen.org/feature/network.wifi</feature>
- /// <exception cref="System.NotSupportedException">Thrown when feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown when value is invalid parameter.</exception>
- /// <exception cref="System.ArgumentNullException">Thrown when passphrase is null.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when profile instance is invalid or when method failed due to invalid operation.</exception>
- /// <exception cref="System.ObjectDisposedException">Thrown when operation is performed on a disposed object.</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when a feature is not supported.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when a value is an invalid parameter.</exception>
+ /// <exception cref="System.ArgumentNullException">Thrown when a passphrase is null.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a profile instance is invalid or when a method fails due to an invalid operation.</exception>
+ /// <exception cref="System.ObjectDisposedException">Thrown when an operation is performed on a disposed object.</exception>
public void SetPassphrase(string passphrase)
{
CheckDisposed();
projects / platform / core / csapi / tizenfx.git / commitdiff