using static Tizen.Telephony.CallHandle;
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Call Interop Class
+ /// The Call Interop class.
/// </summary>
internal static partial class Call
{
*/
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Libraries Interop Class
+ /// The Libraries Interop class.
/// </summary>
internal static partial class Libraries
{
using System.Runtime.InteropServices;
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Modem Interop Class
+ /// The Modem Interop class.
/// </summary>
internal static partial class Modem
{
using System.Runtime.InteropServices;
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Network Interop Class
+ /// The Network Interop class.
/// </summary>
internal static partial class Network
{
using System.Runtime.InteropServices;
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Sim Interop Class
+ /// The SIM Interop class.
/// </summary>
internal static partial class Sim
{
using Tizen.Telephony;
/// <summary>
-/// Partial Interop Class
+/// The Partial Interop class.
/// </summary>
internal static partial class Interop
{
/// <summary>
- /// Telephony Interop Class
+ /// The Telephony Interop class.
/// </summary>
internal static class Telephony
{
namespace Tizen.Telephony
{
/// <summary>
- /// The Call API's allows you to get the voice and video call states.
- /// It provides the List of CallHandle which can be used to get the information about call related actions.
+ /// The Call APIs allow you to get the voice and video call states.
+ /// It provides the list of CallHandle which can be used to get the information about call related actions.
/// </summary>
public class Call
{
private Interop.Call.SafeCallList _safeCallList;
/// <summary>
- /// Public Constructor
+ /// The public constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="handle">
- /// SlotHandle received in the Manager.Init API
+ /// SlotHandle received in the Manager.Init API.
/// </param>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="ArgumentNullException">
- /// This exception occurs if handle provided is null
+ /// This exception occurs if the handle provided is null.
/// </exception>
public Call(SlotHandle handle)
{
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
- /// List of CallHandle for existing calls.
+ /// The list of the CallHandle for existing calls.
/// </returns>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
- /// <exception cref="ArgumentException">Incase of Invalid parameter</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined</exception>
- /// <exception cref="OutOfMemoryException">Incase of Out of Memory</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case of privileges not defined.</exception>
+ /// <exception cref="OutOfMemoryException">In case of out of memory.</exception>
public IEnumerable<CallHandle> GetCallHandleList()
{
uint count;
namespace Tizen.Telephony
{
/// <summary>
- /// This Class provides API's to get the information about calls.
+ /// This class provides the APIs to get the information about calls.
/// </summary>
public class CallHandle
{
public enum CallStatus
{
/// <summary>
- /// Idle status
+ /// Idle status.
/// </summary>
Idle,
/// <summary>
- /// Active status
+ /// Active status.
/// </summary>
Active,
/// <summary>
- /// Held status
+ /// Held status.
/// </summary>
Held,
/// <summary>
- /// Dialing status
+ /// Dialing status.
/// </summary>
Dialing,
/// <summary>
- /// Alerting status
+ /// Alerting status.
/// </summary>
Alerting,
/// <summary>
- /// Incoming status
+ /// Incoming status.
/// </summary>
Incoming,
/// <summary>
- /// Unavailable
+ /// Unavailable.
/// </summary>
Unavailable
};
public enum CallType
{
/// <summary>
- /// Voice call
+ /// Voice call.
/// </summary>
Voice,
/// <summary>
- /// Video call
+ /// Video call.
/// </summary>
Video,
/// <summary>
- /// Emergency call
+ /// Emergency call.
/// </summary>
E911,
/// <summary>
- /// Unavailable
+ /// Unavailable.
/// </summary>
Unavailable
};
public enum CallDirection
{
/// <summary>
- /// MO(Mobile Originated) call
+ /// MO(Mobile Originated) call.
/// </summary>
Mo,
/// <summary>
- /// MT(Mobile Terminated) call
+ /// MT(Mobile Terminated) call.
/// </summary>
Mt,
/// <summary>
- /// Unavailable
+ /// Unavailable.
/// </summary>
Unavailable
};
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// The id of the call handle
- /// 0 if unable to complete the operation
+ /// The ID of the call handle.
+ /// 0 if unable to complete the operation.
/// </value>
public uint HandleId
{
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// The number of the call
- /// empty string if unable to complete the operation
+ /// The number of the call.
+ /// Empty string if unable to complete the operation.
/// </value>
public string Number
{
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// The type of the call
+ /// The type of the call.
/// </value>
public CallType Type
{
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// The status of the call
+ /// The status of the call.
/// </value>
public CallStatus Status
{
}
/// <summary>
- /// Gets whether the call is MO(Mobile Originated) call or MT(Mobile Terminated).
+ /// Gets whether the call is MO(Mobile Originated) call or MT(Mobile Terminated) call.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// The direction of the call
+ /// The direction of the call.
/// </value>
/// <exception cref="InvalidOperationException">
/// This Exception can occur due to:
- /// 1. Operation Not Supported
+ /// 1. Operation Not Supported.
/// </exception>
public CallDirection Direction
{
}
/// <summary>
- /// Gets whether the call is conference call or not.
+ /// Gets whether the call is a conference call or not.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <value>
- /// The value whether the call is conference call or not. (true: Conference call, false: Single call)
+ /// The value whether the call is a conference call or not (true: Conference call, false: Single call).
/// </value>
public bool ConferenceStatus
{
namespace Tizen.Telephony
{
/// <summary>
- /// This Class contains the data related to the Notification event
+ /// This class contains the data related to the Notification event.
/// </summary>
public class ChangeNotificationEventArgs : EventArgs
{
}
/// <summary>
- /// Enumeration for Telephony notification.
+ /// Enumeration for the Telephony Notification.
/// </summary>
public enum Notification
{
/// <summary>
- /// Notification to be invoked when the SIM card state changes.
- /// SIM.State will be delivered in notification data.
+ /// The notification to be invoked when the SIM card state changes.
+ /// SIM.State will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
SimStatus = 0x10,
/// <summary>
- /// Notification to be invoked when the SIM call forwarding indicator state changes.
- /// 'state(bool)' will be delivered in notification data.
+ /// The notification to be invoked when the SIM call forwarding indicator state changes.
+ /// 'state(bool)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
SimCallForwardingIndicatorState,
/// <summary>
- /// Notification to be invoked when the network service state changes.
- /// Network.ServiceState will be delivered in notification data.
+ /// The notification to be invoked when the network service state changes.
+ /// Network.ServiceState will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
NetworkServiceState = 0x20,
/// <summary>
- /// Notification to be invoked when the cell ID changes.
- /// 'cell_id(int)' will be delivered in notification data.
+ /// The notification to be invoked when the cell ID changes.
+ /// 'cell_id(int)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
NetworkCellid,
/// <summary>
- /// Notification to be invoked when the roaming status changes.
- /// 'roaming_status(bool)' will be delivered in notification data.
+ /// The notification to be invoked when the roaming status changes.
+ /// 'roaming_status(bool)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
NetworkRoamingStatus,
/// <summary>
- /// Notification to be invoked when the signal strength changes.
- /// Network.Rssi will be delivered in notification data.
+ /// The notification to be invoked when the signal strength changes.
+ /// Network.Rssi will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
NetworkSignalstrengthLevel,
/// <summary>
- /// Notification to be invoked when the network name changes.
- /// 'network_name(string)' will be delivered in notification data.
+ /// The notification to be invoked when the network name changes.
+ /// 'network_name(string)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
NetworkNetworkName,
/// <summary>
- /// Notification to be invoked when the ps type changes.
- /// Network.PSType will be delivered in notification data.
+ /// The notification to be invoked when the PS type changes.
+ /// Network.PSType will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
NetworkPsType,
/// <summary>
- /// Notification to be invoked when the default data subscription changes.
- /// Network.DefaultDataSubscription will be delivered in notification data.
+ /// The notification to be invoked when the default data subscription changes.
+ /// Network.DefaultDataSubscription will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
NetworkDefaultDataSubscription,
/// <summary>
- /// Notification to be invoked when the default subscription changes.
- /// Network.DefaultSubscription will be delivered in notification data.
+ /// The notification to be invoked when the default subscription changes.
+ /// Network.DefaultSubscription will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
NetworkDefaultSubscription,
/// <summary>
- /// Notification to be invoked when the LAC (Location Area Code) changes.
- /// 'lac(int)' will be delivered in notification data.
+ /// The notification to be invoked when the LAC (Location Area Code) changes.
+ /// 'lac(int)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
NetworkLac,
/// <summary>
- /// Notification to be invoked when the TAC (Tracking Area Code) changes.
- /// 'tac(int)' will be delivered in notification data.
+ /// The notification to be invoked when the TAC (Tracking Area Code) changes.
+ /// 'tac(int)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
NetworkTac,
/// <summary>
- /// Notification to be invoked when the system ID changes.
- /// 'sid(int)' will be delivered in notification data.
+ /// The notification to be invoked when the system ID changes.
+ /// 'sid(int)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
NetworkSystemId,
/// <summary>
- /// Notification to be invoked when the network ID changes.
- /// 'nid(int)' will be delivered in notification data.
+ /// The notification to be invoked when the network ID changes.
+ /// 'nid(int)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
NetworkId,
/// <summary>
- /// Notification to be invoked when the base station ID changes.
- /// 'id(int)' will be delivered in notification data.
+ /// The notification to be invoked when the base station ID changes.
+ /// 'id(int)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
NetworkBsId,
/// <summary>
- /// Notification to be invoked when the base station latitude changes.
- /// 'latitude(int)' will be delivered in notification data.
+ /// The notification to be invoked when the base station latitude changes.
+ /// 'latitude(int)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
NetworkBsLatitude,
/// <summary>
- /// Notification to be invoked when the base station longitude changes.
- /// 'longitue(int)' will be delivered in notification data.
+ /// The notification to be invoked when the base station longitude changes.
+ /// 'longitue(int)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
NetworkBsLongitude,
/// <summary>
- /// Notification to be invoked when a voice call is in idle status.
- /// 'handle id(uint)' will be delivered in notification data.
+ /// The notification to be invoked when a voice call is in the idle status.
+ /// 'handle id(uint)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
VoiceCallStatusIdle,
/// <summary>
- /// Notification to be invoked when a voice call is in active status.
- /// 'handle id(uint)' will be delivered in notification data.
+ /// The notification to be invoked when a voice call is in the active status.
+ /// 'handle id(uint)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
VoiceCallStatusActive,
/// <summary>
- /// Notification to be invoked when a voice call is in held status.
- /// 'handle id(uint)' will be delivered in notification data.
+ /// The notification to be invoked when a voice call is in the held status.
+ /// 'handle id(uint)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
VoiceCallStatusHeld,
/// <summary>
- /// Notification to be invoked when a voice call is in dialing status.
- /// 'handle id(uint)' will be delivered in notification data.
+ /// The notification to be invoked when a voice call is in the dialing status.
+ /// 'handle id(uint)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
VoiceCallStatusDialing,
/// <summary>
- /// Notification to be invoked when a voice call is in alertingstatus.
- /// 'handle id(uint)' will be delivered in notification data.
+ /// The notification to be invoked when a voice call is in the alerting status.
+ /// 'handle id(uint)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
VoiceCallStatusAlerting,
/// <summary>
- /// Notification to be invoked when a voice call is in incoming status.
- /// 'handle id(uint)' will be delivered in notification data.
+ /// The notification to be invoked when a voice call is in the incoming status.
+ /// 'handle id(uint)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
VoiceCallStatusIncoming,
/// <summary>
- /// Notification to be invoked when a video call is in idle status.
- /// 'handle id(uint)' will be delivered in notification data.
+ /// The notification to be invoked when a video call is in the idle status.
+ /// 'handle id(uint)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
VideoCallStatusIdle,
/// <summary>
- /// Notification to be invoked when a video call is in active status.
- /// 'handle id(uint)' will be delivered in notification data.
+ /// The notification to be invoked when a video call is in the active status.
+ /// 'handle id(uint)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
VideoCallStatusActive,
/// <summary>
- /// Notification to be invoked when a video call is in dialing status.
- /// 'handle id(uint)' will be delivered in notification data.
+ /// The notification to be invoked when a video call is in the dialing status.
+ /// 'handle id(uint)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
VideoCallStatusDialing,
/// <summary>
- /// Notification to be invoked when a video call is in alerting status.
- /// 'handle id(uint)' will be delivered in notification data
+ /// The notification to be invoked when a video call is in the alerting status.
+ /// 'handle id(uint)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
VideoCallStatusAlerting,
/// <summary>
- /// Notification to be invoked when a video call is in incoming status.
- /// 'handle id(uint)' will be delivered in notification data
+ /// The notification to be invoked when a video call is in the incoming status.
+ /// 'handle id(uint)' will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
/// </privilege>
VideoCallStatusIncoming,
/// <summary>
- /// Notification to be invoked when the preferred voice subscription changes.
- /// CallPreferredVoiceSubscription will be delivered in notification data
+ /// The notification to be invoked when the preferred voice subscription changes.
+ /// CallPreferredVoiceSubscription will be delivered in the notification data.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>
};
/// <summary>
- /// Telephony notification type
+ /// The Telephony Notification type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public Notification NotificationType
}
/// <summary>
- /// Data as per the Notification type
+ /// The data as per the Notification type.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public object NotificationData
namespace Tizen.Telephony
{
/// <summary>
- /// This Class provides API's to obtain information from the modem.
+ /// This class provides APIs to obtain information from the modem.
/// </summary>
public class Modem
{
internal IntPtr _handle;
/// <summary>
- /// Modem Class Constructor
+ /// The Modem class constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="handle">
- /// SlotHandle received in the Manager.Init API
+ /// SlotHandle received in the Manager.Init API.
/// </param>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="ArgumentNullException">
- /// This exception occurs if handle provided is null
+ /// This exception occurs if the handle provided is null.
/// </exception>
public Modem(SlotHandle handle)
{
}
/// <summary>
- /// Enumeration for Modem Power Status.
+ /// Enumeration for the Modem Power Status.
/// </summary>
public enum PowerStatus
{
/// <summary>
- /// Unknown
+ /// Unknown.
/// </summary>
Unknown = -1,
/// <summary>
- /// Modem power ON
+ /// Modem power ON.
/// </summary>
On,
/// <summary>
- /// Modem power OFF
+ /// Modem power OFF.
/// </summary>
Off,
/// <summary>
- /// Modem power RESET
+ /// Modem power RESET.
/// </summary>
Reset,
/// <summary>
- /// Modem power LOW
+ /// Modem power LOW.
/// </summary>
Low
};
/// <summary>
/// Gets the IMEI (International Mobile Station Equipment Identity) of a mobile phone.
- /// The IMEI number is used by a GSM network to identify valid devices and therefore can be used for stopping a stolen phone from accessing that network.
+ /// The IMEI number is used by a GSM network to identify valid devices and therefore, can be used for stopping a stolen phone from accessing that network.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The International Mobile Station Equipment Identity
- /// empty string if unable to complete the operation
+ /// The International Mobile Station Equipment Identity.
+ /// Empty string if unable to complete the operation.
/// </value>
public string Imei
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The Modem power status (0=on,1=off,2=reset,3=low)
+ /// The Modem power status (0=on,1=off,2=reset,3=low).
/// </value>
public PowerStatus CurrentPowerStatus
{
}
/// <summary>
- /// Gets the MEID (Mobile Equipment Identifier) of a mobile phone. (for CDMA)
+ /// Gets the MEID (Mobile Equipment Identifier) of a mobile phone (for CDMA).
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The Mobile Equipment Identifier
- /// empty string if unable to complete the operation
+ /// The Mobile Equipment Identifier.
+ /// Empty string if unable to complete the operation.
/// </value>
public string Meid
{
namespace Tizen.Telephony
{
/// <summary>
- /// The Network class provides API's to obtain information about the current telephony service network.
+ /// The Network class provides APIs to obtain information about the current telephony service network.
/// </summary>
public class Network
{
internal IntPtr _handle;
/// <summary>
- /// Network Class Constructor
+ /// The Network class constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="handle">
- /// SlotHandle received in the Manager.Init API
+ /// SlotHandle received in the Manager.Init API.
/// </param>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="ArgumentNullException">
- /// This exception occurs if handle provided is null
+ /// This exception occurs if the handle provided is null.
/// </exception>
public Network(SlotHandle handle)
{
}
/// <summary>
- /// Enumeration for RSSI (Receive Signal Strength Indicator).
+ /// Enumeration for the RSSI (Receive Signal Strength Indicator).
/// Rssi6 indicates the highest strength.
/// </summary>
public enum Rssi
{
/// <summary>
- /// Strength 0
+ /// Strength 0.
/// </summary>
Rssi0,
/// <summary>
- /// Strength 1
+ /// Strength 1.
/// </summary>
Rssi1,
/// <summary>
- /// Strength 2
+ /// Strength 2.
/// </summary>
Rssi2,
/// <summary>
- /// Strength 3
+ /// Strength 3.
/// </summary>
Rssi3,
/// <summary>
- /// Strength 4
+ /// Strength 4.
/// </summary>
Rssi4,
/// <summary>
- /// Strength 5
+ /// Strength 5.
/// </summary>
Rssi5,
/// <summary>
- /// Strength 6
+ /// Strength 6.
/// </summary>
Rssi6,
/// <summary>
- /// Unavailable
+ /// Unavailable.
/// </summary>
Unavailable
}
/// <summary>
- /// Enumeration for Network Type.
+ /// Enumeration for the network types.
/// </summary>
public enum Type
{
/// <summary>
- /// Unknown
+ /// Unknown.
/// </summary>
Unknown,
/// <summary>
- /// 2G GSM network type
+ /// 2G GSM network type.
/// </summary>
Gsm,
/// <summary>
- /// 2.5G GPRS network type
+ /// 2.5G GPRS network type.
/// </summary>
Gprs,
/// <summary>
- /// 2.5G EDGE network type
+ /// 2.5G EDGE network type.
/// </summary>
Edge,
/// <summary>
- /// 3G UMTS network type
+ /// 3G UMTS network type.
/// </summary>
Umts,
/// <summary>
- /// HSDPA network type
+ /// HSDPA network type.
/// </summary>
Hsdpa,
/// <summary>
- /// LTE network type
+ /// LTE network type.
/// </summary>
Lte,
/// <summary>
- /// IS95A network type
+ /// IS95A network type.
/// </summary>
Is95a,
/// <summary>
- /// IS95B network type
+ /// IS95B network type.
/// </summary>
Is95b,
/// <summary>
- /// CDMA 1x network type
+ /// CDMA 1x network type.
/// </summary>
Cdma1X,
/// <summary>
- /// EVDO revision 0 network type
+ /// EVDO revision 0 network type.
/// </summary>
EvdoRev0,
/// <summary>
- /// EVDO revision A network type
+ /// EVDO revision A network type.
/// </summary>
EvdoRevA,
/// <summary>
- /// EVDO revision B network type
+ /// EVDO revision B network type.
/// </summary>
EvdoRevB,
/// <summary>
- /// EVDV network type
+ /// EVDV network type.
/// </summary>
Evdv,
/// <summary>
- /// EHRPD network type
+ /// EHRPD network type.
/// </summary>
Ehrpd
}
/// <summary>
- /// Enumeration for PS Type.
+ /// Enumeration for the PS types.
/// </summary>
public enum PsType
{
/// <summary>
- /// Unknown
+ /// Unknown.
/// </summary>
Unknown,
/// <summary>
- /// HSDPA ps type
+ /// HSDPA PS type.
/// </summary>
Hsdpa,
/// <summary>
- /// HSUPA ps type
+ /// HSUPA PS type.
/// </summary>
Hsupa,
/// <summary>
- /// HSPA ps type
+ /// HSPA PS type.
/// </summary>
Hspa,
/// <summary>
- /// HSPAP ps type
+ /// HSPAP PS type.
/// </summary>
Hspap
}
/// <summary>
- /// Enumeration for Network Service State.
+ /// Enumeration for the network service states.
/// </summary>
public enum ServiceState
{
/// <summary>
- /// In service
+ /// In service.
/// </summary>
InService,
/// <summary>
- /// Out of service
+ /// Out of service.
/// </summary>
OutOfService,
/// <summary>
- /// Only emergency call is allowed
+ /// Only emergency call is allowed.
/// </summary>
EmergencyOnly,
/// <summary>
- /// Unavailable
+ /// Unavailable.
/// </summary>
Unavailable
}
/// <summary>
- /// Enumeration for Network Name Priority.
+ /// Enumeration for the network name priority.
/// </summary>
public enum NameOption
{
/// <summary>
- /// Unknown
+ /// Unknown.
/// </summary>
Unknown,
/// <summary>
- /// Network name displayed by SPN
+ /// The network name displayed by the SPN.
/// </summary>
Spn,
/// <summary>
- /// Network name displayed by Network
+ /// The network name displayed by the Network.
/// </summary>
Network,
/// <summary>
- /// Network name displayed by SPN or Network
+ /// The network name displayed by the SPN or the Network.
/// </summary>
Any
}
/// <summary>
- /// Enumeration for the possible 'default' Data Subscriptions for Packet Switched(PS).
+ /// Enumeration for the possible 'default' Data Subscriptions for the Packet Switched(PS).
/// </summary>
public enum DefaultDataSubscription
{
/// <summary>
- /// Unknown status
+ /// Unknown status.
/// </summary>
Unknown = -1,
/// <summary>
- /// SIM 1
+ /// SIM 1.
/// </summary>
Sim1,
/// <summary>
- /// SIM 2
+ /// SIM 2.
/// </summary>
Sim2
}
/// <summary>
- /// Enumeration defines possible 'default' Subscriptions for Circuit Switched(CS).
+ /// Enumeration for defining the possible 'default' Subscriptions for the Circuit Switched(CS).
/// </summary>
public enum DefaultSubscription
{
/// <summary>
- /// Unknown status
+ /// Unknown status.
/// </summary>
Unknown = -1,
/// <summary>
- /// SIM 1 network
+ /// SIM 1 network.
/// </summary>
Sim1,
/// <summary>
- /// SIM 2 network
+ /// SIM 2 network.
/// </summary>
Sim2
}
/// <summary>
- /// Enumeration for network selection mode.
+ /// Enumeration for the network selection modes.
/// </summary>
public enum SelectionMode
{
/// <summary>
- /// Automatic mode
+ /// Automatic mode.
/// </summary>
Automatic,
/// <summary>
- /// Manual mode
+ /// Manual mode.
/// </summary>
Manual,
/// <summary>
- /// Unavailable
+ /// Unavailable.
/// </summary>
Unavailable
}
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location.coarse</privilege>
/// <remarks>
- /// This API can be used in GSM / WCDMA network.
+ /// This API can be used in the GSM/WCDMA network.
/// </remarks>
/// <value>
- /// The Location Area Code, -1 if unknown
+ /// The Location Area Code, -1 if unknown.
/// </value>
public int Lac
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location.coarse</privilege>
/// <remarks>
- /// This API can be used in GSM / WCDMA / LTE network.
+ /// This API can be used in the GSM/WCDMA/LTE network.
/// </remarks>
/// <value>
- /// The cell identification number, -1 if unknown
+ /// The cell identification number, -1 if unknown.
/// </value>
public int CellId
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The Received Signal Strength Indicator
+ /// The Received Signal Strength Indicator.
/// Higher the received number, the stronger the signal strength.
/// </value>
public Rssi CurrentRssi
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// true if roaming, otherwise false if not roaming
+ /// true if roaming, otherwise false if not roaming.
/// </value>
public bool RoamingStatus
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <remarks>
- /// This API can be used in GSM / WCDMA / LTE network.
+ /// This API can be used in the GSM/WCDMA/LTE network.
/// </remarks>
/// <value>
- /// The Mobile Country Code (three digits) Mobile Country Code (MCC) identifies the country where the cell is being used.
- /// empty string if unknown.
+ /// The Mobile Country Code (three digits). The Mobile Country Code (MCC) identifies the country where the cell is being used.
+ /// Empty string if unknown.
/// </value>
public string Mcc
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <remarks>
- /// This API can be used in GSM / WCDMA / LTE network.
+ /// This API can be used in the GSM/WCDMA/LTE network.
/// </remarks>
/// <value>
- /// The Mobile Network Code (three digits) The Mobile Network Code (MNC) identifies the mobile phone operator and network provider.
- /// empty string if unknown.
+ /// The Mobile Network Code (three digits). The Mobile Network Code (MNC) identifies the mobile phone operator and the network provider.
+ /// Empty string if unknown.
/// </value>
public string Mnc
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <remarks>
- /// This API can be used in GSM / WCDMA / LTE network.
+ /// This API can be used in the GSM/WCDMA/LTE network.
/// </remarks>
/// <value>
- /// The name of the current registered network
- /// empty string if unknown.
+ /// The name of the current registered network.
+ /// Empty string if unknown.
/// </value>
public string NetworkName
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <remarks>
- /// This API can be used in case network is in service.
+ /// This API can be used in case the network is in service.
/// </remarks>
/// <value>
- /// The network service type
+ /// The network service type.
/// </value>
public Type NetworkType
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <remarks>
- /// This API can be used in HSDPA network.
+ /// This API can be used in the HSDPA network.
/// </remarks>
/// <value>
- /// The type of packet service
+ /// The type of the packet service.
/// </value>
public PsType NetworkPsType
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The network name display option
+ /// The network name display option.
/// </value>
public NameOption NetworkNameOption
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The current network state
+ /// The current network state.
/// </value>
public ServiceState NetworkServiceState
{
}
/// <summary>
- /// Gets the current default subscription for data service (Packet Switched).
+ /// Gets the current default subscription for the data service (Packet Switched).
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The current default data subscription
+ /// The current default data subscription.
/// </value>
public DefaultDataSubscription NetworkDefaultDataSubscription
{
}
/// <summary>
- /// Gets the current default subscription for voice service (Circuit Switched).
+ /// Gets the current default subscription for the voice service (Circuit Switched).
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The current default voice subscription
+ /// The current default voice subscription.
/// </value>
public DefaultSubscription NetworkDefaultSubscription
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location.coarse</privilege>
/// <remarks>
- /// This API can be used in LTE network.
+ /// This API can be used in the LTE network.
/// </remarks>
/// <value>
- /// The Tracking Area Code
- /// -1 if unknown
+ /// The Tracking Area Code.
+ /// -1 if unknown.
/// </value>
public int Tac
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location.coarse</privilege>
/// <remarks>
- /// This API can be used in CDMA network.
+ /// This API can be used in the CDMA network.
/// </remarks>
/// <value>
- /// The system ID
- /// -1 if unknown
+ /// The system ID.
+ /// -1 if unknown.
/// </value>
public int SystemId
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location.coarse</privilege>
/// <remarks>
- /// This API can be used in CDMA network.
+ /// This API can be used in the CDMA network.
/// </remarks>
/// <value>
- /// The network ID
- /// -1 if unknown
+ /// The network ID.
+ /// -1 if unknown.
/// </value>
public int NetworkId
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location.coarse</privilege>>
/// <remarks>
- /// This API can be used in CDMA network.
+ /// This API can be used in the CDMA network.
/// </remarks>
/// <value>
- /// The base station ID
- /// -1 if unknown
+ /// The base station ID.
+ /// -1 if unknown.
/// </value>
public int BaseStationId
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location.coarse</privilege>
/// <remarks>
- /// This API can be used in CDMA network.
+ /// This API can be used in the CDMA network.
/// </remarks>
/// <value>
- /// The base station latitude
- /// 0x7FFFFFFF if unknown
+ /// The base station latitude.
+ /// 0x7FFFFFFF if unknown.
/// </value>
public int BaseStationLatitude
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/location.coarse</privilege>
/// <remarks>
- /// This API can be used in CDMA network.
+ /// This API can be used in the CDMA network.
/// </remarks>
/// <value>
- /// The base station latitude
- /// 0x7FFFFFFF if unknown
+ /// The base station latitude.
+ /// 0x7FFFFFFF if unknown.
/// </value>
public int BaseStationLongitude
{
namespace Tizen.Telephony
{
/// <summary>
- /// This Class provides API's that allows you to extract information stored on a SIM card
+ /// This class provides APIs that allow you to extract the information stored on a SIM card.
/// </summary>
public class Sim
{
internal IntPtr _handle;
/// <summary>
- /// Sim Class Constructor
+ /// The SIM class constructor.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="handle">
- /// SlotHandle received in the Manager.Init API
+ /// SlotHandle received in the Manager.Init API.
/// </param>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="ArgumentNullException">
- /// This exception occurs if handle provided is null
+ /// This exception occurs if the handle provided is null.
/// </exception>
public Sim(SlotHandle handle)
{
}
/// <summary>
- /// Enumeration for the state of SIM card.
+ /// Enumeration for the state of the SIM card.
/// </summary>
public enum State
{
/// <summary>
- /// SIM is not available on this device
+ /// The SIM is not available on this device.
/// </summary>
Unavailable,
/// <summary>
- /// SIM is locked
+ /// The SIM is locked.
/// </summary>
Locked,
/// <summary>
- /// SIM is available on this device (SIM is not locked)
+ /// The SIM is available on this device (SIM is not locked).
/// </summary>
Available,
/// <summary>
- /// SIM is in transition between states
+ /// The SIM is in transition between states.
/// </summary>
Unknown
}
/// <summary>
- /// Enumeration for the lock state of SIM card.
+ /// Enumeration for the lock state of the SIM card.
/// </summary>
public enum LockState
{
/// <summary>
- /// SIM is not in lock
+ /// The SIM is not in lock.
/// </summary>
Unknown,
/// <summary>
- /// SIM is PIN(Personal Identification Number) locked
+ /// The SIM is PIN (Personal Identification Number) locked.
/// </summary>
PinRequired,
/// <summary>
- /// SIM is PUK(Personal Unblocking Code) locked
+ /// The SIM is PUK (Personal Unblocking Code) locked.
/// </summary>
PukRequired,
/// <summary>
- /// SIM is permanently blocked(All the attempts for PIN/PUK failed)
+ /// The SIM is permanently blocked (All the attempts for PIN/PUK failed).
/// </summary>
PermLocked,
/// <summary>
- /// SIM is NCK(Network Control Key) locked
+ /// The SIM is NCK (Network Control Key) locked.
/// </summary>
NckRequired
}
/// <summary>
- /// Enumeration for the type of SIM card.
+ /// Enumeration for the type of the SIM card.
/// </summary>
public enum ApplicationType
{
/// <summary>
- /// SIM(GSM) Application
+ /// SIM (GSM) application.
/// </summary>
Sim = 0x01,
/// <summary>
- /// USIM Application
+ /// USIM application.
/// </summary>
Usim = 0x02,
/// <summary>
- /// CDMA Application
+ /// CDMA application.
/// </summary>
Csim = 0x04,
/// <summary>
- /// ISIM Application
+ /// ISIM application.
/// </summary>
Isim = 0x08
}
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The Integrated Circuit Card Identification
- /// empty string if unable to complete the operation
+ /// The Integrated Circuit Card Identification.
+ /// Empty string if unable to complete the operation.
/// </value>
/// <precondition>
- /// The SIM state must be Available
+ /// The SIM state must be Available.
/// </precondition>
public string IccId
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The SIM Operator
- /// empty string if unable to complete the operation
+ /// The SIM Operator.
+ /// Empty string if unable to complete the operation.
/// </value>
/// <precondition>
- /// The SIM state must be Available
+ /// The SIM state must be Available.
/// </precondition>
public string Operator
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The Mobile Subscription Identification Number
- /// empty string if unable to complete the operation
+ /// The Mobile Subscription Identification Number.
+ /// Empty string if unable to complete the operation.
/// </value>
/// <precondition>
- /// The SIM state must be Available
+ /// The SIM state must be Available.
/// </precondition>
public string Msin
{
/// <summary>
/// Gets the Service Provider Name (SPN) of the SIM card.
- /// Gets Service Provider Name embedded in the SIM card.If this value is not stored in SIM card, empty string will be returned.
+ /// Gets Service Provider Name embedded in the SIM card. If this value is not stored in the SIM card, an empty string will be returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The Service Provider Name
- /// empty string if unable to complete the operation
+ /// The Service Provider Name.
+ /// Empty string if unable to complete the operation.
/// </value>
/// <precondition>
- /// The SIM state must be Available
+ /// The SIM state must be Available.
/// </precondition>
public string Spn
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// true if the current SIM card is different from the previous SIM card, otherwise false if the SIM card is not changed
+ /// true if the current SIM card is different from the previous SIM card, otherwise false if the SIM card is not changed.
/// </value>
/// <precondition>
- /// The SIM state must be Available
+ /// The SIM state must be Available.
/// </precondition>
public bool IsChanged
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The current state of the SIM
+ /// The current state of the SIM.
/// </value>
public State CurrentState
{
}
/// <summary>
- /// Gets the count of application on UICC.
+ /// Gets the count of an application on the UICC.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The masking value for below values are provided by the enum ApplicationType
- /// 0 if unable to complete the operation
+ /// The masking value for below values are provided by the enumeration ApplicationType.
+ /// 0 if unable to complete the operation.
/// </value>
/// <precondition>
- /// The SIM state must be Available
+ /// The SIM state must be Available.
/// </precondition>
public uint ApplicationList
{
}
/// <summary>
- /// Gets subscriber number embedded in the SIM card. This value contains MSISDN related to the subscriber.
- /// If this value is not stored in SIM card, empty string will be returned.
+ /// Gets the subscriber number embedded in the SIM card. This value contains the MSISDN related to the subscriber.
+ /// If this value is not stored in SIM card, an empty string will be returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The subscriber number in the SIM
- /// empty string if unable to complete the operation
+ /// The subscriber number in the SIM.
+ /// Empty string if unable to complete the operation.
/// </value>
/// <precondition>
- /// The SIM state must be Available
+ /// The SIM state must be Available.
/// </precondition>
public string SubscriberNumber
{
}
/// <summary>
- /// Gets the Subscriber ID.
+ /// Gets the subscriber ID.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The subscriber ID
- /// empty string if unable to complete the operation
+ /// The subscriber ID.
+ /// Empty string if unable to complete the operation.
/// </value>
/// <precondition>
- /// The SIM state must be Available
+ /// The SIM state must be Available.
/// </precondition>
public string SubscriberId
{
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The current lock state of the SIM
+ /// The current lock state of the SIM.
/// </value>
/// <precondition>
- /// The SIM state must be Available
+ /// The SIM state must be Available.
/// </precondition>
public LockState CurrentLockState
{
/// <summary>
/// Gets the GID1 (Group Identifier Level 1).
- /// Gets Group Identifier Level 1(GID1) embedded in the SIM card.If this value is not stored in SIM card, empty string will be returned.
+ /// Gets Group Identifier Level 1 (GID1) embedded in the SIM card. If this value is not stored in SIM card, an empty string will be returned.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The GID1 (Group Identifier Level 1)
- /// empty string if unable to complete the operation
+ /// The GID1 (Group Identifier Level 1).
+ /// Empty string if unable to complete the operation.
/// </value>
/// <precondition>
- /// The SIM state must be Available
+ /// The SIM state must be Available.
/// </precondition>
public string GroupId1
{
/// <summary>
/// Gets the call forwarding indicator state of the SIM.
- /// If the state is true, incoming call will be forwarded to the selected number.state indicates the CFU(Call Forwarding Unconditional) indicator status - Voice. (3GPP TS 31.102 4.2.64 EF CFIS)
+ /// If the state is true, the incoming call will be forwarded to the selected number. State indicates the CFU (Call Forwarding Unconditional) indicator status - Voice (3GPP TS 31.102 4.2.64 EF CFIS).
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/telephony</privilege>
/// <value>
- /// The value whether incoming call will be forwarded or not. (true: forwarded, false: not forwarded)
+ /// The value whether the incoming call will be forwarded or not (true: forwarded, false: not forwarded).
/// </value>
/// <precondition>
- /// The SIM state must be Available
+ /// The SIM state must be Available.
/// </precondition>
public bool CallForwardingIndicatorState
{
namespace Tizen.Telephony
{
/// <summary>
- /// This Class provides API's that provides functionality related to slot handle.
+ /// This class provides APIs that provide functionality related to the slot handle.
/// </summary>
public class SlotHandle
{
}
/// <summary>
- /// Event Handler for Receiving the Telephony State Changes
- /// this event will be triggered for the NotificationId's given in the SetNotificationId API
+ /// The event handler for receiving the Telephony state changes.
+ /// This event will be triggered for the NotificationIds given in the SetNotificationId API.
/// </summary>
public event EventHandler<ChangeNotificationEventArgs> ChangeNotification;
}
/// <summary>
- /// The Notification Id's for which the ChangeNotification event will be triggered
+ /// The notification IDs for which the ChangeNotification event will be triggered.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="list">
- /// The List of Notification Id's for which the ChangeNotification event will be triggered
+ /// The list of notification IDs for which the ChangeNotification event will be triggered.
/// </param>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">
/// This Exception can occur due to:
- /// 1. Operation Not Supported
- /// 2. Operation Failed
+ /// 1. Operation not supported.
+ /// 2. Operation failed.
/// </exception>
public void SetNotificationId(IEnumerable<ChangeNotificationEventArgs.Notification> list)
{
}
/// <summary>
- /// The Notification Id's for which the ChangeNotification event will not be triggered
+ /// The notification IDs for which the ChangeNotification event will not be triggered.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <param name="list">
- /// The List of Notification Id's for which the ChangeNotification event will be not be triggered
+ /// The list of notification IDs for which the ChangeNotification event will be not be triggered.
/// </param>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">
/// This Exception can occur due to:
- /// 1. Operation Not Supported
- /// 2. Operation Failed
+ /// 1. Operation not supported.
+ /// 2. Operation failed.
/// </exception>
public void RemoveNotificationId(IEnumerable<ChangeNotificationEventArgs.Notification> list)
{
namespace Tizen.Telephony
{
/// <summary>
- /// This class contain the data related to the State changed event
+ /// This class contains the data related to the State changed event.
/// </summary>
public class StateEventArgs : EventArgs
{
}
/// <summary>
- /// The Current State
+ /// The Current State.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public State CurrentState
namespace Tizen.Telephony
{
/// <summary>
- /// Enumeration for the telephony state.
+ /// Enumeration for the telephony states.
/// </summary>
public enum State
{
/// <summary>
- /// Telephony state is not ready
+ /// The telephony state is not ready.
/// </summary>
NotReady,
/// <summary>
- /// Telephony state is ready
+ /// The telephony state is ready.
/// </summary>
Ready,
/// <summary>
- /// Unavailable
+ /// Unavailable.
/// </summary>
Unavailable
};
public enum CallPreferredVoiceSubscription
{
/// <summary>
- /// Unknown status
+ /// Unknown status.
/// </summary>
Unknown = -1,
/// <summary>
- /// Current network
+ /// Current network.
/// </summary>
CurrentNetwork = 0,
/// <summary>
- /// ASK Always
+ /// Ask Always.
/// </summary>
AskAlways,
/// <summary>
- /// SIM 1
+ /// SIM 1.
/// </summary>
Sim1,
/// <summary>
- /// SIM 2
+ /// SIM 2.
/// </summary>
Sim2
};
/// <summary>
- /// This Class provides API's to Initialize and Deinitialize the framework
- /// it also provides API's to get the SlotHandle's which can then be used to get other Network/Sim/Call/Modem Information.
+ /// This class provides APIs to initialize and deinitialize the framework.
+ /// It also provides APIs to get the SlotHandles, which can then be used to get other Network/Sim/Call/Modem information.
/// </summary>
public static class Manager
{
};
/// <summary>
- /// Event Handler to be invoked when the telephony state changes.
+ /// The event handler to be invoked when the telephony state changes.
/// </summary>
/// <since_tizen> 3 </since_tizen>
public static event EventHandler<StateEventArgs> StateChanged
}
/// <summary>
- /// Acquires the Number of available handles to use the telephony API.
+ /// Acquires the number of available handles to use the telephony API.
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <returns>
- /// A List of Telephony handles.
- /// You will get 2 SlotHandles in case of dual SIM device.
- /// where,SlotHandle at Index '0' represents Primary SIM and Index '1' represents Secondary SIM.
+ /// A list of telephony handles.
+ /// You will get 2 SlotHandles in case of the dual SIM device.
+ /// Where, SlotHandle at Index '0' represents the primary SIM and Index '1' represents the secondary SIM.
/// </returns>
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">
- /// This Exception can will be generated in the following cases
- /// 1. System is out of memory
- /// 2. If the operation is not supported on device
- /// 3. If the Operation Failed
+ /// This exception will be generated in the following cases:
+ /// 1. The system is out of memory.
+ /// 2. If the operation is not supported on the device.
+ /// 3. If the operation failed.
/// </exception>
public static IEnumerable<SlotHandle> Init()
{
/// <feature>http://tizen.org/feature/network.telephony</feature>
/// <exception cref="NotSupportedException">The required feature is not supported.</exception>
/// <exception cref="InvalidOperationException">
- /// This Exception can be generated in the following cases
- /// 1. If the operation is not supported on device
- /// 2. If the Operation Failed
+ /// This exception can be generated in the following cases:
+ /// 1. If the operation is not supported on the device.
+ /// 2. If the operation failed.
/// </exception>
public static void Deinit()
{
projects / platform / core / csapi / tizenfx.git / commitdiff