From: Piotr Szydelko Date: Tue, 31 Oct 2017 07:59:36 +0000 (+0100) Subject: Setting since_tizen 3/4 on Tizen.NET API X-Git-Tag: 5.0.0-preview1-00356~3 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=6423e7f0e23e4e05f6b0fad6bacfd2613a31e6d2;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git Setting since_tizen 3/4 on Tizen.NET API Signed-off-by: Piotr Szydelko Change-Id: If7fbb42c28f785913bf09a84b4a3661909fc452b --- diff --git a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountEnums.cs b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountEnums.cs index 53942e0..773a299 100644 --- a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountEnums.cs +++ b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountEnums.cs @@ -44,6 +44,7 @@ namespace Tizen.Account.AccountManager /// /// Enumeration for the state of account secrecy. /// + /// 3 public enum AccountSecrecyState { /// diff --git a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountErrorFactory.cs b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountErrorFactory.cs index f23c792..837c4f4 100644 --- a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountErrorFactory.cs +++ b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/AccountErrorFactory.cs @@ -44,7 +44,7 @@ namespace Tizen.Account.AccountManager /// /// Same user name exists in your application. /// - /// 3 + /// 4 Duplicated = -0x01000000 | 0x01, /// /// Empty data. diff --git a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/SafeAccountHandle.cs b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/SafeAccountHandle.cs index 3da224c..abdf95e 100644 --- a/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/SafeAccountHandle.cs +++ b/src/Tizen.Account.AccountManager/Tizen.Account.AccountManager/SafeAccountHandle.cs @@ -23,11 +23,13 @@ namespace Tizen.Account.AccountManager /// /// Represents a wrapper class for a unmanaged Account handle. /// + /// 4 public sealed class SafeAccountHandle : SafeHandle { /// /// Initializes a new instance of the SafeAppControlHandle class. /// + /// 4 public SafeAccountHandle() : base(IntPtr.Zero, true) { } @@ -37,6 +39,7 @@ namespace Tizen.Account.AccountManager /// /// An IntPtr object that represents the pre-existing handle to use. /// true to reliably release the handle during the finalization phase; false to prevent reliable release. + /// 4 public SafeAccountHandle(IntPtr existingHandle, bool ownsHandle) : base(IntPtr.Zero, ownsHandle) { SetHandle(existingHandle); @@ -45,6 +48,7 @@ namespace Tizen.Account.AccountManager /// /// Gets a value that indicates whether the handle is invalid. /// + /// 4 public override bool IsInvalid { get { return this.handle == IntPtr.Zero; } diff --git a/src/Tizen.Account.FidoClient/Tizen.Account.FidoClient/UafAuthenticatorFinder.cs b/src/Tizen.Account.FidoClient/Tizen.Account.FidoClient/UafAuthenticatorFinder.cs index 2f13307..059e6c4 100755 --- a/src/Tizen.Account.FidoClient/Tizen.Account.FidoClient/UafAuthenticatorFinder.cs +++ b/src/Tizen.Account.FidoClient/Tizen.Account.FidoClient/UafAuthenticatorFinder.cs @@ -47,6 +47,7 @@ namespace Tizen.Account.FidoClient /// } /// /// + /// 3 public static async Task> DiscoverAuthenticatorsAsync() { IEnumerable result = null; diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/CodeGrantAuthorizationRequest.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/CodeGrantAuthorizationRequest.cs index 385a798..2935117 100755 --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/CodeGrantAuthorizationRequest.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/CodeGrantAuthorizationRequest.cs @@ -20,6 +20,7 @@ namespace Tizen.Account.OAuth2 /// The class contains request parameters for retreiving authorization code in Authorization Code Grant flow. /// Please refer https://tools.ietf.org/html/rfc6749#section-4.1.1 for more details /// + /// 3 public class CodeGrantAuthorizationRequest : AuthorizationRequest { /// diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ImplicitGrantAuthorizationRequest.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ImplicitGrantAuthorizationRequest.cs index 5b0c50a..7c9b642 100755 --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ImplicitGrantAuthorizationRequest.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ImplicitGrantAuthorizationRequest.cs @@ -19,6 +19,7 @@ namespace Tizen.Account.OAuth2 /// /// The class contains request parameters for retreiving access token in Implicit Grant flow. /// + /// 3 public class ImplicitGrantAuthorizationRequest : AuthorizationRequest { /// diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/OAuth2ErrorResponse.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/OAuth2ErrorResponse.cs index 82f1024..9e8d3fe 100755 --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/OAuth2ErrorResponse.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/OAuth2ErrorResponse.cs @@ -21,6 +21,7 @@ namespace Tizen.Account.OAuth2 /// /// Exception wrapper for OAuth2 related exception /// + /// 3 public class OAuth2Exception : Exception { internal OAuth2Exception() diff --git a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ResourceOwnerPwdCredentialsTokenRequest.cs b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ResourceOwnerPwdCredentialsTokenRequest.cs index a0cf7fa..e8c3afc 100755 --- a/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ResourceOwnerPwdCredentialsTokenRequest.cs +++ b/src/Tizen.Account.OAuth2/Tizen.Account.OAuth2/ResourceOwnerPwdCredentialsTokenRequest.cs @@ -25,6 +25,7 @@ namespace Tizen.Account.OAuth2 /// /// The constructor /// + /// 3 public ResourceOwnerPwdCredentialsTokenRequest() { diff --git a/src/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs b/src/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs index 0169151..984f335 100755 --- a/src/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs +++ b/src/Tizen.Applications.Alarm/Tizen.Applications/Alarm.cs @@ -31,6 +31,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public class Alarm { private const string _logTag = "Tizen.Applications.Alarm"; @@ -47,6 +48,7 @@ namespace Tizen.Applications /// /// The alarm ID uniquely identifies an alarm. /// + /// 3 public int AlarmId { get; private set; @@ -59,6 +61,7 @@ namespace Tizen.Applications /// /// week_flag may be a combination of days, like Tuesday | Friday. /// + /// 3 public AlarmWeekFlag WeekFlag { get @@ -78,6 +81,7 @@ namespace Tizen.Applications /// Gets the scheduled time. /// /// http://tizen.org/privilege/alarm.get + /// 3 public DateTime ScheduledDate { get @@ -98,6 +102,7 @@ namespace Tizen.Applications /// Gets the period of time between the recurrent alarms. /// /// http://tizen.org/privilege/alarm.get + /// 3 public int Period { get @@ -117,6 +122,7 @@ namespace Tizen.Applications /// Gets the AppControl to be invoked when the the alarm is triggered. /// /// http://tizen.org/privilege/alarm.get + /// 3 public AppControl AlarmAppControl { get @@ -138,6 +144,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/alarm.set /// http://tizen.org/privilege/alarm.get + /// 3 public bool Global { get @@ -169,6 +176,7 @@ namespace Tizen.Applications /// Thrown in case of a permission denied due to insufficient privileges. /// Thrown in case of any internal error. /// http://tizen.org/privilege/alarm.set + /// 3 public void Cancel() { AlarmError ret = (AlarmError)Interop.Alarm.CancelAlarm(AlarmId); diff --git a/src/Tizen.Applications.Alarm/Tizen.Applications/AlarmManager.cs b/src/Tizen.Applications.Alarm/Tizen.Applications/AlarmManager.cs index 7faff6f..ecd6534 100755 --- a/src/Tizen.Applications.Alarm/Tizen.Applications/AlarmManager.cs +++ b/src/Tizen.Applications.Alarm/Tizen.Applications/AlarmManager.cs @@ -24,6 +24,7 @@ namespace Tizen.Applications /// /// Enumeration for alarm week flag, the days of the week. /// + /// 3 [Flags] public enum AlarmWeekFlag { @@ -90,6 +91,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public static class AlarmManager { @@ -129,6 +131,7 @@ namespace Tizen.Applications /// Thrown in case of a permission denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/alarm.set + /// 3 public static Alarm CreateAlarm(int delay, int period, AppControl appControl) { Alarm alarm = null; @@ -155,6 +158,7 @@ namespace Tizen.Applications /// Thrown in case of a permission denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/alarm.set + /// 3 public static Alarm CreateAlarm(int delay, AppControl appControl) { Alarm alarm = null; @@ -181,6 +185,7 @@ namespace Tizen.Applications /// Thrown in case of a permission denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/alarm.set + /// 3 public static Alarm CreateAlarm(DateTime value, AppControl appControl) { Alarm alarm = null; @@ -211,6 +216,7 @@ namespace Tizen.Applications /// Thrown in case of a permission denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/alarm.set + /// 3 public static Alarm CreateAlarm(DateTime value, AlarmWeekFlag weekFlag, AppControl appControl) { Alarm alarm = null; @@ -238,6 +244,7 @@ namespace Tizen.Applications /// Thrown in case of any internal error. /// http://tizen.org/privilege/alarm.set /// http://tizen.org/privilege/notification + /// 3 public static Alarm CreateAlarm(DateTime dateTime, Notification notification) { Alarm alarm = null; @@ -268,6 +275,7 @@ namespace Tizen.Applications /// Thrown in case of any internal error. /// http://tizen.org/privilege/alarm.set /// http://tizen.org/privilege/notification + /// 3 public static Alarm CreateAlarm(int delay, int period, Notification notification) { Alarm alarm = null; @@ -300,6 +308,7 @@ namespace Tizen.Applications /// Thrown in case of any internal error. /// http://tizen.org/privilege/alarm.set /// http://tizen.org/privilege/notification + /// 3 public static Alarm CreateAlarm(DateTime dateTime, AlarmWeekFlag weekFlag, Notification notification) { Alarm alarm = null; @@ -329,6 +338,7 @@ namespace Tizen.Applications /// Thrown in case of any internal error. /// http://tizen.org/privilege/alarm.set /// http://tizen.org/privilege/notification + /// 3 public static Alarm CreateAlarm(int delay, Notification notification) { Alarm alarm = null; @@ -351,6 +361,7 @@ namespace Tizen.Applications /// Thrown in case of a permission denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/alarm.set + /// 3 public static void CancelAll() { AlarmError ret = (AlarmError)Interop.Alarm.CancelAllAlarms(); @@ -367,6 +378,7 @@ namespace Tizen.Applications /// Thrown in case of a permission denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/alarm.get + /// 4 public static IEnumerable GetAllScheduledAlarms() { List alarms = new List(); @@ -390,6 +402,7 @@ namespace Tizen.Applications /// /// The current system time. /// Thrown in case of any internal error. + /// 3 public static DateTime GetCurrentTime() { DateTime time; diff --git a/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/AttachPanel.cs b/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/AttachPanel.cs index 33c777b..c718489 100755 --- a/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/AttachPanel.cs +++ b/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/AttachPanel.cs @@ -11,7 +11,7 @@ namespace Tizen.Applications.AttachPanel /// /// Represents immutable class for attach panel. /// - /// 3 + /// 4 /// The caller's conformant /// Thrown when an attempt to allocate memory fails. /// Thrown when the AttachPanel is already exist or the is not a conformant object @@ -44,7 +44,7 @@ namespace Tizen.Applications.AttachPanel /// /// Represents immutable class for attach panel. /// - /// 3 + /// 4 /// The caller's conformant /// Thrown when an attempt to allocate memory fails. /// Thrown when the AttachPanel is already exist or the is not a conformant object @@ -92,6 +92,7 @@ namespace Tizen.Applications.AttachPanel /// Gets the state of the AttachPanel. /// /// The AttachPanel window state + /// 4 public StateType State { get @@ -108,6 +109,7 @@ namespace Tizen.Applications.AttachPanel /// Gets the value that indicates whether the AttachPanel is visible. /// /// visible value of AttachPanel state + /// 4 public bool Visible { get @@ -150,6 +152,7 @@ namespace Tizen.Applications.AttachPanel /// Thrown when application does not have privilege to access this method /// Thrown when the device does not supported the feature /// Thrown when the AttachPanel is not created yet or already destroyed + /// 4 public void AddCategory(ContentCategory category, Bundle extraData) { IntPtr bundle = IntPtr.Zero; @@ -168,6 +171,7 @@ namespace Tizen.Applications.AttachPanel /// The ContentCategory adding in the AttachPanel /// Thrown when the is not a valid category /// Thrown when the AttachPanel is not created yet or already destroyed + /// 4 public void RemoveCategory(ContentCategory category) { Interop.AttachPanel.ErrorCode err = Interop.AttachPanel.RemoveCategory(_attachPanel, (int)category); @@ -182,6 +186,7 @@ namespace Tizen.Applications.AttachPanel /// Thrown when the is not a valid category /// Thrown when the AttachPanel is destroyed /// Thrown when an attempt to allocate memory fails. + /// 4 public void SetExtraData(ContentCategory category, Bundle extraData) { if (extraData == null) @@ -203,6 +208,7 @@ namespace Tizen.Applications.AttachPanel /// Shows the attach panel with animations /// /// Thrown when the AttachPanel is destroyed + /// 4 public void Show() { Interop.AttachPanel.ErrorCode err = Interop.AttachPanel.Show(_attachPanel); @@ -214,6 +220,7 @@ namespace Tizen.Applications.AttachPanel /// /// A flag which turn on or turn off the animation while attach panel showing. /// Thrown when the AttachPanel is destroyed + /// 4 public void Show(bool animation) { if (animation) @@ -232,6 +239,7 @@ namespace Tizen.Applications.AttachPanel /// Hides the attach panel with animations /// /// Thrown when the AttachPanel is destroyed + /// 4 public void Hide() { Interop.AttachPanel.ErrorCode err = Interop.AttachPanel.Hide(_attachPanel); @@ -243,6 +251,7 @@ namespace Tizen.Applications.AttachPanel /// /// A flag which turn on or turn off the animation while attach panel hiding. /// Thrown when the AttachPanel is destroyed + /// 4 public void Hide(bool animation) { if (animation) @@ -260,6 +269,7 @@ namespace Tizen.Applications.AttachPanel /// /// Occurs when reserved events are published from the panel-side. /// + /// 4 public event EventHandler EventChanged { add @@ -285,6 +295,7 @@ namespace Tizen.Applications.AttachPanel /// /// Occurs when an user selects and confirms something to attach in the AttachPanel /// + /// 4 public event EventHandler ResultCallback { add diff --git a/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/AttachPanelInternal.cs b/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/AttachPanelInternal.cs index 7eaa1be..487dd74 100755 --- a/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/AttachPanelInternal.cs +++ b/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/AttachPanelInternal.cs @@ -6,6 +6,7 @@ namespace Tizen.Applications.AttachPanel /// /// Attach panel internal implementation /// + /// 4 public partial class AttachPanel { private static IntPtr _attachPanel; diff --git a/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/ContentCategory.cs b/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/ContentCategory.cs index e86b9ea..35220e3 100755 --- a/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/ContentCategory.cs +++ b/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/ContentCategory.cs @@ -3,6 +3,7 @@ namespace Tizen.Applications.AttachPanel /// /// Enumeration for the attach panel content category. /// + /// 4 public enum ContentCategory { /// diff --git a/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/EventType.cs b/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/EventType.cs index dc460a1..34135b8 100755 --- a/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/EventType.cs +++ b/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/EventType.cs @@ -3,6 +3,7 @@ namespace Tizen.Applications.AttachPanel /// /// Enumeration for the attach panel event. /// + /// 4 public enum EventType { /// diff --git a/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/ResultEventArgs.cs b/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/ResultEventArgs.cs index 9c933d7..0aea26b 100755 --- a/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/ResultEventArgs.cs +++ b/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/ResultEventArgs.cs @@ -5,6 +5,7 @@ namespace Tizen.Applications.AttachPanel /// /// Class for event arguments of the result event /// + /// 4 public class ResultEventArgs : EventArgs { private readonly ContentCategory _category; @@ -21,6 +22,7 @@ namespace Tizen.Applications.AttachPanel /// /// Results are from the content category. /// + /// 4 public ContentCategory Category { get @@ -33,6 +35,7 @@ namespace Tizen.Applications.AttachPanel /// Property for result /// The caller app has to use ExtraData property to get received data. /// + /// 4 public AppControl Result { get @@ -44,6 +47,7 @@ namespace Tizen.Applications.AttachPanel /// /// Property for result of AppControl /// + /// 4 public AppControlReplyResult ResultCode { get diff --git a/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/StateEventArgs.cs b/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/StateEventArgs.cs index 4373e27..a342b5b 100755 --- a/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/StateEventArgs.cs +++ b/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/StateEventArgs.cs @@ -5,6 +5,7 @@ namespace Tizen.Applications.AttachPanel /// /// Class for event arguments of the state event /// + /// 4 public class StateEventArgs : EventArgs { private readonly EventType _eventType; @@ -17,6 +18,7 @@ namespace Tizen.Applications.AttachPanel /// /// Property for event type. /// + /// 4 public EventType EventType { get diff --git a/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/StateType.cs b/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/StateType.cs index a2474db..a1d54df 100755 --- a/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/StateType.cs +++ b/src/Tizen.Applications.AttachPanel/Tizen.Applications.AttachPanel/StateType.cs @@ -3,6 +3,7 @@ namespace Tizen.Applications.AttachPanel /// /// Enumeration for the attach panel's window state. /// + /// 4 public enum StateType { /// diff --git a/src/Tizen.Applications.Badge/Tizen.Applications/Badge.cs b/src/Tizen.Applications.Badge/Tizen.Applications/Badge.cs index 7175867..c7a4f1a 100644 --- a/src/Tizen.Applications.Badge/Tizen.Applications/Badge.cs +++ b/src/Tizen.Applications.Badge/Tizen.Applications/Badge.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// The class containing common properties of the Badge. /// + /// 3 public class Badge { private int count = 0; @@ -75,7 +76,7 @@ namespace Tizen.Applications /// /// Property for display visibility. True if the badge display visible, otherwise false.. /// - /// 3 + /// 4 public bool Visible{ get; set; } private bool IsNegativeNumber(int number) diff --git a/src/Tizen.Applications.Badge/Tizen.Applications/BadgeControl.cs b/src/Tizen.Applications.Badge/Tizen.Applications/BadgeControl.cs index 3c5b60e..8a4bc87 100755 --- a/src/Tizen.Applications.Badge/Tizen.Applications/BadgeControl.cs +++ b/src/Tizen.Applications.Badge/Tizen.Applications/BadgeControl.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// The class for badge operation. /// + /// 3 public static class BadgeControl { private static event EventHandler s_changed; @@ -130,7 +131,7 @@ namespace Tizen.Applications /// /// Removes the badge information. /// - /// 3 + /// 4 /// The Badge object. /// http://tizen.org/feature/badge /// http://tizen.org/privilege/notification @@ -151,7 +152,7 @@ namespace Tizen.Applications /// /// Adds the badge information. /// - /// 3 + /// 4 /// The Badge object. /// http://tizen.org/feature/badge /// http://tizen.org/privilege/notification @@ -186,7 +187,7 @@ namespace Tizen.Applications /// /// Updates the badge information. /// - /// 3 + /// 4 /// The Badge object. /// http://tizen.org/feature/badge /// http://tizen.org/privilege/notification diff --git a/src/Tizen.Applications.Badge/Tizen.Applications/BadgeEventArgs.cs b/src/Tizen.Applications.Badge/Tizen.Applications/BadgeEventArgs.cs index b93cf66..c0b8d0f 100755 --- a/src/Tizen.Applications.Badge/Tizen.Applications/BadgeEventArgs.cs +++ b/src/Tizen.Applications.Badge/Tizen.Applications/BadgeEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// The class for event arguments of the badge event. /// + /// 3 public class BadgeEventArgs : EventArgs { internal BadgeEventArgs() diff --git a/src/Tizen.Applications.Common/Tizen.Applications.CoreBackend/DefaultCoreBackend.cs b/src/Tizen.Applications.Common/Tizen.Applications.CoreBackend/DefaultCoreBackend.cs index 5799ebc..cf30096 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications.CoreBackend/DefaultCoreBackend.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications.CoreBackend/DefaultCoreBackend.cs @@ -24,11 +24,13 @@ namespace Tizen.Applications.CoreBackend /// /// An abstract class to provide default event handlers for apps. /// + /// 3 public abstract class DefaultCoreBackend : ICoreBackend { /// /// Low level event types. /// + /// 3 public enum AppEventType { /// @@ -66,17 +68,20 @@ namespace Tizen.Applications.CoreBackend /// Tag string for this class. /// [EditorBrowsable(EditorBrowsableState.Never)] + /// 3 protected static readonly string LogTag = typeof(DefaultCoreBackend).Namespace; /// /// Data structure for event handlers. /// [EditorBrowsable(EditorBrowsableState.Never)] + /// 3 protected IDictionary Handlers = new Dictionary(); /// /// Constructor of DefaultCoreBackend class. /// + /// 3 public DefaultCoreBackend() { } @@ -94,6 +99,7 @@ namespace Tizen.Applications.CoreBackend /// /// The type of event. /// The handler method without arguments. + /// 3 public virtual void AddEventHandler(EventType evType, Action handler) { Handlers.Add(evType, handler); @@ -105,6 +111,7 @@ namespace Tizen.Applications.CoreBackend /// The EventArgs type used in arguments of the handler method. /// The type of event. /// The handler method with a TEventArgs type argument. + /// 3 public virtual void AddEventHandler(EventType evType, Action handler) where TEventArgs : EventArgs { Handlers.Add(evType, handler); @@ -114,6 +121,7 @@ namespace Tizen.Applications.CoreBackend /// Runs the mainloop of the backend. /// /// + /// 3 public virtual void Run(string[] args) { TizenSynchronizationContext.Initialize(); @@ -122,11 +130,13 @@ namespace Tizen.Applications.CoreBackend /// /// Exits the mainloop of the backend. /// + /// 3 public abstract void Exit(); /// /// Releases all resources. /// + /// 3 public void Dispose() { Dispose(true); @@ -137,6 +147,7 @@ namespace Tizen.Applications.CoreBackend /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// /// If true, disposes any disposable objects. If false, does not dispose disposable objects. + /// 3 protected abstract void Dispose(bool disposing); /// @@ -144,6 +155,7 @@ namespace Tizen.Applications.CoreBackend /// /// /// + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] protected virtual void OnLowMemoryNative(IntPtr infoHandle, IntPtr data) { @@ -165,6 +177,7 @@ namespace Tizen.Applications.CoreBackend /// /// /// + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] protected virtual void OnLowBatteryNative(IntPtr infoHandle, IntPtr data) { @@ -186,6 +199,7 @@ namespace Tizen.Applications.CoreBackend /// /// /// + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] protected virtual void OnLocaleChangedNative(IntPtr infoHandle, IntPtr data) { @@ -207,6 +221,7 @@ namespace Tizen.Applications.CoreBackend /// /// /// + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] protected virtual void OnRegionChangedNative(IntPtr infoHandle, IntPtr data) { @@ -228,6 +243,7 @@ namespace Tizen.Applications.CoreBackend /// /// /// + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] protected virtual void OnDeviceOrientationChangedNative(IntPtr infoHandle, IntPtr data) { diff --git a/src/Tizen.Applications.Common/Tizen.Applications.CoreBackend/EventType.cs b/src/Tizen.Applications.Common/Tizen.Applications.CoreBackend/EventType.cs index 2eadeb6..278a639 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications.CoreBackend/EventType.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications.CoreBackend/EventType.cs @@ -18,61 +18,73 @@ namespace Tizen.Applications.CoreBackend /// /// This class represents the type of event for backends. This class can be converted from the string type. /// + /// 3 public class EventType { /// /// Pre-defined event type "PreCreated". /// + /// 3 public static readonly EventType PreCreated = "PreCreated"; /// /// Pre-defined event type "Created". /// + /// 3 public static readonly EventType Created = "Created"; /// /// Pre-defined event type "Terminated". /// + /// 3 public static readonly EventType Terminated = "Terminated"; /// /// Pre-defined event type "AppControlReceived". /// + /// 3 public static readonly EventType AppControlReceived = "AppControlReceived"; /// /// Pre-defined event type "Resumed". /// + /// 3 public static readonly EventType Resumed = "Resumed"; /// /// Pre-defined event type "Paused". /// + /// 3 public static readonly EventType Paused = "Paused"; /// /// Pre-defined event type "LowMemory". /// + /// 3 public static readonly EventType LowMemory = "LowMemory"; /// /// Pre-defined event type "LowBattery". /// + /// 3 public static readonly EventType LowBattery = "LowBattery"; /// /// Pre-defined event type "LocaleChanged". /// + /// 3 public static readonly EventType LocaleChanged = "LocaleChanged"; /// /// Pre-defined event type "RegionFormatChanged". /// + /// 3 public static readonly EventType RegionFormatChanged = "RegionFormatChanged"; /// /// Pre-defined event type "DeviceOrientationChanged". /// + /// 3 public static readonly EventType DeviceOrientationChanged = "DeviceOrientationChanged"; private string _typeName; @@ -81,6 +93,7 @@ namespace Tizen.Applications.CoreBackend /// Initializes the EventType class. /// /// The name of event type. + /// 3 public EventType(string name) { _typeName = name; @@ -89,6 +102,7 @@ namespace Tizen.Applications.CoreBackend /// /// Returns the name of event type. /// + /// 3 public override string ToString() { return _typeName; @@ -97,6 +111,7 @@ namespace Tizen.Applications.CoreBackend /// /// Returns the hash code for event type string. /// + /// 3 public override int GetHashCode() { if (_typeName == null) return 0; @@ -106,6 +121,7 @@ namespace Tizen.Applications.CoreBackend /// /// Determines whether this instance and a specified object. /// + /// 3 public override bool Equals(object obj) { EventType other = obj as EventType; @@ -115,6 +131,7 @@ namespace Tizen.Applications.CoreBackend /// /// Converts a string to EventType instance. /// + /// 3 public static implicit operator EventType(string value) { return new EventType(value); diff --git a/src/Tizen.Applications.Common/Tizen.Applications.CoreBackend/ICoreBackend.cs b/src/Tizen.Applications.Common/Tizen.Applications.CoreBackend/ICoreBackend.cs index 3b94150..95c3775 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications.CoreBackend/ICoreBackend.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications.CoreBackend/ICoreBackend.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications.CoreBackend /// /// An interface that represents the backend lifecycles. /// + /// 3 public interface ICoreBackend : IDisposable { /// @@ -28,6 +29,7 @@ namespace Tizen.Applications.CoreBackend /// /// The type of event. /// The handler method without arguments. + /// 3 void AddEventHandler(EventType evType, Action handler); /// @@ -36,17 +38,20 @@ namespace Tizen.Applications.CoreBackend /// The EventArgs type used in arguments of the handler method. /// The type of event. /// The handler method with a TEventArgs type argument. + /// 3 void AddEventHandler(EventType evType, Action handler) where TEventArgs : EventArgs; /// /// Runs the mainloop of the backend. /// /// + /// 3 void Run(string[] args); /// /// Exits the mainloop of the backend. /// + /// 3 void Exit(); } } diff --git a/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/AppNotFoundException.cs b/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/AppNotFoundException.cs index 6c9454d..1bda744 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/AppNotFoundException.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/AppNotFoundException.cs @@ -5,12 +5,14 @@ namespace Tizen.Applications.Exceptions /// /// The class that represents the exception which will be thrown when the application to run is not found /// + /// 4 public class AppNotFoundException : InvalidOperationException { /// /// Constructor /// /// The localized error message string + /// 4 public AppNotFoundException(string message) : base(message) { } diff --git a/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/LaunchFailedException.cs b/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/LaunchFailedException.cs index 99085f7..4cc61f5 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/LaunchFailedException.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/LaunchFailedException.cs @@ -5,12 +5,14 @@ namespace Tizen.Applications.Exceptions /// /// The class that represents the exception which will be thrown when the request failed to launch the application /// + /// 4 public class LaunchFailedException : InvalidOperationException { /// /// Constructor /// /// The localized error message string + /// 4 public LaunchFailedException(string message) : base(message) { } diff --git a/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/LaunchRejectedException.cs b/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/LaunchRejectedException.cs index e89de76..bb6b855 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/LaunchRejectedException.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/LaunchRejectedException.cs @@ -5,12 +5,14 @@ namespace Tizen.Applications.Exceptions /// /// The class that represents the exception which will be thrown when the launch request is rejected /// + /// 4 public class LaunchRejectedException : InvalidOperationException { /// /// Constructor /// /// The localized error message string + /// 4 public LaunchRejectedException(string message) : base(message) { } diff --git a/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/OutOfMemoryException.cs b/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/OutOfMemoryException.cs index f6c5967..b67b92e 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/OutOfMemoryException.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/OutOfMemoryException.cs @@ -7,12 +7,14 @@ namespace Tizen.Applications.Exceptions /// /// The class that represents the exception which will be thrown when the memory is insufficient /// + /// 4 public class OutOfMemoryException : InvalidOperationException { /// /// Constructor /// /// The localized error message string + /// 4 public OutOfMemoryException(string message) : base(message) { } diff --git a/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/PermissionDeniedException.cs b/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/PermissionDeniedException.cs index 015ae13..69b60f8 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/PermissionDeniedException.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications.Exceptions/PermissionDeniedException.cs @@ -5,12 +5,14 @@ namespace Tizen.Applications.Exceptions /// /// The class that represents the exception which will be thrown when the permission is denied /// + /// 4 public class PermissionDeniedException : InvalidOperationException { /// /// Constructor /// /// The localized error message string + /// 4 public PermissionDeniedException(string message) : base(message) { } diff --git a/src/Tizen.Applications.Common/Tizen.Applications/AppControl.cs b/src/Tizen.Applications.Common/Tizen.Applications/AppControl.cs index 20d8c81..836928f 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/AppControl.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/AppControl.cs @@ -40,6 +40,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public class AppControl { private const string LogTag = "Tizen.Applications"; @@ -60,6 +61,7 @@ namespace Tizen.Applications /// Initializes the instance of the AppControl class. /// /// Thrown when failed to create the AppControl handle. + /// 3 public AppControl() { Interop.AppControl.ErrorCode err = Interop.AppControl.Create(out _handle); @@ -74,6 +76,7 @@ namespace Tizen.Applications /// /// The flag value to receive an additional launch result event on the launch request. /// Thrown when failed to create the AppControl handle. + /// 3 public AppControl(bool enableAppStartedResultEvent) { Interop.AppControl.ErrorCode err = Interop.AppControl.Create(out _handle); @@ -96,6 +99,7 @@ namespace Tizen.Applications /// Initializes the instance of the AppControl class with the SafeAppControlHandle. /// /// + /// 3 public AppControl(SafeAppControlHandle handle) { if (handle == null) @@ -124,6 +128,7 @@ namespace Tizen.Applications /// /// Gets the SafeAppControlHandle instance. /// + /// 3 public SafeAppControlHandle SafeAppControlHandle { get @@ -148,6 +153,7 @@ namespace Tizen.Applications /// Log.Debug(LogTag, "Operation: " + appControl.Operation); /// /// + /// 3 public string Operation { get @@ -189,6 +195,7 @@ namespace Tizen.Applications /// Log.Debug(LogTag, "Mime: " + appControl.Mime); /// /// + /// 3 public string Mime { get @@ -245,6 +252,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public string Uri { get @@ -279,6 +287,7 @@ namespace Tizen.Applications /// /// (if the category is null for setter, it clears the previous value.) /// + /// 3 public string Category { get @@ -320,6 +329,7 @@ namespace Tizen.Applications /// Log.Debug(LogTag, "ApplicationId: " + appControl.ApplicationId); /// /// + /// 3 public string ApplicationId { get @@ -366,6 +376,7 @@ namespace Tizen.Applications /// appControl.LaunchMode = AppControlLaunchMode.Group; /// /// + /// 3 public AppControlLaunchMode LaunchMode { get @@ -401,6 +412,7 @@ namespace Tizen.Applications /// ... /// /// + /// 3 public ExtraDataCollection ExtraData { get @@ -431,6 +443,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public static IEnumerable GetMatchedApplicationIds(AppControl control) { if (control == null) @@ -482,6 +495,7 @@ namespace Tizen.Applications /// AppControl.SendLaunchRequest(appControl); /// /// + /// 3 public static void SendLaunchRequest(AppControl launchRequest) { SendLaunchRequest(launchRequest, null); @@ -517,6 +531,7 @@ namespace Tizen.Applications /// }); /// /// + /// 3 public static void SendLaunchRequest(AppControl launchRequest, AppControlReplyCallback replyAfterLaunching) { if (launchRequest == null) @@ -600,6 +615,7 @@ namespace Tizen.Applications /// AppControl.SendTerminateRequest(terminateRequest); /// /// + /// 3 public static void SendTerminateRequest(AppControl terminateRequest) { if (terminateRequest == null) @@ -627,6 +643,7 @@ namespace Tizen.Applications /// /// Class for extra data. /// + /// 3 public class ExtraDataCollection { private readonly SafeAppControlHandle _handle; @@ -652,6 +669,7 @@ namespace Tizen.Applications /// appControl.ExtraData.Add("myKey", "myValue"); /// /// + /// 3 public void Add(string key, string value) { if (string.IsNullOrEmpty(key)) @@ -694,6 +712,7 @@ namespace Tizen.Applications /// appControl.ExtraData.Add("myKey", myValues); /// /// + /// 3 public void Add(string key, IEnumerable value) { if (string.IsNullOrEmpty(key)) @@ -735,6 +754,7 @@ namespace Tizen.Applications /// string myValue = appControl.ExtraData.Get<string>("myKey"); /// /// + /// 3 public T Get(string key) { object ret = Get(key); @@ -759,6 +779,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public object Get(string key) { if (IsCollection(key)) @@ -789,6 +810,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public IEnumerable GetKeys() { List keys = new List(); @@ -832,6 +854,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public bool TryGet(string key, out string value) { if (string.IsNullOrEmpty(key)) @@ -873,6 +896,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public bool TryGet(string key, out IEnumerable value) { if (string.IsNullOrEmpty(key)) @@ -915,6 +939,7 @@ namespace Tizen.Applications /// appControl.ExtraData.Remove("myKey"); /// /// + /// 3 public void Remove(string key) { if (string.IsNullOrEmpty(key)) @@ -949,6 +974,7 @@ namespace Tizen.Applications /// int numberOfKeys = appControl.ExtraData.Count(); /// /// + /// 3 public int Count() { return GetKeys().Count(); @@ -967,6 +993,7 @@ namespace Tizen.Applications /// bool result = appControl.ExtraData.IsCollection("myKey"); /// /// + /// 3 public bool IsCollection(string key) { if (string.IsNullOrEmpty(key)) diff --git a/src/Tizen.Applications.Common/Tizen.Applications/AppControlData.cs b/src/Tizen.Applications.Common/Tizen.Applications/AppControlData.cs index b3cb0a8..bb5dcc4 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/AppControlData.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/AppControlData.cs @@ -19,131 +19,157 @@ namespace Tizen.Applications /// /// Data of the AppControl. /// + /// 3 public static class AppControlData { /// /// Subject. /// + /// 3 public const string Subject = "http://tizen.org/appcontrol/data/subject"; /// /// Recipients. /// + /// 3 public const string To = "http://tizen.org/appcontrol/data/to"; /// /// E-mail addresses that should be carbon copied. /// + /// 3 public const string Cc = "http://tizen.org/appcontrol/data/cc"; /// /// E-mail addresses that should be blind carbon copied. /// + /// 3 public const string Bcc = "http://tizen.org/appcontrol/data/bcc"; /// /// Text. /// + /// 3 public const string Text = "http://tizen.org/appcontrol/data/text"; /// /// Title. /// + /// 3 public const string Title = "http://tizen.org/appcontrol/data/title"; /// /// Selected items. /// + /// 3 public const string Selected = "http://tizen.org/appcontrol/data/selected"; /// /// Paths of items. /// + /// 3 public const string Path = "http://tizen.org/appcontrol/data/path"; /// /// Selection mode ("single" or "multiple"). /// + /// 3 public const string SectionMode = "http://tizen.org/appcontrol/data/selection_mode"; /// /// All-day mode of the event ("true" or "false"). /// + /// 3 public const string AllDay = "http://tizen.org/appcontrol/data/calendar/all_day"; /// /// Start time of the event (format: YYYY-MM-DD HH:MM:SS). /// + /// 3 public const string StartTime = "http://tizen.org/appcontrol/data/calendar/start_time"; /// /// End time of the event (format: YYYY-MM-DD HH:MM:SS). /// + /// 3 public const string Endtime = "http://tizen.org/appcontrol/data/calendar/end_time"; /// /// E-mail addressed. /// + /// 3 public const string Email = "http://tizen.org/appcontrol/data/email"; /// /// Phone numbers. /// + /// 3 public const string Phone = "http://tizen.org/appcontrol/data/phone"; /// /// URLs. /// + /// 3 public const string Url = "http://tizen.org/appcontrol/data/url"; /// /// IDs. /// + /// 3 public const string Ids = "http://tizen.org/appcontrol/data/id"; /// /// Type. /// + /// 3 public const string Type = "http://tizen.org/appcontrol/data/type"; /// /// Total count. /// + /// 3 public const string TotalCount = "http://tizen.org/appcontrol/data/total_count"; /// /// Total size (unit : bytes). /// + /// 3 public const string TotalSize = "http://tizen.org/appcontrol/data/total_size"; /// /// Name. /// + /// 3 public const string Name = "http://tizen.org/appcontrol/data/name"; /// /// Location. /// + /// 3 public const string Location = "http://tizen.org/appcontrol/data/location"; /// /// Select the type of input method. /// + /// 3 public const string InputType = "http://tizen.org/appcontrol/data/input_type"; /// /// Send the pre inputted text, such as "http://" in web. /// + /// 3 public const string InputDefaultText = "http://tizen.org/appcontrol/data/input_default_text"; /// /// Send guide text to show to the user, such as "Input user name". /// + /// 3 public const string InputGuideText = "http://tizen.org/appcontrol/data/input_guide_text"; /// /// Send text to receive answer result from smart reply. /// + /// 3 public const string InputPredictionHint = "http://tizen.org/appcontrol/data/input_prediction_hint"; } } diff --git a/src/Tizen.Applications.Common/Tizen.Applications/AppControlLaunchMode.cs b/src/Tizen.Applications.Common/Tizen.Applications/AppControlLaunchMode.cs index 1a0c5d1..f9165c3 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/AppControlLaunchMode.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/AppControlLaunchMode.cs @@ -19,6 +19,7 @@ namespace Tizen.Applications /// /// Enumeration for the application control launch mode. /// + /// 3 public enum AppControlLaunchMode { /// diff --git a/src/Tizen.Applications.Common/Tizen.Applications/AppControlOperations.cs b/src/Tizen.Applications.Common/Tizen.Applications/AppControlOperations.cs index a3e4623..1c99259 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/AppControlOperations.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/AppControlOperations.cs @@ -19,141 +19,169 @@ namespace Tizen.Applications /// /// Operations of the AppControl. /// + /// 3 public static class AppControlOperations { /// /// An explicit launch for a homescreen application. /// + /// 3 public const string Main = "http://tizen.org/appcontrol/operation/main"; /// /// An explicit launch for an application that excludes a homescreen application. /// + /// 3 public const string Default = "http://tizen.org/appcontrol/operation/default"; /// /// Provides an editable access to the given data. /// + /// 3 public const string Edit = "http://tizen.org/appcontrol/operation/edit"; /// /// Displays the data. /// + /// 3 public const string View = "http://tizen.org/appcontrol/operation/view"; /// /// Picks items. /// + /// 3 public const string Pick = "http://tizen.org/appcontrol/operation/pick"; /// /// Creates contents. /// + /// 3 public const string CreateContent = "http://tizen.org/appcontrol/operation/create_content"; /// /// Performs a call to someone. /// + /// 3 public const string Call = "http://tizen.org/appcontrol/operation/call"; /// /// Delivers some data to someone else. /// + /// 3 public const string Send = "http://tizen.org/appcontrol/operation/send"; /// /// Delivers text data to someone else. /// + /// 3 public const string SendText = "http://tizen.org/appcontrol/operation/send_text"; /// /// Shares an item with someone else. /// + /// 3 public const string Share = "http://tizen.org/appcontrol/operation/share"; /// /// Shares multiple items with someone else. /// + /// 3 public const string MultiShare = "http://tizen.org/appcontrol/operation/multi_share"; /// /// Shares text data with someone else. /// + /// 3 public const string ShareText = "http://tizen.org/appcontrol/operation/share_text"; /// /// Dials a number. This shows an UI with the number to be dialed, allowing the user to explicitly initiate the call. /// + /// 3 public const string Dial = "http://tizen.org/appcontrol/operation/dial"; /// /// Performs a search. /// + /// 3 public const string Search = "http://tizen.org/appcontrol/operation/search"; /// /// Downloads items. /// + /// 3 public const string Download = "http://tizen.org/appcontrol/operation/download"; /// /// Prints contents. /// + /// 3 public const string Print = "http://tizen.org/appcontrol/operation/print"; /// /// Composes a message. /// + /// 3 public const string Compose = "http://tizen.org/appcontrol/operation/compose"; /// /// Can be launched by interested System-Event. /// + /// 3 public const string LaunchOnEvent = "http://tizen.org/appcontrol/operation/launch_on_event"; /// /// Adds an item. /// + /// 3 public const string Add = "http://tizen.org/appcontrol/operation/add"; /// /// Captures images by camera applications. /// + /// 3 public const string ImageCapture = "http://tizen.org/appcontrol/operation/image_capture"; /// /// Captures videos by camera applications. /// + /// 3 public const string VideoCapture = "http://tizen.org/appcontrol/operation/video_capture"; /// /// Shows system settings. /// + /// 3 public const string Setting = "http://tizen.org/appcontrol/operation/setting"; /// /// Shows settings to enable Bluetooth. /// + /// 3 public const string SettingBluetoothEnable = "http://tizen.org/appcontrol/operation/setting/bt_enable"; /// /// Shows settings to configure the Bluetooth visibility. /// + /// 3 public const string SettingBluetoothVisibility = "http://tizen.org/appcontrol/operation/setting/bt_visibility"; /// /// Shows settings to allow configuration of current location sources. /// + /// 3 public const string SettingLocation = "http://tizen.org/appcontrol/operation/setting/location"; /// /// Shows NFC settings. /// + /// 3 public const string SettingNfc = "http://tizen.org/appcontrol/operation/setting/nfc"; /// /// Shows settings to allow configuration of Wi-Fi. /// + /// 3 public const string SettingWifi = "http://tizen.org/appcontrol/operation/setting/wifi"; } } diff --git a/src/Tizen.Applications.Common/Tizen.Applications/AppControlReceivedEventArgs.cs b/src/Tizen.Applications.Common/Tizen.Applications/AppControlReceivedEventArgs.cs index 8901468..631b7b8 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/AppControlReceivedEventArgs.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/AppControlReceivedEventArgs.cs @@ -21,12 +21,14 @@ namespace Tizen.Applications /// /// Arguments for the event that raised when the application receives the AppControl. /// + /// 3 public class AppControlReceivedEventArgs : EventArgs { /// /// Initializes the AppControlReceivedEventArgs class. /// /// + /// 3 public AppControlReceivedEventArgs(ReceivedAppControl appControl) { ReceivedAppControl = appControl; @@ -35,6 +37,7 @@ namespace Tizen.Applications /// /// The received AppControl. /// + /// 3 public ReceivedAppControl ReceivedAppControl { get; private set; } } } diff --git a/src/Tizen.Applications.Common/Tizen.Applications/AppControlReplyCallback.cs b/src/Tizen.Applications.Common/Tizen.Applications/AppControlReplyCallback.cs index 1a9c6c9..0b3890c 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/AppControlReplyCallback.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/AppControlReplyCallback.cs @@ -22,5 +22,6 @@ namespace Tizen.Applications /// The AppControl of the launch request that has been sent /// The AppControl in which the results of the callee are contained /// The result of the launch request + /// 3 public delegate void AppControlReplyCallback(AppControl launchRequest, AppControl replyRequest, AppControlReplyResult result); } diff --git a/src/Tizen.Applications.Common/Tizen.Applications/AppControlReplyResult.cs b/src/Tizen.Applications.Common/Tizen.Applications/AppControlReplyResult.cs index 86a33d3..519ddd2 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/AppControlReplyResult.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/AppControlReplyResult.cs @@ -19,6 +19,7 @@ namespace Tizen.Applications /// /// Enumeration for the application control result. /// + /// 3 public enum AppControlReplyResult { /// diff --git a/src/Tizen.Applications.Common/Tizen.Applications/Application.cs b/src/Tizen.Applications.Common/Tizen.Applications/Application.cs index 5d3077f..ab71a73 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/Application.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/Application.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// The class that represents a Tizen application. /// + /// 3 public abstract class Application : IDisposable { internal const string LogTag = "Tizen.Applications"; @@ -35,11 +36,13 @@ namespace Tizen.Applications /// /// Gets the instance of the current application. /// + /// 3 public static Application Current { get { return s_CurrentApplication; } } /// /// Gets the class representing directory information of the current application. /// + /// 3 public DirectoryInfo DirectoryInfo { get @@ -58,6 +61,7 @@ namespace Tizen.Applications /// /// Gets the class representing information of the current application. /// + /// 3 public ApplicationInfo ApplicationInfo { get @@ -82,6 +86,7 @@ namespace Tizen.Applications /// Runs the application's main loop. /// /// Arguments from commandline. + /// 3 public virtual void Run(string[] args) { if (args == null) @@ -94,6 +99,7 @@ namespace Tizen.Applications /// /// Exits the main loop of the application. /// + /// 3 public abstract void Exit(); #region IDisposable Support @@ -103,6 +109,7 @@ namespace Tizen.Applications /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// /// If true, disposes any disposable objects. If false, does not dispose disposable objects. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposedValue) @@ -130,6 +137,7 @@ namespace Tizen.Applications /// /// Releases all resources used by the application class. /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationDisabledEventArgs.cs b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationDisabledEventArgs.cs index 5197935..34f67c7 100644 --- a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationDisabledEventArgs.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationDisabledEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// Arguments for the event raised when the application is disabled. /// + /// 3 public class ApplicationDisabledEventArgs : EventArgs { private readonly ApplicationEventState _eventState; @@ -35,11 +36,13 @@ namespace Tizen.Applications /// /// The ID of the application. /// + /// 3 public string ApplicationId { get { return _applicationId; } } /// /// The event state of the application. /// + /// 3 public ApplicationEventState EventState { get { return _eventState; } } } } diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationEnabledEventArgs.cs b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationEnabledEventArgs.cs index 297ba83..42ee117 100644 --- a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationEnabledEventArgs.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationEnabledEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// Arguments for the event raised when the application is enabled. /// + /// 3 public class ApplicationEnabledEventArgs : EventArgs { private readonly ApplicationEventState _eventState; @@ -35,11 +36,13 @@ namespace Tizen.Applications /// /// The ID of the application. /// + /// 3 public string ApplicationId { get { return _applicationId; } } /// /// The event state of the application. /// + /// 3 public ApplicationEventState EventState { get { return _eventState; } } } } diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationEventState.cs b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationEventState.cs index fff69ea..60b599d 100644 --- a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationEventState.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationEventState.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// Enumeration for the application event state. /// + /// 3 public enum ApplicationEventState { /// diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationInfo.cs b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationInfo.cs index a0e7227..2065f03 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationInfo.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationInfo.cs @@ -22,6 +22,7 @@ namespace Tizen.Applications /// /// This class provides methods and properties to get information of the application. /// + /// 3 public class ApplicationInfo : IDisposable { private const string LogTag = "Tizen.Applications"; @@ -44,6 +45,7 @@ namespace Tizen.Applications /// A constructor of ApplicationInfo that takes the application ID. /// /// Application ID. + /// 3 public ApplicationInfo(string applicationId) { _applicationId = applicationId; @@ -60,6 +62,7 @@ namespace Tizen.Applications /// /// Gets the application ID. /// + /// 3 public string ApplicationId { get @@ -83,6 +86,7 @@ namespace Tizen.Applications /// /// Gets the package ID of the application. /// + /// 3 public string PackageId { get @@ -104,6 +108,7 @@ namespace Tizen.Applications /// /// Gets the label of the application. /// + /// 3 public string Label { get @@ -125,6 +130,7 @@ namespace Tizen.Applications /// /// Gets the executable path of the application. /// + /// 3 public string ExecutablePath { get @@ -146,6 +152,7 @@ namespace Tizen.Applications /// /// Gets the absolute path to the icon image. /// + /// 3 public string IconPath { get @@ -167,6 +174,7 @@ namespace Tizen.Applications /// /// Gets the application type name. /// + /// 3 public string ApplicationType { get @@ -188,6 +196,7 @@ namespace Tizen.Applications /// /// Gets the application's metadata. /// + /// 3 public IDictionary Metadata { get @@ -219,6 +228,7 @@ namespace Tizen.Applications /// /// Checks whether the application information is nodisplay. If the application icon is not displayed on the menu screen, true; otherwise, false. /// + /// 3 public bool IsNoDisplay { get @@ -241,6 +251,7 @@ namespace Tizen.Applications /// /// Checks whether the application is launched on booting time. If the application automatically starts on boot, true; otherwise, false. /// + /// 3 public bool IsOnBoot { get @@ -262,6 +273,7 @@ namespace Tizen.Applications /// /// Checks whether the application is preloaded. If the application is preloaded, true; otherwise, false. /// + /// 3 public bool IsPreload { get @@ -283,6 +295,7 @@ namespace Tizen.Applications /// /// Gets the shared data path. /// + /// 3 public string SharedDataPath { get @@ -300,6 +313,7 @@ namespace Tizen.Applications /// /// Gets the shared resource path. /// + /// 3 public string SharedResourcePath { get @@ -317,6 +331,7 @@ namespace Tizen.Applications /// /// Gets the shared trust path. /// + /// 3 public string SharedTrustedPath { get @@ -334,6 +349,7 @@ namespace Tizen.Applications /// /// Gets the external shared data path. /// + /// 3 public string ExternalSharedDataPath { get @@ -352,6 +368,7 @@ namespace Tizen.Applications /// Gets the localized label of the application for the given locale. /// /// Locale. + /// 3 public string GetLocalizedLabel(string locale) { string label = string.Empty; @@ -382,6 +399,7 @@ namespace Tizen.Applications /// /// Releases all resources used by the ApplicationInfo class. /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoFilter.cs b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoFilter.cs index 313d30b..d1b9e7f 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoFilter.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoFilter.cs @@ -22,11 +22,13 @@ namespace Tizen.Applications /// /// This class is a parameter of the GetInstalledApplicationsAsync method. /// + /// 3 public class ApplicationInfoFilter { /// /// /// + /// 3 public ApplicationInfoFilter() { Filter = new Dictionary(); @@ -35,33 +37,40 @@ namespace Tizen.Applications /// /// This class is a possible key to use in the InstalledApplicationFilter. /// + /// 3 public static class Keys { /// /// /// + /// 3 public const string Id = "PACKAGE_INFO_PROP_APP_ID"; /// /// /// + /// 3 public const string Type = "PACKAGE_INFO_PROP_APP_TYPE"; /// /// /// + /// 3 public const string Category = "PACKAGE_INFO_PROP_APP_CATEGORY"; /// /// /// + /// 3 public const string NoDisplay = "PACKAGE_INFO_PROP_APP_NODISPLAY"; /// /// /// + /// 3 public const string TaskManage = "PACKAGE_INFO_PROP_APP_TASKMANAGE"; } /// /// /// + /// 3 public IDictionary Filter { get; private set; diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoMetadataFilter.cs b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoMetadataFilter.cs index 37abfb7..5856d62 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoMetadataFilter.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationInfoMetadataFilter.cs @@ -22,6 +22,7 @@ namespace Tizen.Applications /// /// This class is a parameter of the GetInstalledApplicationsAsync method. /// + /// 3 public class ApplicationInfoMetadataFilter : ApplicationInfoFilter { } diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationLaunchedEventArgs.cs b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationLaunchedEventArgs.cs index e80ef39..b65c441 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationLaunchedEventArgs.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationLaunchedEventArgs.cs @@ -21,11 +21,13 @@ namespace Tizen.Applications /// /// Arguments for the event raised when the application is launched. /// + /// 3 public class ApplicationLaunchedEventArgs : EventArgs { /// /// The information of the application. /// + /// 3 public ApplicationRunningContext ApplicationRunningContext { get; internal set; } } } \ No newline at end of file diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationManager.cs b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationManager.cs index 83fdd54..fc7c130 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationManager.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationManager.cs @@ -25,6 +25,7 @@ namespace Tizen.Applications /// /// This class has the methods and events of the ApplicationManager. /// + /// 3 public static class ApplicationManager { private const string LogTag = "Tizen.Applications"; @@ -39,6 +40,7 @@ namespace Tizen.Applications /// /// Occurs whenever the installed application is enabled. /// + /// 3 public static event EventHandler ApplicationEnabled { add @@ -62,6 +64,7 @@ namespace Tizen.Applications /// /// Occurs whenever the installed application is disabled. /// + /// 3 public static event EventHandler ApplicationDisabled { add @@ -85,6 +88,7 @@ namespace Tizen.Applications /// /// Occurs whenever the installed applications get launched. /// + /// 3 public static event EventHandler ApplicationLaunched { add @@ -108,6 +112,7 @@ namespace Tizen.Applications /// /// Occurs whenever the installed applications get terminated. /// + /// 3 public static event EventHandler ApplicationTerminated { add @@ -131,6 +136,7 @@ namespace Tizen.Applications /// /// Gets the information of the installed applications asynchronously. /// + /// 3 public static async Task> GetInstalledApplicationsAsync() { return await Task.Run(() => @@ -168,6 +174,7 @@ namespace Tizen.Applications /// Gets the information of the installed applications with the ApplicationInfoFilter asynchronously. /// /// Key-value pairs for filtering. + /// 3 public static async Task> GetInstalledApplicationsAsync(ApplicationInfoFilter filter) { return await Task.Run(() => @@ -200,6 +207,7 @@ namespace Tizen.Applications /// Gets the information of the installed applications with the ApplicationInfoMetadataFilter asynchronously. /// /// Key-value pairs for filtering. + /// 3 public static async Task> GetInstalledApplicationsAsync(ApplicationInfoMetadataFilter filter) { return await Task.Run(() => @@ -231,6 +239,7 @@ namespace Tizen.Applications /// /// Gets the information of the running applications asynchronously. /// + /// 3 public static async Task> GetRunningApplicationsAsync() { return await Task.Run(() => @@ -268,6 +277,7 @@ namespace Tizen.Applications /// /// Gets the information of the running applications including subapp asynchronously. /// + /// 3 public static async Task> GetAllRunningApplicationsAsync() { return await Task.Run(() => @@ -306,6 +316,7 @@ namespace Tizen.Applications /// Gets the information of the specified application with the application ID. /// /// Application ID. + /// 3 public static ApplicationInfo GetInstalledApplication(string applicationId) { IntPtr infoHandle = IntPtr.Zero; @@ -324,6 +335,7 @@ namespace Tizen.Applications /// The application ID. /// Returns true if the given application is running, otherwise false. /// Thrown when the given parameter is invalid. + /// 3 public static bool IsRunning(string applicationId) { bool isRunning = false; @@ -424,6 +436,7 @@ namespace Tizen.Applications /// /// Returns a dictionary containing all the recent application info. /// Thrown when failed because of an invalid operation. + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] public static IEnumerable GetRecentApplications() { diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationRunningContext.cs b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationRunningContext.cs index 627c639..b294259 100644 --- a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationRunningContext.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationRunningContext.cs @@ -23,6 +23,7 @@ namespace Tizen.Applications /// /// This class provides methods and properties to get information of the application. /// + /// 3 public class ApplicationRunningContext : IDisposable { private const string LogTag = "Tizen.Applications"; @@ -42,6 +43,7 @@ namespace Tizen.Applications /// Thrown when failed because of an invalid argument. /// Thrown when failed because of the "application not exist" error or the system error. /// Thrown when failed because of out of memory. + /// 3 public ApplicationRunningContext(string applicationId) { IntPtr contextHandle = IntPtr.Zero; @@ -72,6 +74,7 @@ namespace Tizen.Applications /// Thrown when failed of invalid argument. /// Thrown when failed because of application not exist error or system error. /// Thrown when failed because of out of memory. + /// 4 [EditorBrowsable(EditorBrowsableState.Never)] public ApplicationRunningContext(string applicationId, string instanceId) { @@ -106,6 +109,7 @@ namespace Tizen.Applications /// /// Enumeration for the application state. /// + /// 3 public enum AppState { /// @@ -137,6 +141,7 @@ namespace Tizen.Applications /// /// Gets the application ID. /// + /// 3 public string ApplicationId { get @@ -154,6 +159,7 @@ namespace Tizen.Applications /// /// Gets the package ID of the application. /// + /// 3 public string PackageId { get @@ -171,6 +177,7 @@ namespace Tizen.Applications /// /// Gets the application's process ID. /// + /// 3 public int ProcessId { get @@ -188,6 +195,7 @@ namespace Tizen.Applications /// /// Gets the state of the application. /// + /// 3 public AppState State { get @@ -206,6 +214,7 @@ namespace Tizen.Applications /// /// Gets whether the application is sub application of the application group. /// + /// 3 public bool IsSubApp { get @@ -227,6 +236,7 @@ namespace Tizen.Applications /// Thrown when failed because of permission denied. /// Thrown when failed because of system error. /// http://tizen.org/privilege/appmanager.kill + /// 4 [EditorBrowsable(EditorBrowsableState.Never)] public void Terminate() { @@ -252,6 +262,7 @@ namespace Tizen.Applications /// Thrown when failed because of permission denied. /// Thrown when failed because of system error. /// http://tizen.org/privilege/appmanager.launch + /// 4 public void Resume() { err = Interop.ApplicationManager.AppManagerResumeApp(_contextHandle); @@ -272,6 +283,7 @@ namespace Tizen.Applications /// /// Releases all resources used by the ApplicationRunningContext class. /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationTerminatedEventArgs.cs b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationTerminatedEventArgs.cs index 360cd93..d912218 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationTerminatedEventArgs.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationTerminatedEventArgs.cs @@ -21,11 +21,13 @@ namespace Tizen.Applications /// /// Arguments for the event raised when the application is terminated. /// + /// 3 public class ApplicationTerminatedEventArgs : EventArgs { /// /// The information of the application. /// + /// 3 public ApplicationRunningContext ApplicationRunningContext { get; internal set; } } } \ No newline at end of file diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationType.cs b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationType.cs index de05b86..153b566 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/ApplicationType.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ApplicationType.cs @@ -19,6 +19,7 @@ namespace Tizen.Applications /// /// Enumeration for the applications type. /// + /// 3 public enum ApplicationType { /// diff --git a/src/Tizen.Applications.Common/Tizen.Applications/Bundle.cs b/src/Tizen.Applications.Common/Tizen.Applications/Bundle.cs index 8c6a084..67b7027 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/Bundle.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/Bundle.cs @@ -30,6 +30,7 @@ namespace Tizen.Applications /// This class is accessed by using a constructor to create a new instance of this object. /// A bundle instance is not guaranteed to be thread safe if the instance is modified by multiple threads. /// + /// 3 public class Bundle : IDisposable { private SafeBundleHandle _handle; @@ -45,6 +46,7 @@ namespace Tizen.Applications /// Tizen.Applications.Bundle bundle = new Tizen.Applications.Bundle(); /// /// + /// 3 public Bundle() { _handle = Interop.Bundle.Create(); @@ -57,6 +59,7 @@ namespace Tizen.Applications /// /// The SafeBundleHandle instance. /// Thrown when the handle is null or invalid. + /// 3 public Bundle(SafeBundleHandle handle) { if (handle == null || handle.IsInvalid) @@ -105,6 +108,7 @@ namespace Tizen.Applications /// Console.WriteLine("There are {0} items in the bundle", bundle.Count); /// /// + /// 3 public int Count { get @@ -129,6 +133,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public IEnumerable Keys { get @@ -140,6 +145,7 @@ namespace Tizen.Applications /// /// Gets the SafeBundleHandle instance. /// + /// 3 public SafeBundleHandle SafeBundleHandle { get { return _handle; } @@ -148,6 +154,7 @@ namespace Tizen.Applications /// /// Releases any unmanaged resources used by this object. /// + /// 3 public void Dispose() { Dispose(true); @@ -170,6 +177,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public bool Contains(string key) { return _keys.Contains(key); @@ -190,6 +198,7 @@ namespace Tizen.Applications /// bundle.AddItem("byte_array", byteArray); /// /// + /// 3 public void AddItem(string key, byte[] value) { if (value == null) @@ -217,6 +226,7 @@ namespace Tizen.Applications /// bundle.AddItem("byte_array", byteArray, 2, 3); /// /// + /// 3 public void AddItem(string key, byte[] value, int offset, int count) { if (!_keys.Contains(key)) @@ -265,6 +275,7 @@ namespace Tizen.Applications /// bundle.AddItem("string", "a_string"); /// /// + /// 3 public void AddItem(string key, string value) { if (!_keys.Contains(key)) @@ -293,6 +304,7 @@ namespace Tizen.Applications /// bundle.AddItem("string_array", stringArray); /// /// + /// 3 public void AddItem(string key, IEnumerable value) { if (!_keys.Contains(key)) @@ -330,6 +342,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public object GetItem(string key) { if (_keys.Contains(key)) @@ -408,6 +421,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public T GetItem(string key) { return (T)GetItem(key); @@ -432,6 +446,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public bool TryGetItem(string key, out byte[] value) { if (_keys.Contains(key) && Interop.Bundle.GetType(_handle, key) == (int)BundleType.Byte) @@ -468,6 +483,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public bool TryGetItem(string key, out string value) { if (_keys.Contains(key) && Interop.Bundle.GetType(_handle, key) == (int)BundleType.String) @@ -508,6 +524,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public bool TryGetItem(string key, out IEnumerable value) { if (_keys.Contains(key) && Interop.Bundle.GetType(_handle, key) == (int)BundleType.StringArray) @@ -550,6 +567,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public bool Is(string key) { if (_keys.Contains(key)) @@ -596,6 +614,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public bool RemoveItem(string key) { if (_keys.Contains(key)) @@ -628,6 +647,7 @@ namespace Tizen.Applications /// Bundle data = bundle.Decode(bundleRaw); /// /// + /// 3 public static Bundle Decode(string bundleRaw) { SafeBundleHandle handle; @@ -652,6 +672,7 @@ namespace Tizen.Applications /// string bundleRaw = bundle.Encode(); /// /// + /// 3 public string Encode() { string bundleRaw; @@ -670,6 +691,7 @@ namespace Tizen.Applications /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// /// If true, disposes any disposable objects. If false, does not dispose disposable objects. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposed) diff --git a/src/Tizen.Applications.Common/Tizen.Applications/CoreApplication.cs b/src/Tizen.Applications.Common/Tizen.Applications/CoreApplication.cs index d725a78..786f4d5 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/CoreApplication.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/CoreApplication.cs @@ -23,6 +23,7 @@ namespace Tizen.Applications /// /// This class represents an application controlled lifecycles by the backend system. /// + /// 3 public class CoreApplication : Application { private readonly ICoreBackend _backend; @@ -32,6 +33,7 @@ namespace Tizen.Applications /// Initializes the CoreApplication class. /// /// The backend instance implementing ICoreBacked interface. + /// 3 public CoreApplication(ICoreBackend backend) { _backend = backend; @@ -40,52 +42,62 @@ namespace Tizen.Applications /// /// Occurs when the application is launched. /// + /// 3 public event EventHandler Created; /// /// Occurs when the application is about to shutdown. /// + /// 3 public event EventHandler Terminated; /// /// Occurs whenever the application receives the appcontrol message. /// + /// 3 public event EventHandler AppControlReceived; /// /// Occurs when the system memory is low. /// + /// 3 public event EventHandler LowMemory; /// /// Occurs when the system battery is low. /// + /// 3 public event EventHandler LowBattery; /// /// Occurs when the system language is chagned. /// + /// 3 public event EventHandler LocaleChanged; /// /// Occurs when the region format is changed. /// + /// 3 public event EventHandler RegionFormatChanged; /// /// Occurs when the device orientation is changed. /// + /// 3 public event EventHandler DeviceOrientationChanged; /// /// The backend instance. /// + /// 3 protected ICoreBackend Backend { get { return _backend; } } /// /// Runs the application's main loop. /// /// Arguments from commandline. + /// 3 public override void Run(string[] args) { base.Run(args); @@ -117,6 +129,7 @@ namespace Tizen.Applications /// /// Exits the main loop of the application. /// + /// 3 public override void Exit() { _backend.Exit(); @@ -126,6 +139,7 @@ namespace Tizen.Applications /// Overrides this method if want to handle behavior when the application is launched. /// If base.OnCreated() is not called, the event 'Created' will not be emitted. /// + /// 3 protected virtual void OnCreate() { Created?.Invoke(this, EventArgs.Empty); @@ -135,6 +149,7 @@ namespace Tizen.Applications /// Overrides this method if want to handle behavior when the application is terminated. /// If base.OnTerminate() is not called, the event 'Terminated' will not be emitted. /// + /// 3 protected virtual void OnTerminate() { Terminated?.Invoke(this, EventArgs.Empty); @@ -145,6 +160,7 @@ namespace Tizen.Applications /// If base.OnAppControlReceived() is not called, the event 'AppControlReceived' will not be emitted. /// /// + /// 3 protected virtual void OnAppControlReceived(AppControlReceivedEventArgs e) { AppControlReceived?.Invoke(this, e); @@ -154,6 +170,7 @@ namespace Tizen.Applications /// Overrides this method if want to handle behavior when the system memory is low. /// If base.OnLowMemory() is not called, the event 'LowMemory' will not be emitted. /// + /// 3 protected virtual void OnLowMemory(LowMemoryEventArgs e) { LowMemory?.Invoke(this, e); @@ -164,6 +181,7 @@ namespace Tizen.Applications /// Overrides this method if want to handle behavior when the system battery is low. /// If base.OnLowBattery() is not called, the event 'LowBattery' will not be emitted. /// + /// 3 protected virtual void OnLowBattery(LowBatteryEventArgs e) { LowBattery?.Invoke(this, e); @@ -173,6 +191,7 @@ namespace Tizen.Applications /// Overrides this method if want to handle behavior when the system language is changed. /// If base.OnLocaleChanged() is not called, the event 'LocaleChanged' will not be emitted. /// + /// 3 protected virtual void OnLocaleChanged(LocaleChangedEventArgs e) { LocaleChanged?.Invoke(this, e); @@ -182,6 +201,7 @@ namespace Tizen.Applications /// Overrides this method if want to handle behavior when the region format is changed. /// If base.OnRegionFormatChanged() is not called, the event 'RegionFormatChanged' will not be emitted. /// + /// 3 protected virtual void OnRegionFormatChanged(RegionFormatChangedEventArgs e) { RegionFormatChanged?.Invoke(this, e); @@ -191,6 +211,7 @@ namespace Tizen.Applications /// Overrides this method if want to handle behavior when the device orientation is changed. /// If base.OnRegionFormatChanged() is not called, the event 'RegionFormatChanged' will not be emitted. /// + /// 3 protected virtual void OnDeviceOrientationChanged(DeviceOrientationEventArgs e) { DeviceOrientationChanged?.Invoke(this, e); @@ -200,6 +221,7 @@ namespace Tizen.Applications /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// /// If true, disposes any disposable objects. If false, does not dispose disposable objects. + /// 3 protected override void Dispose(bool disposing) { if (!_disposedValue) diff --git a/src/Tizen.Applications.Common/Tizen.Applications/DeviceOrientation.cs b/src/Tizen.Applications.Common/Tizen.Applications/DeviceOrientation.cs index 19a8f21..60970a8 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/DeviceOrientation.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/DeviceOrientation.cs @@ -19,6 +19,7 @@ namespace Tizen.Applications /// /// Enumeration for the device orientation. /// + /// 3 public enum DeviceOrientation { /// diff --git a/src/Tizen.Applications.Common/Tizen.Applications/DeviceOrientationEventArgs.cs b/src/Tizen.Applications.Common/Tizen.Applications/DeviceOrientationEventArgs.cs index 63bb8ea..d90e147 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/DeviceOrientationEventArgs.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/DeviceOrientationEventArgs.cs @@ -21,12 +21,14 @@ namespace Tizen.Applications /// /// The class for event arguments of the DeviceOrientationChanged. /// + /// 3 public class DeviceOrientationEventArgs : EventArgs { /// /// Initializes the DeviceOrientationEventArgs class. /// /// The information of the DeviceOrientation + /// 3 public DeviceOrientationEventArgs(DeviceOrientation orientation) { DeviceOrientation = orientation; @@ -35,6 +37,7 @@ namespace Tizen.Applications /// /// The received DeviceOrientation. /// + /// 3 public DeviceOrientation DeviceOrientation { get; private set; } } } diff --git a/src/Tizen.Applications.Common/Tizen.Applications/DirectoryInfo.cs b/src/Tizen.Applications.Common/Tizen.Applications/DirectoryInfo.cs index 0166fc1..cceaba4 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/DirectoryInfo.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/DirectoryInfo.cs @@ -19,6 +19,7 @@ namespace Tizen.Applications /// /// Represents directory information of the application. /// + /// 3 public class DirectoryInfo { private string _dataPath; @@ -42,6 +43,7 @@ namespace Tizen.Applications /// /// Gets the absolute path to the application's data directory, which is used to store private data of the application. /// + /// 3 public string Data { get @@ -55,6 +57,7 @@ namespace Tizen.Applications /// /// Gets the absolute path to the application's cache directory, which is used to store temporary data of the application. /// + /// 3 public string Cache { get @@ -68,6 +71,7 @@ namespace Tizen.Applications /// /// Gets the absolute path to the application resource directory. The resource files are delivered with the application package. /// + /// 3 public string Resource { get @@ -81,6 +85,7 @@ namespace Tizen.Applications /// /// Gets the absolute path to the application's shared data directory, which is used to share data with other applications. /// + /// 3 public string SharedData { get @@ -94,6 +99,7 @@ namespace Tizen.Applications /// /// Gets the absolute path to the application's shared resource directory, which is used to share resources with other applications. /// + /// 3 public string SharedResource { get @@ -108,6 +114,7 @@ namespace Tizen.Applications /// /// Gets the absolute path to the application's shared trusted directory, which is used to share data with a family of trusted applications. /// + /// 3 public string SharedTrusted { get @@ -121,6 +128,7 @@ namespace Tizen.Applications /// /// Gets the absolute path to the application's external data directory, which is used to store data of the application. /// + /// 3 public string ExternalData { get @@ -134,6 +142,7 @@ namespace Tizen.Applications /// /// Gets the absolute path to the application's external cache directory, which is used to store temporary data of the application. /// + /// 3 public string ExternalCache { get @@ -147,6 +156,7 @@ namespace Tizen.Applications /// /// Gets the absolute path to the application's external shared data directory, which is used to share data with other applications. /// + /// 3 public string ExternalSharedData { get @@ -160,6 +170,7 @@ namespace Tizen.Applications /// /// Gets the absolute path to the application's TEP(Tizen Expansion Package) directory. The resource files are delivered with the expansion package. /// + /// 3 public string ExpansionPackageResource { get diff --git a/src/Tizen.Applications.Common/Tizen.Applications/LocaleChangedEventArgs.cs b/src/Tizen.Applications.Common/Tizen.Applications/LocaleChangedEventArgs.cs index a1e99ba..21f5396 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/LocaleChangedEventArgs.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/LocaleChangedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// The class for the argument of the LocaleChanged EventHandler /// + /// 3 public class LocaleChangedEventArgs : EventArgs { @@ -28,6 +29,7 @@ namespace Tizen.Applications /// Initializes LocaleChangedEventArgs class /// /// The information of the Locale + /// 3 public LocaleChangedEventArgs(string locale) { Locale = locale; @@ -36,6 +38,7 @@ namespace Tizen.Applications /// /// The property to get the intformation of the Locale /// + /// 3 public string Locale { get; private set; } } diff --git a/src/Tizen.Applications.Common/Tizen.Applications/LowBatteryEventArgs.cs b/src/Tizen.Applications.Common/Tizen.Applications/LowBatteryEventArgs.cs index bf0c49a..6adb7a9 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/LowBatteryEventArgs.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/LowBatteryEventArgs.cs @@ -21,12 +21,14 @@ namespace Tizen.Applications /// /// The class for the argument of the LowBattery EventHandler /// + /// 3 public class LowBatteryEventArgs : EventArgs { /// /// Initializes LowBatteryEventArgs class /// /// The information of the LowBatteryEventArgs + /// 3 public LowBatteryEventArgs(LowBatteryStatus status) { LowBatteryStatus = status; @@ -35,6 +37,7 @@ namespace Tizen.Applications /// /// The property to get the intformation of the LowBatteryStatus /// + /// 3 public LowBatteryStatus LowBatteryStatus { get; private set; } } } diff --git a/src/Tizen.Applications.Common/Tizen.Applications/LowBatteryStatus.cs b/src/Tizen.Applications.Common/Tizen.Applications/LowBatteryStatus.cs index d9d2184..14cafef 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/LowBatteryStatus.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/LowBatteryStatus.cs @@ -19,6 +19,7 @@ namespace Tizen.Applications /// /// Enumeration for the low battery status. /// + /// 3 public enum LowBatteryStatus { /// diff --git a/src/Tizen.Applications.Common/Tizen.Applications/LowMemoryEventArgs.cs b/src/Tizen.Applications.Common/Tizen.Applications/LowMemoryEventArgs.cs index e42fedc..f3832f4 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/LowMemoryEventArgs.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/LowMemoryEventArgs.cs @@ -21,12 +21,14 @@ namespace Tizen.Applications /// /// The class for the argument of the LowMemory EventHandler /// + /// 3 public class LowMemoryEventArgs : EventArgs { /// /// Initializes LowMemoryEventArgs class /// /// The information of the LowMemoryStatus + /// 3 public LowMemoryEventArgs(LowMemoryStatus status) { LowMemoryStatus = status; @@ -35,6 +37,7 @@ namespace Tizen.Applications /// /// The property to get the intformation of the LowMemoryStatus /// + /// 3 public LowMemoryStatus LowMemoryStatus { get; private set; } } } diff --git a/src/Tizen.Applications.Common/Tizen.Applications/LowMemoryStatus.cs b/src/Tizen.Applications.Common/Tizen.Applications/LowMemoryStatus.cs index e584add..d13689c 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/LowMemoryStatus.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/LowMemoryStatus.cs @@ -19,6 +19,7 @@ namespace Tizen.Applications /// /// Enumeration for the low memory status. /// + /// 3 public enum LowMemoryStatus { /// diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ReceivedAppControl.cs b/src/Tizen.Applications.Common/Tizen.Applications/ReceivedAppControl.cs index f639ef3..c35dadf 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/ReceivedAppControl.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ReceivedAppControl.cs @@ -43,6 +43,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public class ReceivedAppControl : AppControl { private const string LogTag = "Tizen.Applications"; @@ -50,6 +51,7 @@ namespace Tizen.Applications /// /// Initializes a ReceivedAppControl class. /// + /// 3 public ReceivedAppControl(SafeAppControlHandle handle) : base(handle) { } @@ -69,6 +71,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public string CallerApplicationId { get @@ -98,6 +101,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public bool IsReplyRequest { get @@ -132,6 +136,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public void ReplyToLaunchRequest(AppControl replyRequest, AppControlReplyResult result) { if (replyRequest == null) diff --git a/src/Tizen.Applications.Common/Tizen.Applications/RecentApplicationControl.cs b/src/Tizen.Applications.Common/Tizen.Applications/RecentApplicationControl.cs index 19f9bb7..db2fdc6 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/RecentApplicationControl.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/RecentApplicationControl.cs @@ -24,6 +24,7 @@ namespace Tizen.Applications /// /// This class provides methods and properties to get information of the recent application. /// + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] public class RecentApplicationControl { @@ -40,6 +41,7 @@ namespace Tizen.Applications /// Deletes the application from the recent application list. /// /// platform + /// 3 public void Delete() { Interop.ApplicationManager.ErrorCode err = Interop.ApplicationManager.ErrorCode.None; @@ -54,6 +56,7 @@ namespace Tizen.Applications /// Deletes all recent applications from the recent application list. /// /// platform + /// 3 public static void DeleteAll() { Interop.ApplicationManager.ErrorCode err = Interop.ApplicationManager.ErrorCode.None; diff --git a/src/Tizen.Applications.Common/Tizen.Applications/RecentApplicationInfo.cs b/src/Tizen.Applications.Common/Tizen.Applications/RecentApplicationInfo.cs index 6ffc644..88dd776 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/RecentApplicationInfo.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/RecentApplicationInfo.cs @@ -23,6 +23,7 @@ namespace Tizen.Applications /// /// This class provides methods and properties to get information of the recent application. /// + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] public class RecentApplicationInfo : ApplicationInfo { @@ -31,31 +32,37 @@ namespace Tizen.Applications /// /// Gets the instance ID. /// + /// 3 public string InstanceId { get; private set; } /// /// Gets the instance name. /// + /// 3 public string InstanceName { get; private set; } /// /// Gets the arguements. /// + /// 3 public string Arg { get; private set; } /// /// Gets the URI. /// + /// 3 public string Uri { get; private set; } /// /// Gets the launchTime. /// + /// 3 public DateTime LaunchTime { get; private set; } /// /// Gets the recent application controller. /// + /// 3 public RecentApplicationControl Controller { get; private set; } internal RecentApplicationInfo(Interop.ApplicationManager.RuaRec record) : base(Marshal.PtrToStringAnsi(record.pkgName)) diff --git a/src/Tizen.Applications.Common/Tizen.Applications/RegionFormatChangedEventArgs.cs b/src/Tizen.Applications.Common/Tizen.Applications/RegionFormatChangedEventArgs.cs index a481093..569ca1a 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/RegionFormatChangedEventArgs.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/RegionFormatChangedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// The class for the argument of the RegionFormatChanged EventHandler /// + /// 3 public class RegionFormatChangedEventArgs : EventArgs { @@ -28,6 +29,7 @@ namespace Tizen.Applications /// Initializes RegionFormatChangedEventArgs class /// /// The information of the Region + /// 3 public RegionFormatChangedEventArgs(string region) { Region = region; @@ -36,6 +38,7 @@ namespace Tizen.Applications /// /// The property to get the intformation of the Region /// + /// 3 public string Region { get; private set; } } } diff --git a/src/Tizen.Applications.Common/Tizen.Applications/ResourceManager.cs b/src/Tizen.Applications.Common/Tizen.Applications/ResourceManager.cs index d300c57b..ea9b047 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/ResourceManager.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/ResourceManager.cs @@ -23,11 +23,13 @@ namespace Tizen.Applications /// /// The class for getting the resource path. /// + /// 3 public static class ResourceManager { /// /// Enumeration for the resource category. /// + /// 3 public enum Category : int { /// @@ -76,6 +78,7 @@ namespace Tizen.Applications /// ID to search. /// Found resource path. /// Thrown in case of failed conditions. + /// 3 public static string GetPath(Category category, string id) { string path; @@ -103,6 +106,7 @@ namespace Tizen.Applications /// ID to search. /// Found resource path or null when the resource doesn't exist. /// Thrown in case of failed conditions. + /// 3 public static string TryGetPath(Category category, string id) { string path; diff --git a/src/Tizen.Applications.Common/Tizen.Applications/SafeAppControlHandle.cs b/src/Tizen.Applications.Common/Tizen.Applications/SafeAppControlHandle.cs index 50006f5..a81721c 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/SafeAppControlHandle.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/SafeAppControlHandle.cs @@ -22,11 +22,13 @@ namespace Tizen.Applications /// /// Represents a wrapper class for an unmanaged AppControl handle. /// + /// 3 public sealed class SafeAppControlHandle : SafeHandle { /// /// Initializes a new instance of the SafeAppControlHandle class. /// + /// 3 public SafeAppControlHandle() : base(IntPtr.Zero, true) { } @@ -36,6 +38,7 @@ namespace Tizen.Applications /// /// An IntPtr object that represents the pre-existing handle to use. /// true to reliably release the handle during the finalization phase; false to prevent reliable release. + /// 3 public SafeAppControlHandle(IntPtr existingHandle, bool ownsHandle) : base(IntPtr.Zero, ownsHandle) { SetHandle(existingHandle); @@ -44,6 +47,7 @@ namespace Tizen.Applications /// /// Gets a value that indicates whether the handle is invalid. /// + /// 3 public override bool IsInvalid { get { return this.handle == IntPtr.Zero; } diff --git a/src/Tizen.Applications.Common/Tizen.Applications/SafeBundleHandle.cs b/src/Tizen.Applications.Common/Tizen.Applications/SafeBundleHandle.cs index 7da7f27..cd09b04 100755 --- a/src/Tizen.Applications.Common/Tizen.Applications/SafeBundleHandle.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/SafeBundleHandle.cs @@ -22,11 +22,13 @@ namespace Tizen.Applications /// /// Represents a wrapper class for an unmanaged bundle handle. /// + /// 3 public sealed class SafeBundleHandle : SafeHandle { /// /// Initializes a new instance of the SafeBundleHandle class. /// + /// 3 public SafeBundleHandle() : base(IntPtr.Zero, true) { } @@ -36,6 +38,7 @@ namespace Tizen.Applications /// /// An IntPtr object that represents the pre-existing handle to use. /// true to reliably release the handle during the finalization phase; false to prevent reliable release. + /// 3 public SafeBundleHandle(IntPtr existingHandle, bool ownsHandle) : base(IntPtr.Zero, ownsHandle) { SetHandle(existingHandle); @@ -44,6 +47,7 @@ namespace Tizen.Applications /// /// Gets a value that indicates whether the handle is invalid. /// + /// 3 public override bool IsInvalid { get { return this.handle == IntPtr.Zero; } diff --git a/src/Tizen.Applications.Common/Tizen.Applications/TizenSynchronizationContext.cs b/src/Tizen.Applications.Common/Tizen.Applications/TizenSynchronizationContext.cs index df29950..741242c 100644 --- a/src/Tizen.Applications.Common/Tizen.Applications/TizenSynchronizationContext.cs +++ b/src/Tizen.Applications.Common/Tizen.Applications/TizenSynchronizationContext.cs @@ -24,6 +24,7 @@ namespace Tizen.Applications /// /// Provides a synchronization context for the Tizen application model. /// + /// 3 public class TizenSynchronizationContext : SynchronizationContext { private readonly Interop.Glib.GSourceFunc _wrapperHandler; @@ -34,6 +35,7 @@ namespace Tizen.Applications /// /// Initializes a new instance of the TizenSynchronizationContext class. /// + /// 3 public TizenSynchronizationContext() { _wrapperHandler = new Interop.Glib.GSourceFunc(Handler); @@ -48,6 +50,7 @@ namespace Tizen.Applications /// SetSynchronizationContext(new TizenSynchronizationContext()); /// /// + /// 3 public static void Initialize() { SetSynchronizationContext(new TizenSynchronizationContext()); @@ -61,6 +64,7 @@ namespace Tizen.Applications /// The object passed to the delegate. /// /// The post method starts an asynchronous request to post a message. + /// 3 public override void Post(SendOrPostCallback d, object state) { Post(() => @@ -76,6 +80,7 @@ namespace Tizen.Applications /// The object passed to the delegate. /// /// The send method starts a synchronous request to send a message. + /// 3 public override void Send(SendOrPostCallback d, object state) { var mre = new ManualResetEvent(false); diff --git a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/BulkData.cs b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/BulkData.cs index f65a411..7cb1cd9 100755 --- a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/BulkData.cs +++ b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/BulkData.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications.DataControl /// /// Represents the BulkData class for the DataControl bulk request. /// + /// 3 public class BulkData : IDisposable { private bool _disposed = false; @@ -30,6 +31,7 @@ namespace Tizen.Applications.DataControl /// Initializes the BulkData class. /// /// Thrown in case of any internal error. + /// 3 public BulkData() { ResultType ret; @@ -84,6 +86,7 @@ namespace Tizen.Applications.DataControl /// /// Bulk data /// Thrown in case of an invalid parameter. + /// 3 public void Add(Bundle data) { ResultType ret; @@ -103,6 +106,7 @@ namespace Tizen.Applications.DataControl /// /// Gets the current data count. /// + /// 3 public int GetCount() { int count; @@ -122,6 +126,7 @@ namespace Tizen.Applications.DataControl /// /// The target data index. /// Thrown in case of an invalid parameter. + /// 3 public Bundle GetData(int index) { IntPtr bundlePtr; @@ -146,6 +151,7 @@ namespace Tizen.Applications.DataControl /// /// Releases all the resources used by the BulkData class. /// + /// 3 public void Dispose() { Dispose(true); @@ -156,6 +162,7 @@ namespace Tizen.Applications.DataControl /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// /// If true, disposes any disposable objects. If false, does not dispose disposable objects. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -181,6 +188,7 @@ namespace Tizen.Applications.DataControl /// /// Represents the BulkResultData class for the DataControl bulk request. /// + /// 3 public class BulkResultData : IDisposable { private const string LogTag = "Tizen.Applications.DataControl"; @@ -190,6 +198,7 @@ namespace Tizen.Applications.DataControl /// Initializes the BulkResultData class. /// /// Thrown in case of any internal error. + /// 3 public BulkResultData() { ResultType ret; @@ -240,6 +249,7 @@ namespace Tizen.Applications.DataControl /// The result data. /// Result. /// Thrown in case of an invalid parameter. + /// 3 public void Add(Bundle data, int result) { ResultType ret; @@ -264,6 +274,7 @@ namespace Tizen.Applications.DataControl /// /// Gets the current result data count. /// + /// 3 public int GetCount() { int count; @@ -283,6 +294,7 @@ namespace Tizen.Applications.DataControl /// /// The target result data index. /// Thrown in case of an invalid parameter. + /// 3 public Bundle GetData(int index) { IntPtr bundlePtr; @@ -310,6 +322,7 @@ namespace Tizen.Applications.DataControl /// /// The target result index. /// Thrown in case of an invalid parameter. + /// 3 public int GetResult(int index) { IntPtr bundlePtr; @@ -333,6 +346,7 @@ namespace Tizen.Applications.DataControl /// /// Releases all the resources used by the BulkResultData class. /// + /// 3 public void Dispose() { Dispose(true); @@ -343,6 +357,7 @@ namespace Tizen.Applications.DataControl /// Releases any unmanaged resources used by this object. Can also dispose any other disposable objects. /// /// If true, disposes any disposable objects. If false, does not dispose disposable objects. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposed) diff --git a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Consumer.cs b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Consumer.cs index 9210db5..27a85ac 100755 --- a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Consumer.cs +++ b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Consumer.cs @@ -23,6 +23,7 @@ namespace Tizen.Applications.DataControl /// /// Represents the Consumer class for the DataControl consumer application. /// + /// 3 public abstract class Consumer : IDisposable { @@ -453,6 +454,7 @@ namespace Tizen.Applications.DataControl /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch + /// 3 public void Insert(Bundle insertData) { int reqId; @@ -488,6 +490,7 @@ namespace Tizen.Applications.DataControl /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch + /// 3 public void Select(string[] columnList, string where, string order, int pageNumber = 1, int countPerPage = 20) { int reqId, i; @@ -526,6 +529,7 @@ namespace Tizen.Applications.DataControl /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch + /// 3 public void Delete(string where) { int reqId; @@ -554,6 +558,7 @@ namespace Tizen.Applications.DataControl /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch + /// 3 public void Update(Bundle updateData, string where) { int reqId; @@ -591,6 +596,7 @@ namespace Tizen.Applications.DataControl /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch + /// 3 public void BulkInsert(BulkData insertData) { int reqId; @@ -624,6 +630,7 @@ namespace Tizen.Applications.DataControl /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch + /// 3 public void MapAdd(string key, string value) { int reqId; @@ -657,6 +664,7 @@ namespace Tizen.Applications.DataControl /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch + /// 3 public void MapGet(string key, int pageNumber = 1, int countPerPage = 20) { int reqId; @@ -689,6 +697,7 @@ namespace Tizen.Applications.DataControl /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch + /// 3 public void MapRemove(string key, string value) { int reqId; @@ -723,6 +732,7 @@ namespace Tizen.Applications.DataControl /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch + /// 3 public void MapSet(string key, string oldValue, string newValue) { int reqId; @@ -755,6 +765,7 @@ namespace Tizen.Applications.DataControl /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch + /// 3 public void MapBulkAdd(BulkData addData) { int reqId; @@ -795,6 +806,7 @@ namespace Tizen.Applications.DataControl /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing /// http://tizen.org/privilege/appmanager.launch + /// 3 public void DataChangeListen() { ResultType ret; @@ -823,6 +835,7 @@ namespace Tizen.Applications.DataControl /// The DataControl Data ID. /// Thrown in case of an invalid parmaeter. /// Thrown in case of any internal error. + /// 3 public Consumer(string providerId, string dataId) { ResultType ret; @@ -861,6 +874,7 @@ namespace Tizen.Applications.DataControl /// /// Overrides this method if you want to handle the behavior when the DataChangeListen result is received. /// + /// 3 protected virtual void OnDataChangeListenResult(DataChangeListenResult result) { Log.Info(LogTag, "The OnDataChangeListenResult is not implemented."); @@ -869,6 +883,7 @@ namespace Tizen.Applications.DataControl /// /// Overrides this method if you want to handle the behavior when the data change event is received. /// + /// 3 protected virtual void OnDataChange(ChangeType type, Bundle data) { Log.Info(LogTag, "The OnDataChange is not implemented."); @@ -877,25 +892,30 @@ namespace Tizen.Applications.DataControl /// /// Overrides this method if you want to handle the behavior when the select response is received. /// + /// 3 protected abstract void OnSelectResult(SelectResult result); /// /// Overrides this method if you want to handle the behavior when the insert response is received. /// + /// 3 protected abstract void OnInsertResult(InsertResult result); /// /// Overrides this method if you want to handle the behavior when the update response is received. /// + /// 3 protected abstract void OnUpdateResult(UpdateResult result); /// /// Overrides this method if want to handle the behavior when the delete response is received. /// + /// 3 protected abstract void OnDeleteResult(DeleteResult result); /// /// Overrides this method if you want to handle the behavior when the BulkInsert response is received. /// + /// 3 protected virtual void OnBulkInsertResult(BulkInsertResult result) { Log.Info(LogTag, "The OnBulkInsertResult is not implemented."); @@ -904,6 +924,7 @@ namespace Tizen.Applications.DataControl /// /// Overrides this method if you want to handle the behavior when the map get response is received. /// + /// 3 protected virtual void OnMapGetResult(MapGetResult result) { Log.Info(LogTag, "The OnMapGetResult is not implemented."); @@ -912,6 +933,7 @@ namespace Tizen.Applications.DataControl /// /// Overrides this method if you want to handle the behavior when the map add response is received. /// + /// 3 protected virtual void OnMapAddResult(MapAddResult result) { Log.Info(LogTag, "The OnMapAddResult is not implemented."); @@ -920,6 +942,7 @@ namespace Tizen.Applications.DataControl /// /// Overrides this method if you want to handle the behavior when the map set response is received. /// + /// 3 protected virtual void OnMapSetResult(MapSetResult result) { Log.Info(LogTag, "The OnMapSetResult is not implemented."); @@ -928,6 +951,7 @@ namespace Tizen.Applications.DataControl /// /// Overrides this method if you want to handle the behavior when the map remove response is received. /// + /// 3 protected virtual void OnMapRemoveResult(MapRemoveResult result) { Log.Info(LogTag, "The OnMapRemoveResult is not implemented."); @@ -936,6 +960,7 @@ namespace Tizen.Applications.DataControl /// /// Overrides this method if you want to handle the behavior when the BulkAdd response is received. /// + /// 3 protected virtual void OnMapBulkAddResult(MapBulkAddResult result) { Log.Info(LogTag, "The OnMapBulkAddResult is not implemented."); @@ -945,6 +970,7 @@ namespace Tizen.Applications.DataControl /// Releases the unmanaged resources used by the Consumer class specifying whether to perform a normal dispose operation. /// /// true for a normal dispose operation; false to finalize the handle. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -968,6 +994,7 @@ namespace Tizen.Applications.DataControl /// /// Releases all resources used by the Consumer class. /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/ICursor.cs b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/ICursor.cs index 0843ceb..8ca7cc0 100755 --- a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/ICursor.cs +++ b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/ICursor.cs @@ -20,62 +20,75 @@ namespace Tizen.Applications.DataControl /// /// This interface is for the DataControl cursor. /// + /// 3 public interface ICursor { /// /// Gets a column count. /// + /// 3 int GetColumnCount(); /// /// Gets a column type. /// /// The index of column. + /// 3 ColumnType GetColumnType(int index); /// /// Gets a column name. /// /// The index of column. + /// 3 string GetColumnName(int index); /// /// Gets the numbers of rows in the cursor. /// + /// 3 long GetRowCount(); /// /// Gets a next row. /// + /// 3 bool Next(); /// /// Gets a prev row. /// + /// 3 bool Prev(); /// /// Gets a first row. /// + /// 3 bool Reset(); /// /// Gets an integer value. /// /// The index of row. + /// 3 int GetIntValue(int index); /// /// Gets an int64 value. /// /// The index of row. + /// 3 Int64 GetInt64Value(int index); /// /// Gets a double value. /// /// The index of row. + /// 3 double GetDoubleValue(int index); /// /// Gets a string value. /// /// The index of row. + /// 3 string GetStringValue(int index); /// /// Gets a BLOB value. /// /// The index of row. + /// 3 byte[] GetBlobValue(int index); } } \ No newline at end of file diff --git a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/MatrixCursor.cs b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/MatrixCursor.cs index 98aa0b7..37563ae 100755 --- a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/MatrixCursor.cs +++ b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/MatrixCursor.cs @@ -26,6 +26,7 @@ namespace Tizen.Applications.DataControl /// /// Represents the MatrixCursor class for the DataControl provider's matrix cursor. /// + /// 3 public class MatrixCursor : IDisposable, ICursor { private const string LogTag = "Tizen.Applications.DataControl"; @@ -166,6 +167,7 @@ namespace Tizen.Applications.DataControl /// /// Gets the column count of the MatrixCursor. /// + /// 3 public int GetColumnCount() { return _columnTypes.Length; @@ -176,6 +178,7 @@ namespace Tizen.Applications.DataControl /// /// Target column index /// Thrown in case of an invalid parameter. + /// 3 public ColumnType GetColumnType(int index) { if (index < 0 || index >= _columnTypes.Length) @@ -191,6 +194,7 @@ namespace Tizen.Applications.DataControl /// /// The target column index. /// Thrown in case of an invalid parameter. + /// 3 public string GetColumnName(int index) { if (index < 0 || index >= _columnTypes.Length) @@ -204,6 +208,7 @@ namespace Tizen.Applications.DataControl /// /// Gets the MatrixCursor's row count. /// + /// 3 public long GetRowCount() { return _rowCount; @@ -212,6 +217,7 @@ namespace Tizen.Applications.DataControl /// /// Move the MatrixCursor to the next row. /// + /// 3 public bool Next() { if (_currentRowIndex >= _rowCount - 1) @@ -226,6 +232,7 @@ namespace Tizen.Applications.DataControl /// /// Move the MatrixCursor to the previous row. /// + /// 3 public bool Prev() { if (_currentRowIndex <= 0) @@ -240,6 +247,7 @@ namespace Tizen.Applications.DataControl /// /// Move the MatrixCursor to the first row. /// + /// 3 public bool Reset() { _currentRowIndex = 0; @@ -250,6 +258,7 @@ namespace Tizen.Applications.DataControl /// Returns the value of the requested column as an integer. /// /// Thrown in case of an invalid parameter. + /// 3 public int GetIntValue(int index) { int ret; @@ -274,6 +283,7 @@ namespace Tizen.Applications.DataControl /// Returns the value of the requested column as int64. /// /// Thrown in case of an invalid parameter. + /// 3 public Int64 GetInt64Value(int index) { Int64 ret; @@ -298,6 +308,7 @@ namespace Tizen.Applications.DataControl /// Returns the value of the requested column as a double. /// /// Thrown in case of an invalid parameter. + /// 3 public double GetDoubleValue(int index) { double ret; @@ -322,6 +333,7 @@ namespace Tizen.Applications.DataControl /// Returns the value of the requested column as a string. /// /// Thrown in case of an invalid parameter. + /// 3 public string GetStringValue(int index) { string ret; @@ -348,6 +360,7 @@ namespace Tizen.Applications.DataControl /// Returns the value of the requested column as a BLOB. /// /// Thrown in case of an invalid parameter. + /// 3 public byte[] GetBlobValue(int index) { byte[] byte_array; @@ -398,6 +411,7 @@ namespace Tizen.Applications.DataControl /// The MatrixCursor's column type list. /// Thrown in case of an invalid parameter. /// Thrown in case of any internal error. + /// 3 public MatrixCursor(string[] columnNames, ColumnType[] columnTypes) { byte[] byte_tmp, length_tmp, string_tmp; @@ -486,6 +500,7 @@ namespace Tizen.Applications.DataControl /// /// New column values /// Thrown in case of an invalid parameter. + /// 3 public void AddRow(object[] columnValues) { int i, size = 0; @@ -588,6 +603,7 @@ namespace Tizen.Applications.DataControl /// /// Releases all the resources used by the MatrixCursor class. /// + /// 3 public void Dispose() { Dispose(true); @@ -597,6 +613,7 @@ namespace Tizen.Applications.DataControl /// Releases the unmanaged resources used by the MatrixCursor class specifying whether to perform a normal dispose operation. /// /// true for a normal dispose operation; false to finalize the handle. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposed) diff --git a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Provider.cs b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Provider.cs index a7d4e3f..de03469 100755 --- a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Provider.cs +++ b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Provider.cs @@ -26,6 +26,7 @@ namespace Tizen.Applications.DataControl /// /// Represents the Provider class for the DataControl provider application. /// + /// 3 public abstract class Provider : IDisposable { private const string LogTag = "Tizen.Applications.DataControl"; @@ -45,6 +46,7 @@ namespace Tizen.Applications.DataControl /// /// Gets the data ID. /// + /// 3 public string DataID { get; @@ -840,6 +842,7 @@ namespace Tizen.Applications.DataControl /// Thrown in case a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing + /// 3 public void SendDataChange(ChangeType type, Bundle changedData) { ResultType ret; @@ -866,6 +869,7 @@ namespace Tizen.Applications.DataControl /// /// The DataControl Data ID. /// Thrown in case of an invalid parameter. + /// 3 public Provider(string dataID) { if (string.IsNullOrEmpty(dataID)) @@ -883,6 +887,7 @@ namespace Tizen.Applications.DataControl /// Thrown in case a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/datasharing + /// 3 public void Run() { ResultType ret; @@ -965,6 +970,7 @@ namespace Tizen.Applications.DataControl /// /// Stops the Provider service. /// + /// 3 public void Stop() { if (_isRunning == true) @@ -986,26 +992,31 @@ namespace Tizen.Applications.DataControl /// /// Overrides this method if you want to handle the behavior when the select request is received. /// + /// 3 protected abstract SelectResult OnSelect(string query, string where, string[] columList, int columnCount, string order, int pageNum, int countPerPage); /// /// Overrides this method if you want to handle the behavior when the insert request is received. /// + /// 3 protected abstract InsertResult OnInsert(string query, Bundle insertData); /// /// Overrides this method if you want to handle the behavior when the update request is received. /// + /// 3 protected abstract UpdateResult OnUpdate(string query, string where, Bundle updateData); /// /// Overrides this method if you want to handle the behavior when the delete request is received. /// + /// 3 protected abstract DeleteResult OnDelete(string query, string where); /// /// Overrides this method if you want to handle the behavior when the bulk insert request is received. /// + /// 3 protected virtual BulkInsertResult OnBulkInsert(IEnumerable query, BulkData bulkInsertData) { Log.Info(LogTag, "The OnBulkInsert is not implemented."); @@ -1015,6 +1026,7 @@ namespace Tizen.Applications.DataControl /// /// Overrides this method if you want to handle the behavior when the map get request is received. /// + /// 3 protected virtual MapGetResult OnMapGet(string key) { Log.Info(LogTag, "The OnMapGet is not implemented."); @@ -1024,6 +1036,7 @@ namespace Tizen.Applications.DataControl /// /// Overrides this method if you want to handle the behavior when the map add request is received. /// + /// 3 protected virtual MapAddResult OnMapAdd(string key, string value) { Log.Info(LogTag, "The OnMapAdd is not implemented."); @@ -1033,6 +1046,7 @@ namespace Tizen.Applications.DataControl /// /// Overrides this method if you want to handle the behavior when the update request is received. /// + /// 3 protected virtual MapSetResult OnMapSet(string key, string oldValue, string newValue) { Log.Info(LogTag, "The OnMapSet is not implemented."); @@ -1042,6 +1056,7 @@ namespace Tizen.Applications.DataControl /// /// Overrides this method if you want to handle the behavior when the delete request is received. /// + /// 3 protected virtual MapRemoveResult OnMapRemove(string key, string value) { Log.Info(LogTag, "The OnMapRemove is not implemented."); @@ -1051,6 +1066,7 @@ namespace Tizen.Applications.DataControl /// /// Overrides this method if you want to handle the behavior when the bulk add request is received. /// + /// 3 protected virtual MapBulkAddResult OnMapBulkAdd(BulkData bulkAddData) { Log.Info(LogTag, "The OnMapBulkAdd is not implemented."); @@ -1060,6 +1076,7 @@ namespace Tizen.Applications.DataControl /// /// Overrides this method if you want to handle the behavior when the data change listen request is received. /// + /// 3 protected virtual DataChangeListenResult OnDataChangeListenRequest(string requestAppID) { Log.Info(LogTag, "The OnDataChangeListenRequest is not implemented."); @@ -1070,6 +1087,7 @@ namespace Tizen.Applications.DataControl /// Releases unmanaged resources used by the Provider class specifying whether to perform a normal dispose operation. /// /// true for a normal dispose operation; false to finalize the handle. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -1086,6 +1104,7 @@ namespace Tizen.Applications.DataControl /// /// Releases all the resources used by the Provider class. /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Results.cs b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Results.cs index f61c226..1f85448 100755 --- a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Results.cs +++ b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Results.cs @@ -21,11 +21,13 @@ namespace Tizen.Applications.DataControl /// /// This class contains the insert operation result. /// + /// 3 public class InsertResult { /// /// Gets the insert data's row ID. /// + /// 3 public long RowID { get; @@ -35,6 +37,7 @@ namespace Tizen.Applications.DataControl /// /// Gets the insert operation result. /// + /// 3 public bool Result { get; @@ -46,6 +49,7 @@ namespace Tizen.Applications.DataControl /// /// The inserted row ID. /// The insert request result. + /// 3 public InsertResult(long rowID, bool result) { RowID = rowID; @@ -56,11 +60,13 @@ namespace Tizen.Applications.DataControl /// /// This class contains the bulk insert operation result. /// + /// 3 public class BulkInsertResult { /// /// Gets the bulk insert operation result data. /// + /// 3 public BulkResultData BulkResultData { get; @@ -70,6 +76,7 @@ namespace Tizen.Applications.DataControl /// /// Gets the bulk insert operation result. /// + /// 3 public bool Result { get; @@ -82,6 +89,7 @@ namespace Tizen.Applications.DataControl /// The bulk insert request result data. /// The bulk insert request result. /// Thrown in case of an invalid parameter. + /// 3 public BulkInsertResult(BulkResultData bulkResultData, bool result) { if (result == true && (bulkResultData == null || bulkResultData.SafeBulkDataHandle.IsInvalid)) @@ -97,11 +105,13 @@ namespace Tizen.Applications.DataControl /// /// This class contains the update operation result. /// + /// 3 public class UpdateResult { /// /// Gets the update operation result. /// + /// 3 public bool Result { get; @@ -112,6 +122,7 @@ namespace Tizen.Applications.DataControl /// Initializes the UpdateResult class with the result. /// /// The update request result. + /// 3 public UpdateResult(bool result) { Result = result; @@ -121,11 +132,13 @@ namespace Tizen.Applications.DataControl /// /// This class contains the delete operation result. /// + /// 3 public class DeleteResult { /// /// Gets the delete operation result. /// + /// 3 public bool Result { get; @@ -136,6 +149,7 @@ namespace Tizen.Applications.DataControl /// Initializes the DeleteResult class with the result. /// /// The delete request result. + /// 3 public DeleteResult(bool result) { Result = result; @@ -145,11 +159,13 @@ namespace Tizen.Applications.DataControl /// /// This class contains the select operation result. /// + /// 3 public class SelectResult { /// /// Gets the select operation result cursor. /// + /// 3 public ICursor ResultCursor { get; @@ -158,6 +174,7 @@ namespace Tizen.Applications.DataControl /// /// Gets the select operation result. /// + /// 3 public bool Result { get; @@ -170,6 +187,7 @@ namespace Tizen.Applications.DataControl /// The cursor with the selected data. /// The select request result. /// Thrown in case of an invalid parameter. + /// 3 public SelectResult(ICursor cursor, bool result) { int i; @@ -208,12 +226,14 @@ namespace Tizen.Applications.DataControl /// /// This class contains the MapAdd operation result. /// + /// 3 public class MapAddResult { /// /// Gets the MapAdd operation result. /// + /// 3 public bool Result { get; @@ -224,6 +244,7 @@ namespace Tizen.Applications.DataControl /// Initializes the MapAddResult class with the result. /// /// The MapAdd request result. + /// 3 public MapAddResult(bool result) { Result = result; @@ -233,11 +254,13 @@ namespace Tizen.Applications.DataControl /// /// This class contains the MapBulkAdd operation result. /// + /// 3 public class MapBulkAddResult { /// /// Gets the MapBulkAdd operation result data. /// + /// 3 public BulkResultData BulkResultData { get; @@ -247,6 +270,7 @@ namespace Tizen.Applications.DataControl /// /// Gets the MapBulkAdd operation result. /// + /// 3 public bool Result { get; @@ -259,6 +283,7 @@ namespace Tizen.Applications.DataControl /// The MapBulkAdd request result data. /// The MapBulkAdd request result. /// Thrown in case of an invalid parameter. + /// 3 public MapBulkAddResult(BulkResultData bulkResultData, bool result) { if (result == true && (bulkResultData == null || bulkResultData.SafeBulkDataHandle.IsInvalid)) @@ -274,11 +299,13 @@ namespace Tizen.Applications.DataControl /// /// This class contains the MapSet operation result. /// + /// 3 public class MapSetResult { /// /// Gets the MapSet operation result. /// + /// 3 public bool Result { get; @@ -289,6 +316,7 @@ namespace Tizen.Applications.DataControl /// Initializes the MapSetResult class with the result. /// /// MapSet request result + /// 3 public MapSetResult(bool result) { Result = result; @@ -298,11 +326,13 @@ namespace Tizen.Applications.DataControl /// /// This class contains the MapRemove operation result. /// + /// 3 public class MapRemoveResult { /// /// Gets the MapRemove operation result. /// + /// 3 public bool Result { get; @@ -313,6 +343,7 @@ namespace Tizen.Applications.DataControl /// Initializes the MapRemoveResult class with the result. /// /// The MapRemove request result. + /// 3 public MapRemoveResult(bool result) { Result = result; @@ -322,11 +353,13 @@ namespace Tizen.Applications.DataControl /// /// This class contains the MapGet operation result. /// + /// 3 public class MapGetResult { /// /// Gets the result value list of the MapGet operation. /// + /// 3 public string[] ValueList { get; @@ -335,6 +368,7 @@ namespace Tizen.Applications.DataControl /// /// Gets the MapGet operation result. /// + /// 3 public bool Result { get; @@ -347,6 +381,7 @@ namespace Tizen.Applications.DataControl /// The MapGet request result data. /// The MapGet request result. /// Thrown in case of an invalid parameter. + /// 3 public MapGetResult(string[] valueLIst, bool result) { if (result == true && valueLIst == null) @@ -362,11 +397,13 @@ namespace Tizen.Applications.DataControl /// /// This class contains the DataChangeListen operation result. /// + /// 3 public class DataChangeListenResult { /// /// Gets the DataChangeListen operation result. /// + /// 3 public ResultType Result { get; @@ -377,6 +414,7 @@ namespace Tizen.Applications.DataControl /// Initializes the DataChangeListenResult class with the result. /// /// The DataChangeListen request result. + /// 3 public DataChangeListenResult(ResultType result) { Result = result; diff --git a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Types.cs b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Types.cs index 6b4749f..0aa88cb 100755 --- a/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Types.cs +++ b/src/Tizen.Applications.DataControl/Tizen.Applications.DataControl/Types.cs @@ -22,6 +22,7 @@ namespace Tizen.Applications.DataControl /// /// Enumeration for the DataControl column types. /// + /// 3 public enum ColumnType : short { /// @@ -45,6 +46,7 @@ namespace Tizen.Applications.DataControl /// /// Enumeration for the DataControl column types. /// + /// 3 public enum ChangeType : short { /// @@ -76,6 +78,7 @@ namespace Tizen.Applications.DataControl /// /// Enumeration for the DataControl result types. /// + /// 3 public enum ResultType : int { /// diff --git a/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessagePort.cs b/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessagePort.cs index 5050abe..8b72e57 100755 --- a/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessagePort.cs +++ b/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessagePort.cs @@ -28,6 +28,7 @@ namespace Tizen.Applications.Messages /// If a remote application sends a message, the registered callback function of the local port is called. /// The trusted message-port API allows communications between applications that are signed by the same developer(author) certificate. /// + /// 3 public class MessagePort : IDisposable { private static readonly object s_lock = new object(); @@ -58,6 +59,7 @@ namespace Tizen.Applications.Messages /// MessagePort messagePort = new MessagePort("SenderPort", true); /// /// + /// 3 public MessagePort(string portName, bool trusted) { if (String.IsNullOrEmpty(portName)) @@ -92,11 +94,13 @@ namespace Tizen.Applications.Messages /// } /// /// + /// 3 public event EventHandler MessageReceived; /// /// The name of the local message port. /// + /// 3 public string PortName { get @@ -107,6 +111,7 @@ namespace Tizen.Applications.Messages /// /// If true, the message port is a trusted port, otherwise false. /// + /// 3 public bool Trusted { get @@ -118,6 +123,7 @@ namespace Tizen.Applications.Messages /// /// If true, the message port is listening, otherwise false. /// + /// 3 public bool Listening { get @@ -139,6 +145,7 @@ namespace Tizen.Applications.Messages /// messagePort.Listen(); /// /// + /// 3 public void Listen() { lock (s_lock) @@ -197,6 +204,7 @@ namespace Tizen.Applications.Messages /// messagePort.StopListening(); /// /// + /// 3 public void StopListening() { if (!_listening) @@ -243,6 +251,7 @@ namespace Tizen.Applications.Messages /// } /// /// + /// 3 public void Send(Bundle message, string remoteAppId, string remotePortName) { Send(message, remoteAppId, remotePortName, false); @@ -272,6 +281,7 @@ namespace Tizen.Applications.Messages /// } /// /// + /// 3 public void Send(Bundle message, string remoteAppId, string remotePortName, bool trusted) { if (!_listening) @@ -300,6 +310,7 @@ namespace Tizen.Applications.Messages /// Releases the unmanaged resources used by the MessagePort class specifying whether to perform a normal dispose operation. /// /// true for a normal dispose operation; false to finalize the handle. + /// 3 protected virtual void Dispose(bool disposing) { if (_listening) @@ -318,6 +329,7 @@ namespace Tizen.Applications.Messages /// /// Releases all resources used by the MessagePort class. /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessageReceivedEventArgs.cs b/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessageReceivedEventArgs.cs index 1f4924b..5e2091a 100755 --- a/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessageReceivedEventArgs.cs +++ b/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/MessageReceivedEventArgs.cs @@ -20,16 +20,19 @@ namespace Tizen.Applications.Messages /// /// An extended EventArgs class, which contains remote message port information and message. /// + /// 3 public class MessageReceivedEventArgs : EventArgs { /// /// Contains AppId, port name, and trusted. /// + /// 3 public RemoteValues Remote { get; internal set; } /// /// The message passed from the remote application. /// + /// 3 public Bundle Message { get; internal set; } } } diff --git a/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemotePort.cs b/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemotePort.cs index c589638..5d79eba 100755 --- a/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemotePort.cs +++ b/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemotePort.cs @@ -285,6 +285,7 @@ namespace Tizen.Applications.Messages /// Releases the unmanaged resources used by the RemotePort class specifying whether to perform a normal dispose operation. /// /// true for a normal dispose operation; false to finalize the handle. + /// 4 protected virtual void Dispose(bool disposing) { if (_disposed) @@ -317,10 +318,12 @@ namespace Tizen.Applications.Messages /// /// Value representing Remote Port state is unregistered /// + /// 4 Unregistered = 0, /// /// Value representing Remote Port state is registered /// + /// 4 Registered = 1 } } diff --git a/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemoteValues.cs b/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemoteValues.cs index e1b4b3b..718a3b7 100755 --- a/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemoteValues.cs +++ b/src/Tizen.Applications.MessagePort/Tizen.Applications.Messages/RemoteValues.cs @@ -19,21 +19,25 @@ namespace Tizen.Applications.Messages /// /// Contains AppId, port name, and trusted. /// + /// 3 public class RemoteValues { /// /// The ID of the remote application that sent this message. /// + /// 3 public string AppId { get; set; } /// /// The name of the remote message port. /// + /// 3 public string PortName { get; set; } /// /// If true, the remote port is a trusted port, otherwise, if false, it is not. /// + /// 3 public bool Trusted { get; set; } } } diff --git a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/Notification.cs b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/Notification.cs index 8c12f40..b4ec769 100755 --- a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/Notification.cs +++ b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/Notification.cs @@ -42,6 +42,7 @@ namespace Tizen.Applications.Notifications /// /// Initializes a new instance of the class. /// + /// 3 public Notification() { styleDictionary = new Dictionary(); @@ -51,17 +52,20 @@ namespace Tizen.Applications.Notifications /// /// Gets or sets the tag of notification. /// + /// 3 public string Tag { get; set; } = string.Empty; /// /// Gets or sets the title of notification. /// + /// 3 public string Title { get; set; } = string.Empty; /// /// Gets or sets the icon of notification. /// You should set an absolute path for an image file. /// + /// 3 public string Icon { get; set; } = string.Empty; /// @@ -69,17 +73,20 @@ namespace Tizen.Applications.Notifications /// This SubIcon is displayed in Icon you set. /// You should set an absolute path for an image file. /// + /// 3 public string SubIcon { get; set; } = string.Empty; /// /// Gets or sets the content of notification. /// + /// 3 public string Content { get; set; } = string.Empty; /// /// Gets or sets a value indicating whether TimeStamp of the notification is Visible or not. /// Default to true. /// + /// 3 public bool IsTimeStampVisible { get; set; } = true; /// @@ -90,6 +97,7 @@ namespace Tizen.Applications.Notifications /// TimeStamp requires NotificationManager.Post() to be called. /// If you set IsVisibleTimeStamp property to false, TimeStamp is not visible in notification. /// + /// 3 public DateTime TimeStamp { get; set; } /// @@ -99,6 +107,7 @@ namespace Tizen.Applications.Notifications /// If you set it to null, the already set AppControl will be removed and nothing will happen when you click on notification. /// /// + /// 3 public AppControl Action { get; set; } /// @@ -109,6 +118,7 @@ namespace Tizen.Applications.Notifications /// If you set count to negative number, this property throws exception. /// /// Thrown when argument is invalid. + /// 3 public int Count { get @@ -132,6 +142,7 @@ namespace Tizen.Applications.Notifications /// Gets or sets a value indicating whether the notification is Onging or not. /// Default value is false. /// + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] public bool IsOngoing { get; set; } = false; @@ -139,12 +150,14 @@ namespace Tizen.Applications.Notifications /// Gets or sets property. /// /// + /// 3 public NotificationProperty Property { get; set; } = NotificationProperty.None; /// /// Gets or sets object for display at notification. /// /// + /// 3 public ProgressType Progress { get; set; } /// @@ -179,12 +192,14 @@ namespace Tizen.Applications.Notifications /// NotificationManager.Post(notification); /// /// + /// 3 public AccessorySet Accessory { get; set; } /// /// Gets or sets a value indicating whether notification is displayed on the default viewer. /// If you set false and add style, you can see only style notification. /// + /// 4 public bool IsVisible { get; set; } = true; /// @@ -244,6 +259,7 @@ namespace Tizen.Applications.Notifications /// NotificationManager.Post(notification); /// /// + /// 3 public void AddStyle(StyleBase style) { if (style == null) @@ -268,6 +284,7 @@ namespace Tizen.Applications.Notifications /// /// Type of notification style to be queried. /// Thrown when argument is invalid. + /// 3 public void RemoveStyle() where T : Notification.StyleBase, new() { T type = new T(); @@ -291,6 +308,7 @@ namespace Tizen.Applications.Notifications /// The Notification.Style object associated with the given style. /// /// Thrown when argument is invalid. + /// 3 public T GetStyle() where T : Notification.StyleBase, new() { T type = new T(); @@ -333,6 +351,7 @@ namespace Tizen.Applications.Notifications /// notification.SetExtraData("firstKey", bundle); /// /// + /// 4 public void SetExtraData(string key, Bundle value) { if (value == null || value.SafeBundleHandle.IsInvalid || string.IsNullOrEmpty(key)) @@ -360,6 +379,7 @@ namespace Tizen.Applications.Notifications /// /// The key of the extra data to add. /// Thrown when argument is invalid. + /// 4 public void RemoveExtraData(string key) { if (string.IsNullOrEmpty(key)) @@ -383,6 +403,7 @@ namespace Tizen.Applications.Notifications /// The key of the extra data to get. /// Bundle Object that include extra data /// Thrown when argument is invalid. + /// 4 public Bundle GetExtraData(string key) { if (string.IsNullOrEmpty(key)) @@ -402,6 +423,7 @@ namespace Tizen.Applications.Notifications /// /// Releases any unmanaged resources used by this object. /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationAccessorySet.cs b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationAccessorySet.cs index ef94ada..4f88d5d 100755 --- a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationAccessorySet.cs +++ b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationAccessorySet.cs @@ -31,6 +31,7 @@ namespace Tizen.Applications.Notifications /// /// Class for notification AccessorySet, which includes vibration, LED, and sound option. /// + /// 3 public sealed class AccessorySet : MakerBase { /// @@ -39,17 +40,20 @@ namespace Tizen.Applications.Notifications /// /// If you set AccessoryOption.Custom, you must the SoundPath. Otherwise, an exception is thrown. /// + /// 3 public AccessoryOption SoundOption { get; set; } = AccessoryOption.Off; /// /// Gets or sets the sound path, It will play on the sound file you set. /// You should set an absolute path for a sound file. /// + /// 3 public string SoundPath { get; set; } /// /// Gets or sets a value indicating whether vibration is operated. Default is false. /// + /// 3 public bool CanVibrate { get; set; } = false; /// @@ -58,6 +62,7 @@ namespace Tizen.Applications.Notifications /// /// If you set AccessoryOption.Custom and not set LedColor, the LED will show default color. /// + /// 3 public AccessoryOption LedOption { get; set; } = AccessoryOption.Off; /// @@ -68,6 +73,7 @@ namespace Tizen.Applications.Notifications /// The rate is specified in terms of the number of Milliseconds to be on. /// You must set the on and off times at the same time. Otherwise, it may not operate normally. /// + /// 3 public int LedOnMillisecond { get; set; } /// @@ -77,6 +83,7 @@ namespace Tizen.Applications.Notifications /// The rate is specified in terms of the number of Milliseconds to be off. /// You must set the on and off times at the same time. Otherwise, it may not operate normally. /// + /// 3 public int LedOffMillisecond { get; set; } /// @@ -85,6 +92,7 @@ namespace Tizen.Applications.Notifications /// /// If you want to set LedColor, you should always set LedOption as AccessoryOption.Custom, otherwise, it may operate default LED color. /// + /// 3 public Color LedColor { get; set; } internal override void Make(Notification notification) diff --git a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationActiveStyle.cs b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationActiveStyle.cs index 841eb63..20fb995 100644 --- a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationActiveStyle.cs +++ b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationActiveStyle.cs @@ -27,11 +27,13 @@ namespace Tizen.Applications.Notifications /// It is created to notify information to the user through the application. /// This class helps you to provide method and property for creating notification object. /// + /// 3 public sealed partial class Notification { /// /// Class for generating active style notification. /// + /// 3 public sealed class ActiveStyle : StyleBase { private IDictionary buttonDictionary; @@ -41,6 +43,7 @@ namespace Tizen.Applications.Notifications /// /// Initializes a new instance of the class. /// + /// 3 public ActiveStyle() { buttonDictionary = new Dictionary(); @@ -49,6 +52,7 @@ namespace Tizen.Applications.Notifications /// /// Gets or sets an absolute path for an image file to display on the background of active notification. /// + /// 3 public string BackgroundImage { get; set; } /// @@ -59,6 +63,7 @@ namespace Tizen.Applications.Notifications /// When 'IsAutoRemove' is set as false, the active notification will not be removed as long as the user removes /// it or the application, which posted the active notification. /// > + /// 3 public bool IsAutoRemove { get; set; } = true; /// @@ -68,6 +73,7 @@ namespace Tizen.Applications.Notifications /// The default button for display highlight is only reflected on the Tizen TV. /// If you use this property on other profile, this value has no effect. /// + /// 3 public ButtonIndex DefaultButton { get; set; } = ButtonIndex.None; /// @@ -110,6 +116,7 @@ namespace Tizen.Applications.Notifications /// active.AddButtonAction(button); /// /// + /// 3 public ReplyAction ReplyAction { get; set; } /// @@ -121,6 +128,7 @@ namespace Tizen.Applications.Notifications /// If you use this API on other profile, this action have no effect /// /// + /// 4 public AppControl HiddenByUserAction { get; set; } /// @@ -133,6 +141,7 @@ namespace Tizen.Applications.Notifications /// If you use this API on other profile, this action settings have no effect /// /// + /// 4 public AppControl HiddenByTimeoutAction { get; set; } /// @@ -144,6 +153,7 @@ namespace Tizen.Applications.Notifications /// If you use this API on other profile, this action settings have no effect /// /// + /// 4 public AppControl HiddenByExternalAction { get; set; } /// @@ -167,6 +177,7 @@ namespace Tizen.Applications.Notifications /// The value in seconds when the notification can be hidden from the notification viewer after the notification is posted. /// The value in seconds when the notification can be deleted from the notification list in setting application after notification is posted. /// Thrown when argument is invalid. + /// 3 public void SetRemoveTime(int hideTime, int deleteTime) { if (hideTime < 0 || deleteTime < 0) @@ -183,6 +194,7 @@ namespace Tizen.Applications.Notifications /// /// The value in seconds when the notification can be hidden from the notification viewer after notification is posted. /// The value in seconds when the notification can be deleted from the notification list in setting application after notification is posted. + /// 3 public void GetRemoveTime(out int hideTime, out int deleteTime) { hideTime = hideTimeout; @@ -219,6 +231,7 @@ namespace Tizen.Applications.Notifications /// /// /// + /// 3 public void AddButtonAction(ButtonAction button) { if (button == null) @@ -247,6 +260,7 @@ namespace Tizen.Applications.Notifications /// /// The index to remove a button. /// true if the element is successfully found and removed; otherwise, false. + /// 3 public bool RemoveButtonAction(ButtonIndex index) { bool ret = buttonDictionary.Remove(index); @@ -269,6 +283,7 @@ namespace Tizen.Applications.Notifications /// The index to get a button you already added. /// The ButtonAction object, which you already added. /// Thrown when an argument is invalid. + /// 3 public ButtonAction GetButtonAction(ButtonIndex index) { ButtonAction button = null; diff --git a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationButtonAction.cs b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationButtonAction.cs index 1c87041..e02d4a7 100755 --- a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationButtonAction.cs +++ b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationButtonAction.cs @@ -32,22 +32,26 @@ namespace Tizen.Applications.Notifications /// /// It must include a text, an index, an ImagePath, and an action to be invoked when the user selects the button. /// > + /// 3 public sealed class ButtonAction : MakerBase { /// /// Gets or sets the index of the button, which appeares as notification. /// + /// 3 public ButtonIndex Index { get; set; } = ButtonIndex.None; /// /// Gets or sets the text describing the button. /// + /// 3 public string Text { get; set; } /// /// Gets or sets the image path that represents the button. /// You should provide an absolute path for an image file. /// + /// 3 public string ImagePath { get; set; } /// @@ -68,6 +72,7 @@ namespace Tizen.Applications.Notifications /// /// /// + /// 3 public AppControl Action { get; set; } internal override void Make(Notification notification) diff --git a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationEnumerations.cs b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationEnumerations.cs index 877eba3..d014d06 100755 --- a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationEnumerations.cs +++ b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationEnumerations.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications.Notifications /// /// Enumeration for the progress category. /// + /// 3 public enum ProgressCategory { /// @@ -42,6 +43,7 @@ namespace Tizen.Applications.Notifications /// /// Enumeration for the accessory option. /// + /// 3 public enum AccessoryOption { /// @@ -63,6 +65,7 @@ namespace Tizen.Applications.Notifications /// /// Enumeration for the button index. /// + /// 3 public enum ButtonIndex { /// @@ -89,6 +92,7 @@ namespace Tizen.Applications.Notifications /// /// Enumeration for the notification particular property. /// + /// 3 [Flags] public enum NotificationProperty { @@ -100,6 +104,7 @@ namespace Tizen.Applications.Notifications /// /// Value for display only SIM card inserted. /// + /// 4 DisplayOnlySimMode = 0x01, /// @@ -121,6 +126,7 @@ namespace Tizen.Applications.Notifications /// /// Enumeration for the block state. /// + /// 3 public enum NotificationBlockState { /// diff --git a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationIndicatorStyle.cs b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationIndicatorStyle.cs index 110fbe9..32cc61c 100755 --- a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationIndicatorStyle.cs +++ b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationIndicatorStyle.cs @@ -29,17 +29,20 @@ namespace Tizen.Applications.Notifications /// /// Class for generating indicator style notification. /// + /// 3 public sealed class IndicatorStyle : StyleBase { /// /// Gets or sets an absolute path for an image file. /// If you set IconPath, you can see the icon on the right side of indicator. /// + /// 3 public string IconPath { get; set; } /// /// Gets or sets a sub text for displaying indicator style. /// + /// 3 public string SubText { get; set; } /// diff --git a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationLockStyle.cs b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationLockStyle.cs index 12fcd6a..e910c92 100755 --- a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationLockStyle.cs +++ b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationLockStyle.cs @@ -29,16 +29,19 @@ namespace Tizen.Applications.Notifications /// /// Class for generating lock style notification. /// + /// 3 public sealed class LockStyle : StyleBase { /// /// Gets or sets an absolute path for an image file to display the icon of lock style. /// + /// 3 public string IconPath { get; set; } /// /// Gets or sets an absolute path for a thumbnail image file to display on lock style. /// + /// 3 public string ThumbnailPath { get; set; } /// diff --git a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationMakerBase.cs b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationMakerBase.cs index 5b450b7..93ea7e7 100755 --- a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationMakerBase.cs +++ b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationMakerBase.cs @@ -31,6 +31,7 @@ namespace Tizen.Applications.Notifications /// /// An object that helps notification to make to SafeHandle. /// + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] public abstract class MakerBase { diff --git a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationManager.cs b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationManager.cs index 59e5711..5ef8dd1 100755 --- a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationManager.cs +++ b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationManager.cs @@ -22,6 +22,7 @@ namespace Tizen.Applications.Notifications /// /// NotificationManager class to post, update, delete, and get notification. /// + /// 3 public static class NotificationManager { /// @@ -54,6 +55,7 @@ namespace Tizen.Applications.Notifications /// /// /// http://tizen.org/privilege/notification + /// 3 public static void Post(Notification notification) { if (notification == null) @@ -132,6 +134,7 @@ namespace Tizen.Applications.Notifications ///
         /// Post method should be called on the notification object.
         /// 
+ /// 3 public static void Update(Notification notification) { if (notification == null || notification.Handle == null || notification.Handle.IsInvalid) @@ -174,6 +177,7 @@ namespace Tizen.Applications.Notifications ///
         /// Post method should be called on the notification object.
         /// 
+ /// 3 public static void Delete(Notification notification) { if (notification == null || notification.Handle == null || notification.Handle.IsInvalid) @@ -216,6 +220,7 @@ namespace Tizen.Applications.Notifications /// /// /// http://tizen.org/privilege/notification + /// 3 public static void DeleteAll() { NotificationError ret; @@ -262,6 +267,7 @@ namespace Tizen.Applications.Notifications /// /// /// http://tizen.org/privilege/notification + /// 3 public static Notification Load(string tag) { IntPtr ptr = IntPtr.Zero; @@ -335,6 +341,7 @@ namespace Tizen.Applications.Notifications /// /// /// http://tizen.org/privilege/notification + /// 3 public static void SaveTemplate(Notification notification, string name) { if (notification == null || string.IsNullOrEmpty(name)) @@ -392,6 +399,7 @@ namespace Tizen.Applications.Notifications /// /// /// http://tizen.org/privilege/notification + /// 3 public static Notification LoadTemplate(string name) { IntPtr handle = IntPtr.Zero; @@ -436,6 +444,7 @@ namespace Tizen.Applications.Notifications /// Thrown in case of a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/notification + /// 3 public static NotificationBlockState GetBlockState() { NotificationBlockState state; @@ -457,6 +466,7 @@ namespace Tizen.Applications.Notifications /// The Notification class. /// The NotificationSafeHandle class. /// Thrown when an argument is invalid. + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] public static NotificationSafeHandle MakeNotificationSafeHandle(Notification notification) { @@ -476,6 +486,7 @@ namespace Tizen.Applications.Notifications /// The NotificationSafeHandle class. /// The Notification class. /// Thrown when an argument is invalid. + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] public static Notification MakeNotification(NotificationSafeHandle handle) { diff --git a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationProgress.cs b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationProgress.cs index e41724a..d73925f 100644 --- a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationProgress.cs +++ b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationProgress.cs @@ -32,6 +32,7 @@ namespace Tizen.Applications.Notifications /// Class for displaying progress notification. /// You must initialize progress category, current, and max value when you create an object. ///
+ /// 3 public sealed class ProgressType : MakerBase { private double progressCurrent; @@ -45,6 +46,7 @@ namespace Tizen.Applications.Notifications /// The current value of the progress. /// The max value of the progress. /// Thrown when an argument is invalid. + /// 3 public ProgressType(ProgressCategory category, double current, double max) { if (IsNegativeNumber(current)) @@ -66,12 +68,14 @@ namespace Tizen.Applications.Notifications /// Gets or sets category of ProgressType. ///
/// + /// 3 public ProgressCategory Category { get; set; } /// /// Gets or sets current value of ProgressType. /// /// Thrown when argument is invalid. + /// 3 public double ProgressCurrent { get @@ -94,6 +98,7 @@ namespace Tizen.Applications.Notifications /// Gets or sets max value of ProgressType. ///
/// Thrown when argument is invalid. + /// 3 public double ProgressMax { get diff --git a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationReplyAction.cs b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationReplyAction.cs index c530d78..42d34ff 100755 --- a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationReplyAction.cs +++ b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationReplyAction.cs @@ -30,6 +30,7 @@ namespace Tizen.Applications.Notifications /// Class for displaying direct-reply on notification. /// You must set a ReplyMax and Button. Otherwise, user can't send written text to application which is set by AppControl. ///
+ /// 3 public sealed class ReplyAction : MakerBase { /// @@ -37,12 +38,14 @@ namespace Tizen.Applications.Notifications /// If you set ParentIndex, ReplyAction is displayed when button matches with ParentIndex that is clicked by the user. /// If you don't set ParentIndex, it appears as notification directly. /// + /// 3 public ButtonIndex ParentIndex { get; set; } = ButtonIndex.None; /// /// Gets or sets the PlaceHolderText of ReplyAction which appears at notification. /// If you set PlaceHolderText, it is displayed to placeholder in notification. /// + /// 3 public string PlaceHolderText { get; set; } /// @@ -52,6 +55,7 @@ namespace Tizen.Applications.Notifications /// /// Default value is 160. /// + /// 3 public int ReplyMax { get; set; } = 160; /// @@ -77,6 +81,7 @@ namespace Tizen.Applications.Notifications /// }; /// /// + /// 3 public ButtonAction Button { get; set; } internal override void Make(Notification notification) diff --git a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationSafeHandle.cs b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationSafeHandle.cs index deb503d..b71b282 100755 --- a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationSafeHandle.cs +++ b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationSafeHandle.cs @@ -23,12 +23,14 @@ namespace Tizen.Applications.Notifications /// /// This class manages the notification handle resources. /// + /// 4 [EditorBrowsable(EditorBrowsableState.Never)] public sealed class NotificationSafeHandle : SafeHandle { /// /// Initializes a new instance of the NotificationSafeHandle class. /// + /// 4 [EditorBrowsable(EditorBrowsableState.Never)] public NotificationSafeHandle() : base(IntPtr.Zero, true) @@ -43,6 +45,7 @@ namespace Tizen.Applications.Notifications /// /// Gets a value that indicates whether the handle is invalid. /// + /// 4 [EditorBrowsable(EditorBrowsableState.Never)] public override bool IsInvalid { diff --git a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationStyle.cs b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationStyle.cs index a7dda89..3648403 100755 --- a/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationStyle.cs +++ b/src/Tizen.Applications.Notification/Tizen.Applications.Notifications/NotificationStyle.cs @@ -30,6 +30,7 @@ namespace Tizen.Applications.Notifications /// An object can apply a rich notification style to a notification object. /// If the platform does not provide rich notification, styles in this class have no effect. /// + /// 3 public abstract class StyleBase : MakerBase { internal abstract string Key { get; } diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgs.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgs.cs index 0f26d6c..9d424f2 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgs.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationDeleteEventArgs.cs @@ -20,11 +20,13 @@ namespace Tizen.Applications.NotificationEventListener /// /// This class provides the property to get information about the deleted notification. /// + /// 4 public class NotificationDeleteEventArgs : EventArgs { /// /// Gets the unique number of the notification. /// + /// 4 public int UniqueNumber { get; internal set; } } } diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgs.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgs.cs index 88221b3..521e19d 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgs.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgs.cs @@ -34,6 +34,7 @@ namespace Tizen.Applications.NotificationEventListener /// /// Initializes a new instance of the class. /// + /// 4 public NotificationEventArgs() { Style = new Dictionary(); @@ -43,36 +44,43 @@ namespace Tizen.Applications.NotificationEventListener /// /// Gets the unique ID of the notification. /// + /// 4 public int UniqueNumber { get; internal set; } /// /// Gets the appId of the notification. /// + /// 4 public string AppID { get; internal set; } /// /// Gets the title of the notification. /// + /// 4 public string Title { get; internal set; } /// /// Gets the content text of the notification. /// + /// 4 public string Content { get; internal set; } /// /// Gets the icon's path of the notification. /// + /// 4 public string Icon { get; internal set; } /// /// Gets the sub icon path of the notification. /// + /// 4 public string SubIcon { get; internal set; } /// /// Gets the timestamp if the notification is visible or not. /// + /// 4 public bool IsTimeStampVisible { get; internal set; } /// @@ -81,21 +89,25 @@ namespace Tizen.Applications.NotificationEventListener /// /// If IsTimeStampVisible property is set false, this TimeStamp property is meaningless. /// + /// 4 public DateTime TimeStamp { get; internal set; } /// /// Gets the count, which is displayed at the right side of notification. /// + /// 4 public int Count { get; internal set; } /// /// Gets the tag of notification. /// + /// 4 public string Tag { get; internal set; } /// /// Gets a value indicating whether the notification is Onging or not. /// + /// 4 [EditorBrowsable(EditorBrowsableState.Never)] public bool IsOngoing { get; internal set; } = false; @@ -103,33 +115,39 @@ namespace Tizen.Applications.NotificationEventListener /// Gets a value that determines whether notification is displayed on the default viewer. /// If IsDisplay property is set as false and add style, you can see only style notification. /// + /// 4 public bool IsVisible { get; internal set; } = true; /// /// Gets the event flag. /// If this flag is true, you can do SendEvent. /// + /// 4 [EditorBrowsable(EditorBrowsableState.Never)] public bool HasEventFlag { get; internal set; } = false; /// /// Gets the AppControl, which is invoked when notification is clicked. /// + /// 4 public AppControl Action { get; internal set; } /// /// Gets the object of the progress notification. /// + /// 4 public ProgressArgs Progress { get; internal set; } /// /// Gets the AccessoryArgs, which has option of sound, vibration, and LED. /// + /// 4 public AccessoryArgs Accessory { get; internal set; } /// /// Gets the key for extra data. /// + /// 4 public ICollection ExtraDataKey { get @@ -141,6 +159,7 @@ namespace Tizen.Applications.NotificationEventListener /// /// Gets the property. /// + /// 4 public NotificationProperty Property { get; internal set; } /// @@ -149,6 +168,7 @@ namespace Tizen.Applications.NotificationEventListener /// Type of notification style to be queried. /// The NotificationEventListener.StyleArgs object associated with the given style. /// Thrown when an argument is invalid. + /// 4 public T GetStyle() where T : StyleArgs, new() { T type = new T(); @@ -172,6 +192,7 @@ namespace Tizen.Applications.NotificationEventListener /// /// The key that specifies which extra data. /// Returns the bundle for key. + /// 4 public Bundle GetExtraData(string key) { Bundle bundle; diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsAccessory.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsAccessory.cs index 75c1d97..d97b691 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsAccessory.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsAccessory.cs @@ -26,26 +26,31 @@ namespace Tizen.Applications.NotificationEventListener /// /// Class to get infomation about notification accessory. /// + /// 4 public class AccessoryArgs { /// /// Gets the sound option. /// + /// 4 public AccessoryOption SoundOption { get; internal set; } /// /// Gets the sound path. /// + /// 4 public string SoundPath { get; internal set; } /// /// Gets the vibration option. /// + /// 4 public bool CanVibrate { get; internal set; } /// /// Gets the LED option. /// + /// 4 public AccessoryOption LedOption { get; internal set; } /// @@ -55,6 +60,7 @@ namespace Tizen.Applications.NotificationEventListener /// Default value of LedOnMilliseconds is 0. /// The rate is specified in terms of the number of milliseconds to be on. /// + /// 4 public int LedOnMillisecond { get; internal set; } /// @@ -64,11 +70,13 @@ namespace Tizen.Applications.NotificationEventListener /// Default value of LedOffMillisecond is 0. /// The rate is specified in terms of the number of millisecond to be off. /// + /// 4 public int LedOffMillisecond { get; internal set; } /// /// Gets LED color that you would like the LED on the device to blink. /// + /// 4 public Color LedColor { get; internal set; } } } diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsActiveStyle.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsActiveStyle.cs index 1618826..2186b7b 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsActiveStyle.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsActiveStyle.cs @@ -26,11 +26,13 @@ namespace Tizen.Applications.NotificationEventListener /// /// Class to get infomation about notification active style. /// + /// 4 public class ActiveStyleArgs : StyleArgs { /// /// Initializes a new instance of the class. /// + /// 4 public ActiveStyleArgs() { Button = new List(); @@ -44,26 +46,31 @@ namespace Tizen.Applications.NotificationEventListener /// When 'IsAutoRemove' is set as false, the active notification will not be removed as long as the user removes /// the active notification, or the app which posted the active notification removes the active notification. /// + /// 4 public bool IsAutoRemove { get; internal set; } /// /// Gets an absolute path for an image file to display on the background of active notification. /// + /// 4 public string BackgroundImage { get; internal set; } /// /// Gets the default button to display highlight on the active notification. /// + /// 4 public ButtonIndex DefaultButton { get; internal set; } /// /// Gets timeout value in seconds when the notification can be hidden from the viewer. /// + /// 4 public int HideTimeout { get; internal set; } /// /// Gets timeout value in seconds when the notification can be deleted from the viewer. /// + /// 4 public int DeleteTimeout { get; internal set; } /// @@ -73,6 +80,7 @@ namespace Tizen.Applications.NotificationEventListener /// The property is only reflected on Tizen TV. /// If you use this API on other profile, this action have no effect /// + /// 4 public AppControl HiddenByUserAction { get; internal set; } /// @@ -82,6 +90,7 @@ namespace Tizen.Applications.NotificationEventListener /// The property is only reflected on Tizen TV. /// If you use this API on other profile, this action settings have no effect /// + /// 4 public AppControl HiddenByTimeoutAction { get; internal set; } /// @@ -90,17 +99,20 @@ namespace Tizen.Applications.NotificationEventListener /// /// If you use this API on other profile, this action settings have no effect /// + /// 4 public AppControl HiddenByExternalAction { get; internal set; } /// /// Gets a button to this active notification style. /// Buttons are displayed in the notification content. /// + /// 4 public IList Button { get; internal set; } /// /// Gets a ReplyAction to this active notification style. /// + /// 4 public ReplyActionArgs Reply { get; internal set; } internal override string Key diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsButtonAction.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsButtonAction.cs index bbc5289..62bc6fe 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsButtonAction.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsButtonAction.cs @@ -24,26 +24,31 @@ namespace Tizen.Applications.NotificationEventListener /// /// Class to get infomation about notification ButtonAction. /// + /// 4 public class ButtonActionArgs { /// /// Gets the index of the button, which appears at notification. /// + /// 4 public ButtonIndex Index { get; internal set; } /// /// Gets the text that describes the button. /// + /// 4 public string Text { get; internal set; } /// /// Gets the image's path that represents the button. /// + /// 4 public string ImagePath { get; internal set; } /// /// Gets the AppControl that is invoked when the button is clicked. /// + /// 4 public AppControl Action { get; internal set; } } } diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsEnumerations.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsEnumerations.cs index 134479f..7ed4c3c 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsEnumerations.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsEnumerations.cs @@ -22,6 +22,7 @@ namespace Tizen.Applications.NotificationEventListener /// /// Enumeration for the progress category. /// + /// 4 public enum ProgressCategory { /// @@ -43,6 +44,7 @@ namespace Tizen.Applications.NotificationEventListener /// /// Enumeration for the accessory option. /// + /// 4 public enum AccessoryOption { /// @@ -64,6 +66,7 @@ namespace Tizen.Applications.NotificationEventListener /// /// Enumeration for the button index. /// + /// 4 public enum ButtonIndex { /// @@ -90,6 +93,7 @@ namespace Tizen.Applications.NotificationEventListener /// /// Enumeration for the notification particular property. /// + /// 4 [Flags] public enum NotificationProperty { @@ -122,6 +126,7 @@ namespace Tizen.Applications.NotificationEventListener /// /// Enumeration for event type on notification. /// + /// 4 [EditorBrowsable(EditorBrowsableState.Never)] public enum UserEventType { diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsIndicatorStyle.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsIndicatorStyle.cs index 32ad1f5..5c5aad4 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsIndicatorStyle.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsIndicatorStyle.cs @@ -24,16 +24,19 @@ namespace Tizen.Applications.NotificationEventListener /// /// Class to generate the indicator style notification. /// + /// 4 public class IndicatorStyleArgs : StyleArgs { /// /// Gets the path of the image file to display on the icon of indicator style. /// + /// 4 public string IconPath { get; internal set; } /// /// Gets the sub text to display indicator style. /// + /// 4 public string SubText { get; internal set; } internal override string Key diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsLockStyle.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsLockStyle.cs index 3a24f18..510fd2c 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsLockStyle.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsLockStyle.cs @@ -19,21 +19,25 @@ namespace Tizen.Applications.NotificationEventListener /// /// This class provides methods and properties to get information about the posted or updated notification. /// + /// 4 public partial class NotificationEventArgs { /// /// Class to get infomation about notification lock style. /// + /// 4 public class LockStyleArgs : StyleArgs { /// /// Gets the path of the image file to display on the icon of lock style. /// + /// 4 public string IconPath { get; internal set; } /// /// Gets the path of the thumbnail image file to display on the icon of lock style. /// + /// 4 public string Thumbnail { get; internal set; } internal override string Key diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsProgress.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsProgress.cs index 069d4e8..057d1d6 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsProgress.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsProgress.cs @@ -24,21 +24,25 @@ namespace Tizen.Applications.NotificationEventListener /// /// Class to get infomation about progress notification. /// + /// 4 public class ProgressArgs { /// /// Gets category of ProgressType. /// + /// 4 public ProgressCategory Category { get; internal set; } /// /// Gets current value of ProgressType. /// + /// 4 public double Current { get; internal set; } /// /// Gets max value of ProgressType. /// + /// 4 public double Max { get; internal set; } } } diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsReplyAction.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsReplyAction.cs index 426f496..6ffb123 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsReplyAction.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsReplyAction.cs @@ -24,28 +24,33 @@ namespace Tizen.Applications.NotificationEventListener /// /// Class to get infomation about notification ReplyAction. /// + /// 4 public class ReplyActionArgs { /// /// Gets index of button, which appears at notification. /// If there is no ParentIndex, the ReplyAction should be displayed directly on the active notification. /// + /// 4 public ButtonIndex ParentIndex { get; internal set; } = ButtonIndex.None; /// /// Gets the PlaceHolderText of ReplyAction, which appears at notification. /// It will be displayed to the text input box on the active notification. /// + /// 4 public string PlaceHolderText { get; internal set; } /// /// Gets a max length of text input. /// + /// 4 public int ReplyMax { get; internal set; } /// /// Gets the button displayed in the replyaction. /// + /// 4 public ButtonActionArgs Button { get; internal set; } } } diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsStyle.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsStyle.cs index 9438f81..9d01d91 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsStyle.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationEventArgsStyle.cs @@ -24,6 +24,7 @@ namespace Tizen.Applications.NotificationEventListener /// /// An object can get a rich notification style to a notification object. /// + /// 4 public abstract class StyleArgs { internal abstract string Key { get; } diff --git a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationListenerManager.cs b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationListenerManager.cs index f2c0517..89a3f4b 100755 --- a/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationListenerManager.cs +++ b/src/Tizen.Applications.NotificationEventListener/Tizen.Applications.NotificationEventListener/NotificationListenerManager.cs @@ -27,6 +27,7 @@ namespace Tizen.Applications.NotificationEventListener /// /// The event listener can use this class to get a list of notifications or to clear notifications. /// + /// 4 public partial class NotificationListenerManager { private const string LogTag = "Tizen.Applications.NotificationEventListener"; @@ -67,6 +68,7 @@ namespace Tizen.Applications.NotificationEventListener /// Thrown in case of a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/notification + /// 4 public static event EventHandler Added { add @@ -113,6 +115,7 @@ namespace Tizen.Applications.NotificationEventListener /// Thrown in case of a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/notification + /// 4 public static event EventHandler Updated { add @@ -159,6 +162,7 @@ namespace Tizen.Applications.NotificationEventListener /// Thrown in case of a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/notification + /// 4 public static event EventHandler Deleted { add @@ -294,6 +298,7 @@ namespace Tizen.Applications.NotificationEventListener /// Thrown in case of a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/notification + /// 4 public static void Delete(string appId, int uniqueNumber) { Interop.NotificationEventListener.ErrorCode err; @@ -316,6 +321,7 @@ namespace Tizen.Applications.NotificationEventListener /// Thrown in case of a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/notification + /// 4 public static void DeleteAll() { Interop.NotificationEventListener.ErrorCode err; @@ -339,6 +345,7 @@ namespace Tizen.Applications.NotificationEventListener /// Thrown in case of a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/notification + /// 4 public static IList GetList() { Interop.NotificationEventListener.ErrorCode err; @@ -411,6 +418,7 @@ namespace Tizen.Applications.NotificationEventListener /// Thrown in case of a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/notification + /// 4 [EditorBrowsable(EditorBrowsableState.Never)] public static void SendEvent(int uniqueNumber, UserEventType type) { @@ -431,6 +439,7 @@ namespace Tizen.Applications.NotificationEventListener /// Thrown in case of a permission is denied. /// Thrown in case of any internal error. /// http://tizen.org/privilege/notification + /// 4 [EditorBrowsable(EditorBrowsableState.Never)] public static NotificationEventArgs GetNotificationEventArgs(int uniqueNumber) { diff --git a/src/Tizen.Applications.PackageManager/Tizen.Applications/CertCompareResultType.cs b/src/Tizen.Applications.PackageManager/Tizen.Applications/CertCompareResultType.cs index a702091..a0aab99 100644 --- a/src/Tizen.Applications.PackageManager/Tizen.Applications/CertCompareResultType.cs +++ b/src/Tizen.Applications.PackageManager/Tizen.Applications/CertCompareResultType.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// Enumeration for the certificate compare result type. /// + /// 3 public enum CertCompareResultType { /// diff --git a/src/Tizen.Applications.PackageManager/Tizen.Applications/CertificateType.cs b/src/Tizen.Applications.PackageManager/Tizen.Applications/CertificateType.cs index 912fca1..a4137ed 100755 --- a/src/Tizen.Applications.PackageManager/Tizen.Applications/CertificateType.cs +++ b/src/Tizen.Applications.PackageManager/Tizen.Applications/CertificateType.cs @@ -19,6 +19,7 @@ namespace Tizen.Applications /// /// Enumeration for the certification types. /// + /// 3 public enum CertificateType { /// diff --git a/src/Tizen.Applications.PackageManager/Tizen.Applications/InstallationMode.cs b/src/Tizen.Applications.PackageManager/Tizen.Applications/InstallationMode.cs index da643db..ea4b438 100755 --- a/src/Tizen.Applications.PackageManager/Tizen.Applications/InstallationMode.cs +++ b/src/Tizen.Applications.PackageManager/Tizen.Applications/InstallationMode.cs @@ -19,6 +19,7 @@ namespace Tizen.Applications /// /// Enumeration for installation mode. /// + /// 4 public enum InstallationMode { /// diff --git a/src/Tizen.Applications.PackageManager/Tizen.Applications/Package.cs b/src/Tizen.Applications.PackageManager/Tizen.Applications/Package.cs index df075df..e33df18 100755 --- a/src/Tizen.Applications.PackageManager/Tizen.Applications/Package.cs +++ b/src/Tizen.Applications.PackageManager/Tizen.Applications/Package.cs @@ -24,6 +24,7 @@ namespace Tizen.Applications /// /// This class provides the methods and properties to get information about the packages. /// + /// 3 public class Package { private const string LogTag = "Tizen.Applications"; @@ -52,36 +53,43 @@ namespace Tizen.Applications /// /// The package ID. /// + /// 3 public string Id { get { return _id; } } /// /// Label of the package. /// + /// 3 public string Label { get { return _label; } } /// /// Absolute path to the icon image. /// + /// 3 public string IconPath { get { return _iconPath; } } /// /// Version of the package. /// + /// 3 public string Version { get { return _version; } } /// /// Type of the package. /// + /// 3 public PackageType PackageType { get { return _type; } } /// /// Installed storage type for the package. /// + /// 3 public StorageType InstalledStorageType { get { return (StorageType)_installedStorageType; } } /// /// Root path for the package. /// + /// 3 public string RootPath { get { return _rootPath; } } /// @@ -89,47 +97,56 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public string TizenExpansionPackageName { get { return _expansionPackageName; } } /// /// Checks whether the package is a system package. /// + /// 3 public bool IsSystemPackage { get { return _isSystemPackage; } } /// /// Checks whether the package is removable. /// + /// 3 public bool IsRemovable { get { return _isRemovable; } } /// /// Checks whether the package is preloaded. /// + /// 3 public bool IsPreloaded { get { return _isPreloaded; } } /// /// Checks whether the current package is accessible. /// + /// 3 public bool IsAccessible { get { return _isAccessible; } } /// /// Certificate information for the package. /// + /// 3 public IReadOnlyDictionary Certificates { get { return _certificates; } } /// /// Requested privilege for the package. /// + /// 3 public IEnumerable Privileges { get { return _privileges; } } /// /// Installed time of the package. /// + /// 3 public int InstalledTime { get { return _installedTime; } } /// /// Retrieves all the application IDs of this package. /// /// Returns a dictionary containing all the application information for a given application type. + /// 3 public IEnumerable GetApplications() { return GetApplications(ApplicationType.All); @@ -140,6 +157,7 @@ namespace Tizen.Applications /// /// Optional: AppType enumeration value. /// Returns a dictionary containing all the application information for a given application type. + /// 3 public IEnumerable GetApplications(ApplicationType type) { List appInfoList = new List(); @@ -175,6 +193,7 @@ namespace Tizen.Applications /// /// Package size information. /// http://tizen.org/privilege/packagemanager.info + /// 3 public async Task GetSizeInformationAsync() { TaskCompletionSource tcs = new TaskCompletionSource(); @@ -202,6 +221,7 @@ namespace Tizen.Applications /// Certificate comparison result. /// Thrown when a failed input package ID is invalid. /// Thrown when the method failed due to an internal I/O error. + /// 3 public CertCompareResultType CompareCertInfo(string packageId) { Interop.PackageManager.CertCompareResultType compareResult; diff --git a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageCertificate.cs b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageCertificate.cs index 264db10..89a8f9e 100755 --- a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageCertificate.cs +++ b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageCertificate.cs @@ -23,6 +23,7 @@ namespace Tizen.Applications /// /// This class provides information about the package certification. /// + /// 3 public class PackageCertificate { private const string LogTag = "Tizen.Applications"; @@ -41,16 +42,19 @@ namespace Tizen.Applications /// /// Root certificate. /// + /// 3 public string Root { get { return _root; } } /// /// Intermediate certificate. /// + /// 3 public string Intermediate { get { return _intermediate; } } /// /// Signer certificate. /// + /// 3 public string Signer { get { return _signer; } } internal static IReadOnlyDictionary GetPackageCertificates(IntPtr packageInfoHandle) diff --git a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageDrm.cs b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageDrm.cs index bfc959c..6590457 100644 --- a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageDrm.cs +++ b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageDrm.cs @@ -24,6 +24,7 @@ namespace Tizen.Applications /// /// This class provides the methods and properties for the DRM operation. /// + /// 4 public class PackageDrm { private string _responseData; @@ -40,18 +41,21 @@ namespace Tizen.Applications /// Returns the response data. /// /// Returns the response data which is given when GenerateLicenseRequest has been invoked. + /// 4 public string ResponseData { get { return _responseData; } } /// /// Returns the request data. /// /// Returns the request data which is generated when GenerateLicenseRequest has been invoked. + /// 4 public string RequestData { get { return _requestData; } } /// /// Returns the license URL. /// /// Returns the license URL which is generated when GenerateLicenseRequest has been invoked. + /// 4 public string LicenseUrl { get { return _licenseUrl; } } internal static PackageDrm CreateDrmRequest(string responseData, string requestData, string licenseUrl) diff --git a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageEventState.cs b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageEventState.cs index e8bcbb7..f43e034 100755 --- a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageEventState.cs +++ b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageEventState.cs @@ -19,6 +19,7 @@ namespace Tizen.Applications /// /// Enumeration for the package manager event state. /// + /// 3 public enum PackageEventState { /// diff --git a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageEventType.cs b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageEventType.cs index 5b9ea4e..2af1c28 100755 --- a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageEventType.cs +++ b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageEventType.cs @@ -19,6 +19,7 @@ namespace Tizen.Applications /// /// Enumeration for the package manager event types. /// + /// 3 public enum PackageEventType { /// diff --git a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageFilter.cs b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageFilter.cs index b20f495..cd5ff8a 100755 --- a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageFilter.cs +++ b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageFilter.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// This class is a parameter of the PackageManager::GetPackages method. /// + /// 3 public class PackageFilter { private IDictionary _filter; @@ -28,6 +29,7 @@ namespace Tizen.Applications /// /// The default constructor with an empty filter list. All the installed applications will satisfy this filter unless updated with more specific filters. /// + /// 3 public PackageFilter() { _filter = new Dictionary(); @@ -36,6 +38,7 @@ namespace Tizen.Applications /// /// The constructor with specific filters. Using this will filter out the installed packages which do not meet the filter criteria. /// + /// 3 public PackageFilter(IDictionary filter) { _filter = filter; @@ -44,6 +47,7 @@ namespace Tizen.Applications /// /// Filters to be used in the GetPackages method. /// + /// 3 public IDictionary Filters { get @@ -55,27 +59,33 @@ namespace Tizen.Applications /// /// This class contains possible keys for the filter to be used in the GetPackages method. /// + /// 3 public static class Keys { /// /// Key of the boolean property for filtering if the package is removable. /// + /// 3 public const string Removable = "PMINFO_PKGINFO_PROP_PACKAGE_REMOVABLE"; /// /// Key of the boolean property for filtering if the package is read-only. /// + /// 3 public const string ReadOnly = "PMINFO_PKGINFO_PROP_PACKAGE_READONLY"; /// /// Key of the boolean property for filtering if the package supports disabling. /// + /// 3 public const string SupportsDisable = "PMINFO_PKGINFO_PROP_PACKAGE_SUPPORT_DISABLE"; /// /// Key of the boolean property for filtering if the package is disabled. /// + /// 3 public const string Disable = "PMINFO_PKGINFO_PROP_PACKAGE_DISABLE"; /// /// Key of the boolean property for filtering if the package is preloaded. /// + /// 3 public const string Preload = "PMINFO_PKGINFO_PROP_PACKAGE_PRELOAD"; } } diff --git a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageManager.cs b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageManager.cs index d811841..a4a999c 100755 --- a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageManager.cs +++ b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageManager.cs @@ -28,6 +28,7 @@ namespace Tizen.Applications /// The package manager is one of the core modules of the Tizen application framework and responsible for getting their information. /// You can also retrieve information related to the packages that are installed on the device. /// + /// 3 public static class PackageManager { private const string LogTag = "Tizen.Applications.PackageManager"; @@ -50,6 +51,7 @@ namespace Tizen.Applications /// Event type of the request. /// Current event state of the request. /// Progress for the request being processed by the package manager (in percent). + /// 3 public delegate void RequestEventCallback(string type, string packageId, PackageEventType eventType, PackageEventState eventState, int progress); private static Dictionary RequestCallbacks = new Dictionary(); @@ -61,6 +63,7 @@ namespace Tizen.Applications /// /// InstallProgressChanged event. This event occurs when a package is getting installed and the progress of the request to the package manager is changed. /// + /// 3 public static event EventHandler InstallProgressChanged { add @@ -80,6 +83,7 @@ namespace Tizen.Applications /// /// UninstallProgressChanged event. This event occurs when a package is getting uninstalled and the progress of the request to the package manager is changed. /// + /// 3 public static event EventHandler UninstallProgressChanged { add @@ -99,6 +103,7 @@ namespace Tizen.Applications /// /// UpdateProgressChanged event. This event occurs when a package is getting updated and the progress of the request to the package manager is changed. /// + /// 3 public static event EventHandler UpdateProgressChanged { add @@ -118,6 +123,7 @@ namespace Tizen.Applications /// /// MoveProgressChanged event. This event occurs when a package is getting moved and the progress of the request to the package manager is changed. /// + /// 3 public static event EventHandler MoveProgressChanged { add @@ -137,6 +143,7 @@ namespace Tizen.Applications /// /// ClearDataProgressChanged event. This event occurs when data directories are cleared in the given package. /// + /// 3 public static event EventHandler ClearDataProgressChanged { add @@ -202,6 +209,7 @@ namespace Tizen.Applications /// Thrown when there is not enough memory to continue the execution of the method. /// Thrown when an application does not have the privilege to access this method. /// http://tizen.org/privilege/packagemanager.info + /// 3 public static string GetPackageIdByApplicationId(string applicationId) { string packageId; @@ -227,6 +235,7 @@ namespace Tizen.Applications /// Thrown when the method fails due to an internal I/O error. /// Thrown when an application does not have the privilege to access this method. /// http://tizen.org/privilege/packagemanager.info + /// 3 public static Package GetPackage(string packageId) { return Package.GetPackage(packageId); @@ -241,6 +250,7 @@ namespace Tizen.Applications /// Thrown when an application does not have the privilege to access this method. /// Thrown when the method failed due to an internal system error. /// http://tizen.org/privilege/packagemanager.clearcache + /// 3 public static void ClearCacheDirectory(string packageId) { Interop.PackageManager.ErrorCode err = Interop.PackageManager.PackageManagerClearCacheDir(packageId); @@ -260,6 +270,7 @@ namespace Tizen.Applications /// Thrown when the method failed due to an internal system error. /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static void ClearAllCacheDirectory() { var err = Interop.PackageManager.PackageManagerClearAllCacheDir(); @@ -284,6 +295,7 @@ namespace Tizen.Applications /// Thrown when the method failed due to an internal system error. /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static void ClearDataDirectory(string packageId) { Interop.PackageManager.ErrorCode err = Interop.PackageManager.PackageManagerClearDataDir(packageId); @@ -299,6 +311,7 @@ namespace Tizen.Applications /// /// Returns the list of packages. /// http://tizen.org/privilege/packagemanager.info + /// 3 public static IEnumerable GetPackages() { return GetPackages(null); @@ -310,6 +323,7 @@ namespace Tizen.Applications /// Optional - package filters. /// Returns the list of packages. /// http://tizen.org/privilege/packagemanager.info + /// 3 public static IEnumerable GetPackages(PackageFilter filter) { List packageList = new List(); @@ -363,6 +377,7 @@ namespace Tizen.Applications /// /// Returns the total package size information asynchronously. /// http://tizen.org/privilege/packagemanager.info + /// 3 public static async Task GetTotalSizeInformationAsync() { TaskCompletionSource tcs = new TaskCompletionSource(); @@ -394,6 +409,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static bool Install(string packagePath, InstallationMode installMode = InstallationMode.Normal) { return Install(packagePath, null, PackageType.UNKNOWN, null, installMode); @@ -412,6 +428,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static bool Install(string packagePath, RequestEventCallback eventCallback, InstallationMode installMode = InstallationMode.Normal) { return Install(packagePath, null, PackageType.UNKNOWN, eventCallback, installMode); @@ -430,6 +447,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static bool Install(string packagePath, PackageType type, InstallationMode installMode = InstallationMode.Normal) { return Install(packagePath, null, type, null, installMode); @@ -448,6 +466,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static bool Install(string packagePath, string expansionPackagePath, InstallationMode installMode = InstallationMode.Normal) { return Install(packagePath, expansionPackagePath, PackageType.UNKNOWN, null, installMode); @@ -467,6 +486,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static bool Install(string packagePath, PackageType type, RequestEventCallback eventCallback, InstallationMode installMode = InstallationMode.Normal) { return Install(packagePath, null, type, eventCallback, installMode); @@ -486,6 +506,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static bool Install(string packagePath, string expansionPackagePath, RequestEventCallback eventCallback, InstallationMode installMode = InstallationMode.Normal) { return Install(packagePath, expansionPackagePath, PackageType.UNKNOWN, eventCallback, installMode); @@ -505,6 +526,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static bool Install(string packagePath, string expansionPackagePath, PackageType type, InstallationMode installMode = InstallationMode.Normal) { return Install(packagePath, expansionPackagePath, type, null, installMode); @@ -525,6 +547,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static bool Install(string packagePath, string expansionPackagePath, PackageType type, RequestEventCallback eventCallback, InstallationMode installMode = InstallationMode.Normal) { SafePackageManagerRequestHandle RequestHandle; @@ -626,6 +649,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static bool Uninstall(string packageId) { return Uninstall(packageId, PackageType.UNKNOWN, null); @@ -643,6 +667,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static bool Uninstall(string packageId, PackageType type) { return Uninstall(packageId, type, null); @@ -660,6 +685,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static bool Uninstall(string packageId, RequestEventCallback eventCallback) { return Uninstall(packageId, PackageType.UNKNOWN, eventCallback); @@ -678,6 +704,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static bool Uninstall(string packageId, PackageType type, RequestEventCallback eventCallback) { SafePackageManagerRequestHandle RequestHandle; @@ -748,6 +775,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static bool Move(string packageId, StorageType newStorage) { return Move(packageId, PackageType.UNKNOWN, newStorage, null); @@ -766,6 +794,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static bool Move(string packageId, PackageType type, StorageType newStorage) { return Move(packageId, type, newStorage, null); @@ -784,6 +813,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static bool Move(string packageId, StorageType newStorage, RequestEventCallback eventCallback) { return Move(packageId, PackageType.UNKNOWN, newStorage, eventCallback); @@ -803,6 +833,7 @@ namespace Tizen.Applications /// /// http://tizen.org/privilege/packagemanager.admin /// platform + /// 3 public static bool Move(string packageId, PackageType type, StorageType newStorage, RequestEventCallback eventCallback) { SafePackageManagerRequestHandle RequestHandle; @@ -870,6 +901,7 @@ namespace Tizen.Applications /// http://tizen.org/privilege/packagemanager.info /// Thrown when the failed input package ID is invalid. /// Thrown when an application does not have the privilege to access this method. + /// 3 public static PermissionType GetPermissionTypeByApplicationId(string applicationId) { Interop.PackageManager.PackageManagerPermissionType permissionType; @@ -890,6 +922,7 @@ namespace Tizen.Applications /// http://tizen.org/privilege/packagemanager.info /// Thrown when the failed input package ID is invalid. /// Thrown when an application does not have the privilege to access this method. + /// 3 public static bool IsPreloadPackageByApplicationId(string applicationId) { bool isPreloadPackage; @@ -910,6 +943,7 @@ namespace Tizen.Applications /// Returns certificate comparison result. /// Thrown when the failed input package ID is invalid. /// Thrown when the method failed due to an internal I/O error. + /// 3 public static CertCompareResultType CompareCertInfo(string lhsPackageId, string rhsPackageId) { Interop.PackageManager.CertCompareResultType compareResult; @@ -930,6 +964,7 @@ namespace Tizen.Applications /// Returns certificate comparison result. /// Thrown when the failed input package ID is invalid. /// Thrown when the method failed due to an internal I/O error. + /// 3 public static CertCompareResultType CompareCertInfoByApplicationId(string lhsApplicationId, string rhsApplicationId) { Interop.PackageManager.CertCompareResultType compareResult; @@ -945,6 +980,7 @@ namespace Tizen.Applications /// /// Drm nested class. This class has the PackageManager's drm related methods. /// + /// 3 public static class Drm { /// @@ -958,6 +994,7 @@ namespace Tizen.Applications /// Thrown when there is not enough memory to continue the execution of the method. /// Thrown when an application does not have the privilege to access this method. /// Thrown when the method failed due to an internal system error. + /// 3 public static PackageDrm GenerateLicenseRequest(string responseData) { return PackageDrm.GenerateLicenseRequest(responseData); @@ -975,6 +1012,7 @@ namespace Tizen.Applications /// Thrown when there is not enough memory to continue the execution of the method. /// Thrown when an application does not have the privilege to access this method. /// Thrown when the method failed due to internal system error. + /// 3 public static bool RegisterLicense(string responseData) { Interop.PackageManager.ErrorCode err = Interop.PackageManager.PackageManagerDrmRegisterLicense(responseData); @@ -998,6 +1036,7 @@ namespace Tizen.Applications /// Thrown when there is not enough memory to continue the execution of the method. /// Thrown when an application does not have the privilege to access this method. /// Thrown when the method failed due to an internal system error. + /// 3 public static bool DecryptPackage(string drmFilePath, string decryptedFilePath) { Interop.PackageManager.ErrorCode err = Interop.PackageManager.PackageManagerDrmDecryptPackage(drmFilePath, decryptedFilePath); diff --git a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageManagerEventArgs.cs b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageManagerEventArgs.cs index c840970..a01a0ef 100755 --- a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageManagerEventArgs.cs +++ b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageManagerEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// PackageManagerEventArgs class. This class is an event arguments of the InstallProgressChanged, UninstallProgressChanged, and UpdateProgressChanged events. /// + /// 3 public class PackageManagerEventArgs : EventArgs { private readonly PackageType _packageType; @@ -39,21 +40,25 @@ namespace Tizen.Applications /// /// Type of the package to be installed, uninstalled, or updated. /// + /// 3 public PackageType PackageType { get { return _packageType; } } /// /// Package ID to be installed, uninstalled, or updated. /// + /// 3 public string PackageId { get { return _packageId; } } /// /// Current state of the request to the package manager. /// + /// 3 public PackageEventState State { get { return _state; } } /// /// Progress for the request being processed by the package manager (in percent). /// + /// 3 public int Progress { get { return _progress; } } } } diff --git a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageSizeInformation.cs b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageSizeInformation.cs index b7d4b15..d864b6d 100755 --- a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageSizeInformation.cs +++ b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageSizeInformation.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// This class has read-only properties to get the package size information. /// + /// 3 public class PackageSizeInformation { private long _dataSize; @@ -35,31 +36,37 @@ namespace Tizen.Applications /// /// Data size for the package. /// + /// 3 public long DataSize { get { return _dataSize; } } /// /// Cache size for the package. /// + /// 3 public long CacheSize { get { return _cacheSize; } } /// /// Application size for the package. /// + /// 3 public long AppSize { get { return _appSize; } } /// /// External data size for the package. /// + /// 3 public long ExternalDataSize { get { return _externalDataSize; } } /// /// External cache size for the package. /// + /// 3 public long ExternalCacheSize { get { return _externalCacheSize; } } /// /// External application size for the package. /// + /// 3 public long ExternalAppSize { get { return _externalAppSize; } } // This method assumes that pass handle is already validated diff --git a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageType.cs b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageType.cs index 90c38e0..c7ef31d 100644 --- a/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageType.cs +++ b/src/Tizen.Applications.PackageManager/Tizen.Applications/PackageType.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// Enumeration for the package types. /// + /// 3 public enum PackageType { /// diff --git a/src/Tizen.Applications.PackageManager/Tizen.Applications/PermissionType.cs b/src/Tizen.Applications.PackageManager/Tizen.Applications/PermissionType.cs index d9e2083..2fd068b 100644 --- a/src/Tizen.Applications.PackageManager/Tizen.Applications/PermissionType.cs +++ b/src/Tizen.Applications.PackageManager/Tizen.Applications/PermissionType.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// Enumeration for the permission types. /// + /// 3 public enum PermissionType { /// diff --git a/src/Tizen.Applications.PackageManager/Tizen.Applications/StorageType.cs b/src/Tizen.Applications.PackageManager/Tizen.Applications/StorageType.cs index 040c1fb..2b7aada 100755 --- a/src/Tizen.Applications.PackageManager/Tizen.Applications/StorageType.cs +++ b/src/Tizen.Applications.PackageManager/Tizen.Applications/StorageType.cs @@ -19,6 +19,7 @@ namespace Tizen.Applications /// /// Enumeration for the storage types. /// + /// 3 public enum StorageType { /// diff --git a/src/Tizen.Applications.Preference/Tizen.Applications/Preference.cs b/src/Tizen.Applications.Preference/Tizen.Applications/Preference.cs index 41894a4..fd5bbc4 100755 --- a/src/Tizen.Applications.Preference/Tizen.Applications/Preference.cs +++ b/src/Tizen.Applications.Preference/Tizen.Applications/Preference.cs @@ -24,6 +24,7 @@ namespace Tizen.Applications /// The preference class provides APIs to store and retrieve an application specific data/preference. A preference is saved in the form of a key-value pair. /// Keys are always text strings and the value can be any one of the four types: integer, double, string, and boolean. /// + /// 3 public static class Preference { private const string LogTag = "Tizen.Applications"; @@ -63,6 +64,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public static IEnumerable Keys { get @@ -109,6 +111,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public static WeakReference GetEventContext(string key) { if (!s_eventMap.ContainsKey(key)) @@ -144,6 +147,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public static bool Contains(string key) { bool contains; @@ -176,6 +180,7 @@ namespace Tizen.Applications /// Preference.Set("brightness", "0.6"); /// /// + /// 3 public static void Set(string key, object value) { int ret = 0; @@ -242,6 +247,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public static T Get(string key) { object result = null; @@ -300,6 +306,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public static void Remove(string key) { int ret = Interop.Preference.Remove(key); @@ -323,6 +330,7 @@ namespace Tizen.Applications /// Preference.RemoveAll(); /// /// + /// 3 public static void RemoveAll() { int ret = Interop.Preference.RemoveAll(); @@ -356,6 +364,7 @@ namespace Tizen.Applications /// /// The class manages event handlers of the preference keys. The class enables having event handlers for individual preference keys. /// + /// 3 public class EventContext { private string _key; @@ -392,6 +401,7 @@ namespace Tizen.Applications /// } /// /// + /// 3 public event EventHandler Changed { add diff --git a/src/Tizen.Applications.Preference/Tizen.Applications/PreferenceChangedEventArgs.cs b/src/Tizen.Applications.Preference/Tizen.Applications/PreferenceChangedEventArgs.cs index 99f81dd..cb3db24 100755 --- a/src/Tizen.Applications.Preference/Tizen.Applications/PreferenceChangedEventArgs.cs +++ b/src/Tizen.Applications.Preference/Tizen.Applications/PreferenceChangedEventArgs.cs @@ -21,11 +21,13 @@ namespace Tizen.Applications /// /// This class is an event argument of the PreferenceChanged event. /// + /// 3 public class PreferenceChangedEventArgs : EventArgs { /// /// The key of the preference whose value is changed. /// + /// 3 public string Key { get; internal set; } } } diff --git a/src/Tizen.Applications.RemoteView/Tizen.Applications/RemoteView.cs b/src/Tizen.Applications.RemoteView/Tizen.Applications/RemoteView.cs index 333cb38..af98247 100755 --- a/src/Tizen.Applications.RemoteView/Tizen.Applications/RemoteView.cs +++ b/src/Tizen.Applications.RemoteView/Tizen.Applications/RemoteView.cs @@ -23,11 +23,13 @@ namespace Tizen.Applications /// /// Represents the proxy class for the widget application. /// + /// 3 public class RemoteView { /// /// The event types to send. /// + /// 3 public enum Event { /// @@ -45,12 +47,14 @@ namespace Tizen.Applications /// Layout object including preview image, overlay text, loading text, and remote screen image. /// /// http://tizen.org/privilege/widget.viewer + /// 3 public Layout Layout { get; internal set; } /// /// The widget ID. /// /// http://tizen.org/privilege/widget.viewer + /// 3 public string Id { get @@ -65,6 +69,7 @@ namespace Tizen.Applications /// The update period. /// /// http://tizen.org/privilege/widget.viewer + /// 3 public double Period { get @@ -80,6 +85,7 @@ namespace Tizen.Applications /// This string can be used for creating contents of the widget again after rebooting a device or it can be recovered from a crash (abnormal status). /// /// http://tizen.org/privilege/widget.viewer + /// 3 public string Content { get @@ -94,6 +100,7 @@ namespace Tizen.Applications /// Summarized string of the widget content for accessibility. /// /// http://tizen.org/privilege/widget.viewer + /// 3 public string Title { get @@ -139,6 +146,7 @@ namespace Tizen.Applications /// Thrown when this operation failed. /// Thrown when this operation is denied. /// Thrown when this operation is not supported for this device. + /// 3 public static void PauseAll() { CheckException(Interop.WidgetViewerEvas.NotifyPausedStatusOfViewer()); @@ -151,6 +159,7 @@ namespace Tizen.Applications /// Thrown when this operation failed. /// Thrown when this operation is denied. /// Thrown when this operation is not supported for this device. + /// 3 public static void ResumeAll() { CheckException(Interop.WidgetViewerEvas.NotifyResumedStatusOfViewer()); @@ -163,6 +172,7 @@ namespace Tizen.Applications /// Thrown when this operation failed. /// Thrown when this operation is denied. /// Thrown when this operation is not supported for this device. + /// 3 public void Pause() { CheckException(Interop.WidgetViewerEvas.PauseWidget(Layout)); @@ -175,6 +185,7 @@ namespace Tizen.Applications /// Thrown when this operation failed. /// Thrown when this operation is denied. /// Thrown when this operation is not supported for this device. + /// 3 public void Resume() { CheckException(Interop.WidgetViewerEvas.ResumeWidget(Layout)); @@ -186,6 +197,7 @@ namespace Tizen.Applications /// http://tizen.org/privilege/widget.viewer /// Thrown when this operation is denied. /// Thrown when this operation is not supported for this device. + /// 3 public void SendEvent(Event ev) { switch (ev) diff --git a/src/Tizen.Applications.RemoteView/Tizen.Applications/RemoteViewFactory.cs b/src/Tizen.Applications.RemoteView/Tizen.Applications/RemoteViewFactory.cs index 0820a5e..8fd6798 100755 --- a/src/Tizen.Applications.RemoteView/Tizen.Applications/RemoteViewFactory.cs +++ b/src/Tizen.Applications.RemoteView/Tizen.Applications/RemoteViewFactory.cs @@ -22,6 +22,7 @@ namespace Tizen.Applications /// /// Represents a factory class for making the RemoteView objects. /// + /// 3 public static class RemoteViewFactory { private static bool _ready; @@ -36,6 +37,7 @@ namespace Tizen.Applications /// Thrown when this operation failed. /// Thrown when this operation is denied. /// Thrown when this operation is not supported for this device. + /// 3 public static void Init(EvasObject win) { if (_ready) @@ -59,6 +61,7 @@ namespace Tizen.Applications /// Thrown when this operation failed. /// Thrown when this operation is denied. /// Thrown when this operation is not supported for this device. + /// 3 public static RemoteView Create(EvasObject parent, string widgetId, string content, double period, bool previewImage = true, bool overlayText = true, bool loadingMessage = true) { @@ -89,6 +92,7 @@ namespace Tizen.Applications /// Thrown when this operation failed. /// Thrown when this operation is denied. /// Thrown when this operation is not supported for this device. + /// 3 public static void Shutdown() { if (!_ready) diff --git a/src/Tizen.Applications.Service/Tizen.Applications/ServiceApplication.cs b/src/Tizen.Applications.Service/Tizen.Applications/ServiceApplication.cs index e039c70..7da954a 100755 --- a/src/Tizen.Applications.Service/Tizen.Applications/ServiceApplication.cs +++ b/src/Tizen.Applications.Service/Tizen.Applications/ServiceApplication.cs @@ -21,11 +21,13 @@ namespace Tizen.Applications /// /// Represents the service applications. /// + /// 3 public class ServiceApplication : CoreApplication { /// /// Initializes the ServiceApplication class. /// + /// 3 public ServiceApplication() : base(new ServiceCoreBackend()) { } @@ -34,6 +36,7 @@ namespace Tizen.Applications /// Runs the service application's main loop. /// /// Arguments from commandline. + /// 3 public override void Run(string[] args) { base.Run(args); diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/HomeShortcutInfo.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/HomeShortcutInfo.cs index 2cbc7c2..e699703 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/HomeShortcutInfo.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/HomeShortcutInfo.cs @@ -19,11 +19,13 @@ namespace Tizen.Applications.Shortcut /// /// A class that contains shortcut information. /// + /// 4 public class HomeShortcutInfo : ShortcutInfo { /// /// Gets or sets the specific information for delivering to the viewer for creating a shortcut. /// + /// 4 public string Uri { get; set; } = string.Empty; } } \ No newline at end of file diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutEnumerations.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutEnumerations.cs index c9c52cb..4624d60 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutEnumerations.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutEnumerations.cs @@ -19,6 +19,7 @@ namespace Tizen.Applications.Shortcut /// /// Enumeration for sizes of shortcut widget. /// + /// 4 public enum ShortcutWidgetSize { /// diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutInfo.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutInfo.cs index 63fb8a6..50853b2 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutInfo.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutInfo.cs @@ -19,21 +19,25 @@ namespace Tizen.Applications.Shortcut /// /// A class to get information of the Shortcut. /// + /// 4 public class ShortcutInfo { /// /// Gets or sets the name of the created shortcut icon. /// + /// 4 public string ShortcutName { get; set; } = string.Empty; /// /// Gets or sets the absolute path of an icon file for this shortcut. /// + /// 4 public string IconPath { get; set; } = string.Empty; /// /// Gets or sets a value indicating whether to allow or not to allow duplication. /// + /// 4 public bool IsAllowDuplicate { get; set; } } } \ No newline at end of file diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutManager.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutManager.cs index 6fe1311..ea4c39e 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutManager.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/ShortcutManager.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications.Shortcut /// /// This class provides the some functions to add, delete shortcut. /// + /// 4 public static class ShortcutManager { private const string LogTag = "Tizen.Applications.Shortcut"; @@ -34,7 +35,7 @@ namespace Tizen.Applications.Shortcut /// /// Adds a shortcut on home-screen. /// - /// 3 + /// 4 /// Object that contain shortcut info. /// http://tizen.org/feature/shortcut /// http://tizen.org/privilege/shortcut @@ -80,7 +81,7 @@ namespace Tizen.Applications.Shortcut /// /// Adds a shortcut on home-screen. /// - /// 3 + /// 4 /// Object that contain shortcut info. /// http://tizen.org/feature/shortcut /// http://tizen.org/privilege/shortcut @@ -120,7 +121,7 @@ namespace Tizen.Applications.Shortcut /// /// Removes a shortcut from home by ShortcutName. /// - /// 3 + /// 4 /// Shortcut name string. /// http://tizen.org/feature/shortcut /// http://tizen.org/privilege/shortcut @@ -160,7 +161,7 @@ namespace Tizen.Applications.Shortcut /// /// Removes a shortcut from home by ShortcutInfo. /// - /// 3 + /// 4 /// Object that contain shortcut info. /// http://tizen.org/feature/shortcut /// http://tizen.org/privilege/shortcut diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/WidgetShortcutInfo.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/WidgetShortcutInfo.cs index 4676c7c..80a6e1d 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/WidgetShortcutInfo.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.Shortcut/WidgetShortcutInfo.cs @@ -19,21 +19,25 @@ namespace Tizen.Applications.Shortcut /// /// A class that contains information about the widget. /// + /// 4 public class WidgetShortcutInfo : ShortcutInfo { /// /// Gets or sets the Widget ID. /// + /// 4 public string WidgetId { get; set; } = string.Empty; /// /// Gets or sets the size of widget. /// + /// 4 public ShortcutWidgetSize WidgetSize { get; set; } /// /// Gets or sets the Update period in seconds. /// + /// 4 public double Period { get; set; } } } \ No newline at end of file diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/HomeShortcutAddedInfo.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/HomeShortcutAddedInfo.cs index 91038a1..18b7b57 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/HomeShortcutAddedInfo.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/HomeShortcutAddedInfo.cs @@ -19,16 +19,19 @@ namespace Tizen.Applications.Shortcut /// /// A class that contains shortcut information. /// + /// 4 public class HomeShortcutAddedInfo : ShortcutAddedInfo { /// /// Gets the name of application. /// + /// 4 public string AppId { get; internal set; } /// /// Gets the specific information for creating a new shortcut. /// + /// 4 public string Uri { get; internal set; } } } \ No newline at end of file diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutAddedInfo.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutAddedInfo.cs index 889e3cb..f689cb1 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutAddedInfo.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutAddedInfo.cs @@ -19,21 +19,25 @@ namespace Tizen.Applications.Shortcut /// /// A class for getting information of the Shortcut. /// + /// 4 public class ShortcutAddedInfo { /// /// Gets the name of the created shortcut icon. /// + /// 4 public string ShortcutName { get; internal set; } /// /// Gets the absolute path of an icon file for this shortcut. /// + /// 4 public string IconPath { get; internal set; } /// /// Gets a value indicating whether to allow or not to allow duplication. /// + /// 4 public bool IsAllowDuplicate { get; internal set; } } } \ No newline at end of file diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutDeletedInfo.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutDeletedInfo.cs index 73786f9..873454d 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutDeletedInfo.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutDeletedInfo.cs @@ -19,16 +19,19 @@ namespace Tizen.Applications.Shortcut /// /// A class for getting information of the Shortcut. /// + /// 4 public class ShortcutDeletedInfo { /// /// Gets the name of package. /// + /// 4 public string AppId { get; internal set; } /// /// Gets the name of the created shortcut icon. /// + /// 4 public string ShortcutName { get; internal set; } } } \ No newline at end of file diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutEventEnumerations.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutEventEnumerations.cs index 9dc4e40..b717cf1 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutEventEnumerations.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutEventEnumerations.cs @@ -19,6 +19,7 @@ namespace Tizen.Applications.Shortcut /// /// Enumeration for values of shortcut response types. /// + /// 4 public enum ShortcutError { /// diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutEventManager.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutEventManager.cs index fca6ef2..a5b2c98 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutEventManager.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutEventManager.cs @@ -25,6 +25,7 @@ namespace Tizen.Applications.Shortcut /// /// Object that contain shortcut info to add. /// The result of handling a shortcut add request + /// 4 public delegate ShortcutError ShortcutAdded(ShortcutAddedInfo args); /// @@ -32,11 +33,13 @@ namespace Tizen.Applications.Shortcut /// /// Object that contain shortcut info to delete. /// The result of handling a shortcut delete request + /// 4 public delegate ShortcutError ShortcutDeleted(ShortcutDeletedInfo args); /// /// This class provides a way to register callback function for shortcut add, delete events. /// + /// 4 public static class ShortcutEventManager { private static Interop.Shortcut.AddCallback shortcutAddCallback; @@ -52,7 +55,7 @@ namespace Tizen.Applications.Shortcut /// /// Registers a callback function to listen requests from applications. /// - /// 3 + /// 4 /// The callback function pointer that is invoked when Add() is requested /// http://tizen.org/feature/shortcut /// http://tizen.org/privilege/shortcut @@ -88,7 +91,7 @@ namespace Tizen.Applications.Shortcut /// /// Registers a callback function to listen requests from applications. /// - /// 3 + /// 4 /// The callback function pointer that is invoked when Delete() is requested /// http://tizen.org/feature/shortcut /// http://tizen.org/privilege/shortcut @@ -124,7 +127,7 @@ namespace Tizen.Applications.Shortcut /// /// Unregisters a callback for the shortcut request. /// - /// 3 + /// 4 /// The callback function pointer that used for RegisterCallback /// http://tizen.org/feature/shortcut /// http://tizen.org/privilege/shortcut @@ -158,7 +161,7 @@ namespace Tizen.Applications.Shortcut /// /// Unregisters a callback for the shortcut request. /// - /// 3 + /// 4 /// The callback function pointer that used for RegisterCallback /// http://tizen.org/feature/shortcut /// http://tizen.org/privilege/shortcut @@ -192,7 +195,7 @@ namespace Tizen.Applications.Shortcut /// /// Gets the preset list of shortcut template from the installed package. /// - /// 3 + /// 4 /// Application ID. /// The List of ShortcutTemplate. /// http://tizen.org/feature/shortcut diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutTemplate.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutTemplate.cs index 05fcb99..9be3065 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutTemplate.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/ShortcutTemplate.cs @@ -19,31 +19,37 @@ namespace Tizen.Applications.Shortcut /// /// A class that contains the preset list of shortcut template from the installed package. /// + /// 4 public class ShortcutTemplate { /// /// Gets the Application ID. /// + /// 4 public string AppId { get; internal set; } /// /// Gets the name of the created shortcut icon. /// + /// 4 public string ShortcutName { get; internal set; } /// /// Gets the absolute path of an icon file for this shortcut. /// + /// 4 public string IconPath { get; internal set; } /// /// Gets the user data. A property of shortcut element in manifest file. /// + /// 4 public string ExtraKey { get; internal set; } /// /// Gets the user data. A property of shortcut element in manifest file. /// + /// 4 public string ExtraData { get; internal set; } } } \ No newline at end of file diff --git a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/WidgetShortcutAddedInfo.cs b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/WidgetShortcutAddedInfo.cs index eed1e4f..0721ffe 100755 --- a/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/WidgetShortcutAddedInfo.cs +++ b/src/Tizen.Applications.Shortcut/Tizen.Applications.ShortcutEvent/WidgetShortcutAddedInfo.cs @@ -19,21 +19,25 @@ namespace Tizen.Applications.Shortcut /// /// A class that contains information about the widget. /// + /// 4 public class WidgetShortcutAddedInfo : ShortcutAddedInfo { /// /// Gets the Widget ID. /// + /// 4 public string WidgetId { get; internal set; } /// /// Gets the size of widget. /// + /// 4 public ShortcutWidgetSize WidgetSize { get; internal set; } /// /// Gets the Update period in seconds. /// + /// 4 public double Period { get; internal set; } } } \ No newline at end of file diff --git a/src/Tizen.Applications.ToastMessage/Tizen.Applications/ToastMessage.cs b/src/Tizen.Applications.ToastMessage/Tizen.Applications/ToastMessage.cs index d490b2c..1800f60 100755 --- a/src/Tizen.Applications.ToastMessage/Tizen.Applications/ToastMessage.cs +++ b/src/Tizen.Applications.ToastMessage/Tizen.Applications/ToastMessage.cs @@ -25,12 +25,14 @@ namespace Tizen.Applications /// /// The class helps you to create and show the ToastMessage which is a view quick message for the user. /// + /// 4 public sealed class ToastMessage { /// /// Gets and sets a message to post the ToastMessage. /// + /// 4 public string Message { get; set; } /// @@ -46,6 +48,7 @@ namespace Tizen.Applications /// toast.Post(); /// /// + /// 4 public void Post() { int ret = Interop.ToastMessage.ToastMessagePost(Message); diff --git a/src/Tizen.Applications.UI/Tizen.Applications/CoreUIApplication.cs b/src/Tizen.Applications.UI/Tizen.Applications/CoreUIApplication.cs index e036c14..ad16365 100755 --- a/src/Tizen.Applications.UI/Tizen.Applications/CoreUIApplication.cs +++ b/src/Tizen.Applications.UI/Tizen.Applications/CoreUIApplication.cs @@ -23,6 +23,7 @@ namespace Tizen.Applications /// /// Represents an application that has an UI screen. The events for resuming and pausing are provided. /// + /// 3 public class CoreUIApplication : CoreApplication { /// @@ -31,6 +32,7 @@ namespace Tizen.Applications /// /// The default backend for the UI application will be used. /// + /// 3 public CoreUIApplication() : base(new UICoreBackend()) { } @@ -42,6 +44,7 @@ namespace Tizen.Applications /// If you want to change the backend, use this constructor. /// /// The backend instance implementing the ICoreBacked interface. + /// 3 public CoreUIApplication(ICoreBackend backend) : base(backend) { } @@ -49,17 +52,20 @@ namespace Tizen.Applications /// /// Occurs whenever the application is resumed. /// + /// 3 public event EventHandler Resumed; /// /// Occurs whenever the application is paused. /// + /// 3 public event EventHandler Paused; /// /// Runs the UI application's main loop. /// /// Arguments from the commandline. + /// 3 public override void Run(string[] args) { Backend.AddEventHandler(EventType.PreCreated, OnPreCreate); @@ -71,6 +77,7 @@ namespace Tizen.Applications /// /// Overrides this method if you want to handle the behavior before calling OnCreate(). /// + /// 3 protected virtual void OnPreCreate() { } @@ -79,6 +86,7 @@ namespace Tizen.Applications /// Overrides this method if you want to handle the behavior when the application is resumed. /// If base.OnResume() is not called, the event 'Resumed' will not be emitted. /// + /// 3 protected virtual void OnResume() { Resumed?.Invoke(this, EventArgs.Empty); @@ -88,6 +96,7 @@ namespace Tizen.Applications /// Overrides this method if you want to handle the behavior when the application is paused. /// If base.OnPause() is not called, the event 'Paused' will not be emitted. /// + /// 3 protected virtual void OnPause() { Paused?.Invoke(this, EventArgs.Empty); diff --git a/src/Tizen.Applications.WatchApplication/Tizen.Applications.CoreBackend/WatchEventType.cs b/src/Tizen.Applications.WatchApplication/Tizen.Applications.CoreBackend/WatchEventType.cs index c996029..f150b10 100755 --- a/src/Tizen.Applications.WatchApplication/Tizen.Applications.CoreBackend/WatchEventType.cs +++ b/src/Tizen.Applications.WatchApplication/Tizen.Applications.CoreBackend/WatchEventType.cs @@ -23,27 +23,32 @@ namespace Tizen.Applications.CoreBackend /// /// Class that represents the type of event for backends. This class can be converted from string type. /// + /// 4 public class WatchEventType : EventType { /// /// Pre-defined event type. "Created" /// + /// 4 public static readonly WatchEventType TimeTick = "TimeTick"; /// /// Pre-defined event type. "AmbientTick" /// + /// 4 public static readonly WatchEventType AmbientTick = "AmbientTick"; /// /// Pre-defined event type. "AmbientChanged" /// + /// 4 public static readonly WatchEventType AmbientChanged = "AmbientChanged"; /// /// Initializes the WatchEventType class. /// /// The name of watch event type. + /// 4 public WatchEventType(string name) : base(name) { } @@ -51,6 +56,7 @@ namespace Tizen.Applications.CoreBackend /// /// Converts a string to WatchEventType instance. /// + /// 4 public static implicit operator WatchEventType(string value) { return new WatchEventType(value); diff --git a/src/Tizen.Applications.WatchApplication/Tizen.Applications/AmbientEventArgs.cs b/src/Tizen.Applications.WatchApplication/Tizen.Applications/AmbientEventArgs.cs index aa9e7b5..3dabae9 100755 --- a/src/Tizen.Applications.WatchApplication/Tizen.Applications/AmbientEventArgs.cs +++ b/src/Tizen.Applications.WatchApplication/Tizen.Applications/AmbientEventArgs.cs @@ -22,11 +22,13 @@ namespace Tizen.Applications /// /// Arguments for the event that reaised when the device enters or exits the ambient mode. /// + /// 4 public class AmbientEventArgs : EventArgs { /// /// The received Ambient mode /// + /// 4 public bool Enabled { get; internal set; } internal AmbientEventArgs() diff --git a/src/Tizen.Applications.WatchApplication/Tizen.Applications/AmbientTickType.cs b/src/Tizen.Applications.WatchApplication/Tizen.Applications/AmbientTickType.cs index c82656e..655a87b 100755 --- a/src/Tizen.Applications.WatchApplication/Tizen.Applications/AmbientTickType.cs +++ b/src/Tizen.Applications.WatchApplication/Tizen.Applications/AmbientTickType.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// Enumeration for Ambient tick type. /// + /// 4 public enum AmbientTickType { /// diff --git a/src/Tizen.Applications.WatchApplication/Tizen.Applications/TimeEventArgs.cs b/src/Tizen.Applications.WatchApplication/Tizen.Applications/TimeEventArgs.cs index 1d100fe..9dfbf57 100755 --- a/src/Tizen.Applications.WatchApplication/Tizen.Applications/TimeEventArgs.cs +++ b/src/Tizen.Applications.WatchApplication/Tizen.Applications/TimeEventArgs.cs @@ -21,11 +21,13 @@ namespace Tizen.Applications /// /// Arguments for the event that reaised when the time tick comes. /// + /// 4 public class TimeEventArgs : EventArgs { /// /// The received WatchTime. /// + /// 4 public WatchTime Time { get; internal set; } internal TimeEventArgs() diff --git a/src/Tizen.Applications.WatchApplication/Tizen.Applications/TimeTickResolution.cs b/src/Tizen.Applications.WatchApplication/Tizen.Applications/TimeTickResolution.cs index 79c1b29..6232541 100755 --- a/src/Tizen.Applications.WatchApplication/Tizen.Applications/TimeTickResolution.cs +++ b/src/Tizen.Applications.WatchApplication/Tizen.Applications/TimeTickResolution.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// Enumeration for Time tick resolution. /// + /// 4 public enum TimeTickResolution { /// diff --git a/src/Tizen.Applications.WatchApplication/Tizen.Applications/WatchApplication.cs b/src/Tizen.Applications.WatchApplication/Tizen.Applications/WatchApplication.cs index b02f1a4..d8f8fa2 100755 --- a/src/Tizen.Applications.WatchApplication/Tizen.Applications/WatchApplication.cs +++ b/src/Tizen.Applications.WatchApplication/Tizen.Applications/WatchApplication.cs @@ -23,6 +23,7 @@ namespace Tizen.Applications /// /// The class that represents a Tizen watch application. /// + /// 4 public class WatchApplication : CoreApplication { /// @@ -31,6 +32,7 @@ namespace Tizen.Applications /// /// Default backend for Watch application will be used. /// + /// 4 public WatchApplication() : base(new WatchCoreBackend()) { } @@ -42,6 +44,7 @@ namespace Tizen.Applications /// If want to change the backend , use this constructor /// /// The backend instance implementing ICoreBackend interface. + /// 4 public WatchApplication(ICoreBackend backend) : base(backend) { } @@ -49,37 +52,44 @@ namespace Tizen.Applications /// /// Instance for the window /// + /// 4 protected Window Window; /// /// Occurs whenever the application is resumed. /// + /// 4 public event EventHandler Resumed; /// /// Occurs whenever the application is paused. /// + /// 4 public event EventHandler Paused; /// /// Occurs whenever the time tick comes. /// + /// 4 public event EventHandler TimeTick; /// /// Occurs whenever the time tick comes in ambient mode. /// + /// 4 public event EventHandler AmbientTick; /// /// Occurs when the ambient mode is changed. /// + /// 4 public event EventHandler AmbientChanged; /// /// Runs the UI applications' main loop. /// /// Arguments from commandline. + /// 4 public override void Run(string[] args) { Backend.AddEventHandler(EventType.Resumed, OnResume); @@ -96,6 +106,7 @@ namespace Tizen.Applications /// Overrides this method if want to handle behavior when the application is launched. /// If base.OnCreate() is not called, the event 'Created' will not be emitted. /// + /// 4 protected override void OnCreate() { base.OnCreate(); @@ -110,6 +121,7 @@ namespace Tizen.Applications /// Overrides this method if want to handle behavior when the application is resumed. /// If base.OnResume() is not called, the event 'Resumed' will not be emitted. /// + /// 4 protected virtual void OnResume() { Resumed?.Invoke(this, EventArgs.Empty); @@ -119,6 +131,7 @@ namespace Tizen.Applications /// Overrides this method if want to handle behavior when the application is paused. /// If base.OnPause() is not called, the event 'Paused' will not be emitted. /// + /// 4 protected virtual void OnPause() { Paused?.Invoke(this, EventArgs.Empty); @@ -129,6 +142,7 @@ namespace Tizen.Applications /// If base.OnTick() is not called, the event 'TimeTick' will not be emitted. /// /// The received TimeEventArgs to get time information. + /// 4 protected virtual void OnTick(TimeEventArgs time) { TimeTick?.Invoke(this, time); @@ -140,6 +154,7 @@ namespace Tizen.Applications /// /// The received TimeEventArgs to get time information. /// http://tizen.org/privilege/alarm.set + /// 4 protected virtual void OnAmbientTick(TimeEventArgs time) { AmbientTick?.Invoke(this, time); @@ -150,6 +165,7 @@ namespace Tizen.Applications /// If base.OnAmbientChanged() is not called, the event 'AmbientChanged' will not be emitted. /// /// The received AmbientEventArgs + /// 4 protected virtual void OnAmbientChanged(AmbientEventArgs mode) { AmbientChanged?.Invoke(this, mode); @@ -182,6 +198,7 @@ namespace Tizen.Applications /// } /// /// + /// 4 protected WatchTime GetCurrentTime() { SafeWatchTimeHandle handle; @@ -225,6 +242,7 @@ namespace Tizen.Applications /// } /// /// + /// 4 protected AmbientTickType GetAmbientTickType() { AmbientTickType ambientTickType; @@ -269,6 +287,7 @@ namespace Tizen.Applications /// } /// /// + /// 4 protected void SetAmbientTickType(AmbientTickType ambientTickType) { Interop.Watch.ErrorCode err = Interop.Watch.SetAmbientTickType(ambientTickType); @@ -310,6 +329,7 @@ namespace Tizen.Applications /// } /// /// + /// 4 protected void SetTimeTickFrequency(int ticks, TimeTickResolution type) { Interop.Watch.ErrorCode err = Interop.Watch.SetTimeTickFrequency(ticks, type); @@ -351,6 +371,7 @@ namespace Tizen.Applications /// } /// /// + /// 4 protected void GetTimeTickFrequency(out int ticks, out TimeTickResolution type) { Interop.Watch.ErrorCode err = Interop.Watch.GetTimeTickFrequency(out ticks, out type); diff --git a/src/Tizen.Applications.WatchApplication/Tizen.Applications/WatchTime.cs b/src/Tizen.Applications.WatchApplication/Tizen.Applications/WatchTime.cs index e39434c..61e72d0 100755 --- a/src/Tizen.Applications.WatchApplication/Tizen.Applications/WatchTime.cs +++ b/src/Tizen.Applications.WatchApplication/Tizen.Applications/WatchTime.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// The information of Watch Time /// + /// 4 public class WatchTime { private readonly SafeWatchTimeHandle _handle; @@ -36,6 +37,7 @@ namespace Tizen.Applications /// /// http://tizen.org/feature/watch_app /// Thrown when the property is not supported. + /// 4 public int Year { get @@ -59,6 +61,7 @@ namespace Tizen.Applications /// /// http://tizen.org/feature/watch_app /// Thrown when the property is not supported. + /// 4 public int Month { get @@ -82,6 +85,7 @@ namespace Tizen.Applications /// /// http://tizen.org/feature/watch_app /// Thrown when the property is not supported. + /// 4 public int Day { get @@ -105,6 +109,7 @@ namespace Tizen.Applications /// /// http://tizen.org/feature/watch_app /// Thrown when the property is not supported. + /// 4 public int DayOfWeek { get @@ -128,6 +133,7 @@ namespace Tizen.Applications /// /// http://tizen.org/feature/watch_app /// Thrown when the property is not supported. + /// 4 public int Hour { get @@ -151,6 +157,7 @@ namespace Tizen.Applications /// /// http://tizen.org/feature/watch_app /// Thrown when the property is not supported. + /// 4 public int Hour24 { get @@ -174,6 +181,7 @@ namespace Tizen.Applications /// /// http://tizen.org/feature/watch_app /// Thrown when the property is not supported. + /// 4 public int Minute { get @@ -197,6 +205,7 @@ namespace Tizen.Applications ///
/// http://tizen.org/feature/watch_app /// Thrown when the property is not supported. + /// 4 public int Second { get @@ -220,6 +229,7 @@ namespace Tizen.Applications ///
/// http://tizen.org/feature/watch_app /// Thrown when the property is not supported. + /// 4 public int Millisecond { get @@ -243,6 +253,7 @@ namespace Tizen.Applications ///
/// http://tizen.org/feature/watch_app /// Thrown when the property is not supported. + /// 4 public string TimeZone { get @@ -266,6 +277,7 @@ namespace Tizen.Applications ///
/// http://tizen.org/feature/watch_app /// Thrown when the property is not supported. + /// 4 public DateTime UtcTimestamp { get diff --git a/src/Tizen.Applications.WidgetApplication/Tizen.Applications/WidgetApplication.cs b/src/Tizen.Applications.WidgetApplication/Tizen.Applications/WidgetApplication.cs index ba8edc1..1907a41 100755 --- a/src/Tizen.Applications.WidgetApplication/Tizen.Applications/WidgetApplication.cs +++ b/src/Tizen.Applications.WidgetApplication/Tizen.Applications/WidgetApplication.cs @@ -23,12 +23,14 @@ namespace Tizen.Applications /// /// Represents a widget application. /// + /// 3 public class WidgetApplication : CoreApplication { /// /// Initializes the WidgetApplication class with the type and application ID. /// /// Map structure for the derived class type and widget ID. + /// 3 public WidgetApplication(IDictionary typeInfo) : base(new WidgetCoreBackend()) { WidgetCoreBackend core = Backend as WidgetCoreBackend; @@ -41,6 +43,7 @@ namespace Tizen.Applications ///
/// Widget ID will be replaced as the application ID. /// Derived class type. + /// 3 public WidgetApplication(Type type) : base(new WidgetCoreBackend()) { WidgetCoreBackend core = Backend as WidgetCoreBackend; @@ -52,6 +55,7 @@ namespace Tizen.Applications /// Gets all instances of the widget associated with the type. ///
/// Class type for the widget. + /// 3 public IEnumerable GetInstances(Type type) { WidgetCoreBackend core = Backend as WidgetCoreBackend; @@ -74,6 +78,7 @@ namespace Tizen.Applications /// Runs the widget application's main loop. ///
/// Arguments from the commandline. + /// 3 public override void Run(string[] args) { base.Run(args); diff --git a/src/Tizen.Applications.WidgetApplication/Tizen.Applications/WidgetBase.cs b/src/Tizen.Applications.WidgetApplication/Tizen.Applications/WidgetBase.cs index 5aa1872..26e8400 100755 --- a/src/Tizen.Applications.WidgetApplication/Tizen.Applications/WidgetBase.cs +++ b/src/Tizen.Applications.WidgetApplication/Tizen.Applications/WidgetBase.cs @@ -22,6 +22,7 @@ namespace Tizen.Applications /// /// The abstract class for widget instances. /// + /// 3 public abstract class WidgetBase { internal IntPtr Handle; @@ -32,11 +33,13 @@ namespace Tizen.Applications /// Window object for this widget instance. /// It will be created after OnCreate method is invoked. ///
+ /// 3 protected Window Window; /// /// Delete type. /// + /// 3 public enum WidgetDestroyType { /// @@ -53,6 +56,7 @@ namespace Tizen.Applications /// /// Constructor. /// + /// 3 public WidgetBase() { } @@ -64,6 +68,7 @@ namespace Tizen.Applications /// Thrown when failed because of an invalid argument. /// Thrown when the API is not supported in this device. /// Thrown in case of an unrecoverable error. + /// 3 public void SetContent(Bundle info) { Interop.Widget.ErrorCode err = Interop.Widget.SetContent(Handle, info.SafeBundleHandle); @@ -95,6 +100,7 @@ namespace Tizen.Applications /// Thrown when failed because of an invalid argument. /// Thrown when the API is not supported in this device. /// Thrown in case of an unrecoverable error. + /// 3 public void SetTitle(string title) { Interop.Widget.ErrorCode err = Interop.Widget.SetTitle(Handle, title); @@ -123,6 +129,7 @@ namespace Tizen.Applications /// /// Thrown when the API is not supported in this device. /// Thrown in case of an unrecoverable error. + /// 3 public void Exit() { Interop.Widget.ErrorCode err = Interop.Widget.TerminateContext(Handle); @@ -155,6 +162,7 @@ namespace Tizen.Applications /// The data set for the previous status. /// The pixel value for the widget width. /// The pixel value for the widget height. + /// 3 public virtual void OnCreate(Bundle content, int w, int h) { IntPtr win; @@ -170,6 +178,7 @@ namespace Tizen.Applications ///
/// The reason for destruction. /// The data set to save. + /// 3 public virtual void OnDestroy(WidgetDestroyType reason, Bundle content) { } @@ -177,6 +186,7 @@ namespace Tizen.Applications /// /// Overrides this method if want to handle the behavior when the widget instance is paused. /// + /// 3 public virtual void OnPause() { } @@ -184,6 +194,7 @@ namespace Tizen.Applications /// /// Overrides this method if want to handle the behavior when the widget instance is resumed. /// + /// 3 public virtual void OnResume() { } @@ -193,6 +204,7 @@ namespace Tizen.Applications ///
/// Widget width. /// Widget height. + /// 3 public virtual void OnResize(int w, int h) { } @@ -202,6 +214,7 @@ namespace Tizen.Applications ///
/// The data set for updating this widget will be provided by the requester. /// Although the widget is paused, if it is true, the widget can be updated. + /// 3 public virtual void OnUpdate(Bundle content, bool isForce) { } diff --git a/src/Tizen.Applications.WidgetControl/Tizen.Applications/WidgetControl.cs b/src/Tizen.Applications.WidgetControl/Tizen.Applications/WidgetControl.cs index c4beb30..ff6906a 100755 --- a/src/Tizen.Applications.WidgetControl/Tizen.Applications/WidgetControl.cs +++ b/src/Tizen.Applications.WidgetControl/Tizen.Applications/WidgetControl.cs @@ -24,12 +24,14 @@ namespace Tizen.Applications /// /// The class for receiving widget events and sending data to the widget. /// + /// 3 public class WidgetControl : IDisposable { private const string LogTag = "Tizen.Applications.WidgetControl"; /// /// Class for the widget instance. /// + /// 3 public class Instance { private string _widgetId; @@ -131,6 +133,7 @@ namespace Tizen.Applications /// /// The class for the widget size information. /// + /// 3 public class Scale { diff --git a/src/Tizen.Applications.WidgetControl/Tizen.Applications/WidgetLifecycleEventArgs.cs b/src/Tizen.Applications.WidgetControl/Tizen.Applications/WidgetLifecycleEventArgs.cs index 87ffc59..d388282 100755 --- a/src/Tizen.Applications.WidgetControl/Tizen.Applications/WidgetLifecycleEventArgs.cs +++ b/src/Tizen.Applications.WidgetControl/Tizen.Applications/WidgetLifecycleEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Applications /// /// The class for event arguments of the widget lifecycle. /// + /// 3 public class WidgetLifecycleEventArgs : EventArgs { internal WidgetLifecycleEventArgs() @@ -30,6 +31,7 @@ namespace Tizen.Applications /// /// Enumeration for the event type. /// + /// 3 public enum EventType { /// @@ -56,16 +58,19 @@ namespace Tizen.Applications /// /// The widget ID. /// + /// 3 public string WidgetId { get; internal set; } /// /// The widget instance ID. /// + /// 3 public string InstanceId { get; internal set; } /// /// The event type. /// + /// 3 public EventType Type { get; internal set; } } } diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Album.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Album.cs index 9bb2d2b..ccb4dd3 100755 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Album.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Album.cs @@ -22,6 +22,7 @@ namespace Tizen.Content.MediaContent /// Represents a logical collection grouping of related media information. /// /// + /// 3 public class Album { internal Album(IntPtr handle) @@ -39,30 +40,35 @@ namespace Tizen.Content.MediaContent /// Gets the ID of the album. ///
/// The unique ID of the album. + /// 3 public int Id { get; } /// /// Gets the artist name of the album. /// /// The artist name. + /// 3 public string Artist { get; } /// /// Gets the path to the album art. /// /// The path to the album art. + /// 4 public string AlbumArtPath { get; } /// /// Gets the name of the album. /// /// The album name. + /// 3 public string Name { get; } /// /// Returns a string representation of the album. /// /// A string representation of the current album. + /// 4 public override string ToString() => $"Id={Id}, Name={Name}, Artist={Artist}, AlbumArtPath={AlbumArtPath}"; } diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/AlbumCommand.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/AlbumCommand.cs index 42abf3d..4a857a2 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/AlbumCommand.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/AlbumCommand.cs @@ -22,6 +22,7 @@ namespace Tizen.Content.MediaContent /// Provides commands to manage albums in the database. ///
/// + /// 4 public class AlbumCommand : MediaCommand { /// @@ -30,6 +31,7 @@ namespace Tizen.Content.MediaContent /// The that the commands run on. /// is null. /// has already been disposed of. + /// 4 public AlbumCommand(MediaDatabase database) : base(database) { } @@ -41,6 +43,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public int Count() { return Count(null); @@ -54,6 +57,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public int Count(CountArguments arguments) { ValidateDatabase(); @@ -68,6 +72,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader Select() { return Select(null); @@ -81,6 +86,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader Select(SelectArguments filter) { ValidateDatabase(); @@ -97,6 +103,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// is equal to or less than zero. /// An error occurred while executing the command. + /// 4 public Album Select(int albumId) { ValidateDatabase(); @@ -129,6 +136,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// is equal to or less than zero. /// An error occurred while executing the command. + /// 4 public int CountMember(int albumId) { return CountMember(albumId, null); @@ -144,6 +152,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// is equal to or less than zero. /// An error occurred while executing the command. + /// 4 public int CountMember(int albumId, CountArguments arguments) { ValidateDatabase(); @@ -165,6 +174,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader SelectMember(int albumId) { return SelectMember(albumId, null); @@ -179,6 +189,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader SelectMember(int albumId, SelectArguments filter) { ValidateDatabase(); diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/AudioInfo.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/AudioInfo.cs index ecfda74..6e1bd00 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/AudioInfo.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/AudioInfo.cs @@ -22,6 +22,7 @@ namespace Tizen.Content.MediaContent /// /// Represents the audio media information. /// + /// 4 public class AudioInfo : MediaInfo { internal AudioInfo(Interop.MediaInfoHandle handle) : base(handle) @@ -61,84 +62,98 @@ namespace Tizen.Content.MediaContent /// Gets the album name. /// /// The album from the metadata. + /// 4 public string Album { get; } /// /// Gets the artist name. /// /// The artist from the metadata. + /// 4 public string Artist { get; } /// /// Gets the album artist name. /// /// The album artist from the metadata. + /// 4 public string AlbumArtist { get; } /// /// Gets the genre. /// /// The genre from the metadata. + /// 4 public string Genre { get; } /// /// Gets the composer. /// /// The composer from the metadata. + /// 4 public string Composer { get; } /// /// Gets the year. /// /// The year from the metadata. + /// 4 public string Year { get; } /// /// Gets the recorded date. /// /// The recorded date from the metadata. + /// 4 public string DateRecorded { get; } /// /// Gets the copyright. /// /// The copyright from the metadata. + /// 4 public string Copyright { get; } /// /// Gets the track number. /// /// The track number from the metadata. + /// 4 public string TrackNumber { get; } /// /// Gets the bit rate in bit per second. /// /// The bit rate in bit per second. + /// 4 public int BitRate { get; } /// /// Gets the bit per sample. /// /// The bit per sample. + /// 4 public int BitPerSample { get; } /// /// Gets the sample rate in hertz. /// /// The sample rate in hertz. + /// 4 public int SampleRate { get; } /// /// Gets the number of channels. /// /// The number of channels. + /// 4 public int Channels { get; } /// /// Gets the track duration in milliseconds. /// /// The track duration in milliseconds. + /// 4 public int Duration { get; } } } diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Bookmark.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Bookmark.cs index f1c8d5f..2da1b7e 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Bookmark.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Bookmark.cs @@ -22,6 +22,7 @@ namespace Tizen.Content.MediaContent /// Represents the media bookmark that allows you to mark an interesting moment /// in media (video and audio) to enable fast searching. ///
+ /// 4 public class Bookmark { internal Bookmark(IntPtr handle) @@ -36,24 +37,28 @@ namespace Tizen.Content.MediaContent /// Gets the ID of the bookmark. ///
/// The ID of the bookmark. + /// 4 public int Id { get; } /// /// Gets the thumbnail path of the bookmark. /// /// The thumbnail path of the bookmark. + /// 4 public string ThumbnailPath { get; } /// /// Gets the offset in milliseconds. /// /// The offset of the bookmark in media in milliseconds. + /// 4 public int Offset { get; } /// /// Gets the name of the bookmark. /// /// The name of the bookmark. + /// 4 public string Name { get; } internal static Bookmark FromHandle(IntPtr handle) => new Bookmark(handle); @@ -62,6 +67,7 @@ namespace Tizen.Content.MediaContent /// Returns a string representation of the bookmark. ///
/// A string representation of the current bookmark. + /// 4 public override string ToString() => $"Id={Id}, Name={Name}, ThumbnailPath={ThumbnailPath}, Offset={Offset}"; } diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/BookmarkCommand.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/BookmarkCommand.cs index a99383a..fd77a4c 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/BookmarkCommand.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/BookmarkCommand.cs @@ -22,6 +22,7 @@ namespace Tizen.Content.MediaContent /// Provides commands to manage bookmarks in the database. ///
/// + /// 4 public class BookmarkCommand : MediaCommand { /// @@ -30,6 +31,7 @@ namespace Tizen.Content.MediaContent /// The that the commands run on. /// is null. /// has already been disposed of. + /// 4 public BookmarkCommand(MediaDatabase database) : base(database) { } @@ -41,6 +43,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public int Count() { return Count(null); @@ -54,6 +57,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public int Count(CountArguments arguments) { ValidateDatabase(); @@ -74,6 +78,7 @@ namespace Tizen.Content.MediaContent /// is null. /// is a zero-length string, contains only white space. /// The caller has no required privilege. + /// 4 public Bookmark Insert(string mediaId, int offset) { return Insert(mediaId, offset, null); @@ -93,6 +98,7 @@ namespace Tizen.Content.MediaContent /// is null. /// is a zero-length string, contains only white space. /// The caller has no required privilege. + /// 4 public Bookmark Insert(string mediaId, int offset, string name) { return Insert(mediaId, offset, name, null); @@ -116,6 +122,7 @@ namespace Tizen.Content.MediaContent /// is null. /// is a zero-length string, contains only white space. /// The caller has no required privilege. + /// 4 public Bookmark Insert(string mediaId, int offset, string name, string thumbnailPath) { ValidateDatabase(); @@ -155,6 +162,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is less than zero. /// The caller has no required privilege. + /// 4 public bool Delete(int bookmarkId) { ValidateDatabase(); @@ -183,6 +191,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader Select() { return Select(null); @@ -196,6 +205,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader Select(SelectArguments filter) { ValidateDatabase(); diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Columns.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Columns.cs index 8b2d7a9..819fe5a 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Columns.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Columns.cs @@ -46,6 +46,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static class MediaInfoColumns { /// @@ -54,6 +55,7 @@ namespace Tizen.Content.MediaContent /// The column name for the ID of media. /// The value type is string. /// + /// 4 public static string Id => "MEDIA_ID"; /// @@ -62,6 +64,7 @@ namespace Tizen.Content.MediaContent /// The column name for the file path of media. /// The value type is string. /// + /// 4 public static string Path => "MEDIA_PATH"; /// @@ -70,6 +73,7 @@ namespace Tizen.Content.MediaContent /// The column name for the display name of media. /// The value type is string. /// + /// 4 public static string DisplayName => "MEDIA_DISPLAY_NAME"; /// @@ -81,6 +85,7 @@ namespace Tizen.Content.MediaContent /// The value should be an integer that is one of the values. /// /// + /// 4 public static string MediaType => "MEDIA_TYPE"; /// @@ -89,6 +94,7 @@ namespace Tizen.Content.MediaContent /// The column name for the mime type of media. /// The value type is string. /// + /// 4 public static string MimeType => "MEDIA_MIME_TYPE"; /// @@ -97,6 +103,7 @@ namespace Tizen.Content.MediaContent /// The column name for the file size of media. /// The value type is integer. /// + /// 4 public static string FileSize => "MEDIA_SIZE"; /// @@ -109,6 +116,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string DateAdded => "MEDIA_ADDED_TIME"; /// @@ -121,6 +129,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string DateModified => "MEDIA_MODIFIED_TIME"; /// @@ -133,6 +142,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string Timeline => "MEDIA_TIMELINE"; /// @@ -143,6 +153,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string ThumbnailPath => "MEDIA_THUMBNAIL_PATH"; /// @@ -153,6 +164,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string Title => "MEDIA_TITLE"; /// @@ -163,6 +175,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string Album => "MEDIA_ALBUM"; /// @@ -174,6 +187,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string Artist => "MEDIA_ARTIST"; /// @@ -185,6 +199,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string AlbumArtist => "MEDIA_ALBUM_ARTIST"; /// @@ -196,6 +211,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string Genre => "MEDIA_GENRE"; /// @@ -207,6 +223,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string Composer => "MEDIA_COMPOSER"; /// @@ -218,6 +235,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string Year => "MEDIA_YEAR"; /// @@ -229,6 +247,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string DateRecorded => "MEDIA_RECORDED_DATE"; /// @@ -240,6 +259,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string Copyright => "MEDIA_COPYRIGHT"; /// @@ -251,6 +271,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string TrackNumber => "MEDIA_TRACK_NUM"; /// @@ -261,6 +282,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string Description => "MEDIA_DESCRIPTION"; /// @@ -272,6 +294,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string BitRate => "MEDIA_BITRATE"; /// @@ -282,6 +305,7 @@ namespace Tizen.Content.MediaContent /// The value type is integer. /// /// + /// 4 public static string BitPerSample => "MEDIA_BITPERSAMPLE"; /// @@ -292,6 +316,7 @@ namespace Tizen.Content.MediaContent /// The value type is integer. /// /// + /// 4 public static string SampleRate => "MEDIA_SAMPLERATE"; /// @@ -302,6 +327,7 @@ namespace Tizen.Content.MediaContent /// The value type is integer. /// /// + /// 4 public static string Channels => "MEDIA_CHANNEL"; /// @@ -313,6 +339,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string Duration => "MEDIA_DURATION"; /// @@ -323,6 +350,7 @@ namespace Tizen.Content.MediaContent /// The value type is real. /// /// + /// 4 public static string Longitude => "MEDIA_LONGITUDE"; /// @@ -333,6 +361,7 @@ namespace Tizen.Content.MediaContent /// The value type is real. /// /// + /// 4 public static string Latitude => "MEDIA_LATITUDE"; /// @@ -343,6 +372,7 @@ namespace Tizen.Content.MediaContent /// The value type is real. /// /// + /// 4 public static string Altitude => "MEDIA_ALTITUDE"; /// @@ -354,6 +384,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string Width => "MEDIA_WIDTH"; /// @@ -365,6 +396,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string Height => "MEDIA_HEIGHT"; /// @@ -375,6 +407,7 @@ namespace Tizen.Content.MediaContent /// The value type is integer. /// /// + /// 4 public static string DateTaken => "MEDIA_DATETAKEN"; /// @@ -387,6 +420,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string Orientation => "MEDIA_ORIENTATION"; /// @@ -397,6 +431,7 @@ namespace Tizen.Content.MediaContent /// The value type is integer. /// /// + /// 4 public static string Rating => "MEDIA_RATING"; /// @@ -407,6 +442,7 @@ namespace Tizen.Content.MediaContent /// The value type is integer (1 : true, 0 : false). /// /// + /// 4 public static string Favorite => "MEDIA_FAVOURITE"; /// @@ -417,6 +453,7 @@ namespace Tizen.Content.MediaContent /// The value type is integer (1 : true, 0 : false). /// /// + /// 4 public static string IsDrm => "MEDIA_IS_DRM"; /// @@ -428,6 +465,7 @@ namespace Tizen.Content.MediaContent /// The value should be an integer that is one of the values. /// /// + /// 4 public static string StorageType => "MEDIA_STORAGE_TYPE"; /// @@ -438,6 +476,7 @@ namespace Tizen.Content.MediaContent /// The value type is integer. /// /// + /// 4 public static string ExposureTime => "MEDIA_EXPOSURE_TIME"; /// @@ -448,6 +487,7 @@ namespace Tizen.Content.MediaContent /// The value type is integer. /// /// + /// 4 public static string FNumber => "MEDIA_FNUMBER"; /// @@ -458,6 +498,7 @@ namespace Tizen.Content.MediaContent /// The value type is integer. /// /// + /// 4 public static string Iso => "MEDIA_ISO"; /// @@ -468,6 +509,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string Model => "MEDIA_MODEL"; } @@ -480,6 +522,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static class AlbumColumns { /// @@ -490,6 +533,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string Name => "MEDIA_ALBUM"; /// @@ -500,6 +544,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string Artist => "MEDIA_ARTIST"; } @@ -512,6 +557,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static class FolderColumns { /// @@ -522,6 +568,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string Id => "FOLDER_ID"; /// @@ -532,6 +579,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string Path => "FOLDER_PATH"; /// @@ -542,6 +590,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string Name => "FOLDER_NAME"; /// @@ -553,6 +602,7 @@ namespace Tizen.Content.MediaContent /// The value should be an integer that is one of the values. /// /// + /// 4 public static string StorageType => "FOLDER_STORAGE_TYPE"; } @@ -565,6 +615,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static class PlaylistColumns { /// @@ -575,6 +626,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string Name => "PLAYLIST_NAME"; /// @@ -585,6 +637,7 @@ namespace Tizen.Content.MediaContent /// The value type is integer. /// /// + /// 4 public static string Id => "PLAYLIST_ID"; /// @@ -595,6 +648,7 @@ namespace Tizen.Content.MediaContent /// The value type is integer. /// /// + /// 4 public static string MemberOrder => "PLAYLIST_MEMBER_ORDER"; /// @@ -606,6 +660,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string Count => "PLAYLIST_MEDIA_COUNT"; } @@ -622,6 +677,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static class TagColumns { /// @@ -632,6 +688,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string Name => "TAG_NAME"; /// @@ -643,6 +700,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static string Count => "TAG_MEDIA_COUNT"; /// @@ -653,6 +711,7 @@ namespace Tizen.Content.MediaContent /// The value type is integer. /// /// + /// 4 public static string Id => "TAG_ID"; } @@ -667,6 +726,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static class BookmarkColumns { /// @@ -677,6 +737,7 @@ namespace Tizen.Content.MediaContent /// The value type is integer. /// /// + /// 4 public static string Offset => "BOOKMARK_MARKED_TIME"; /// @@ -687,6 +748,7 @@ namespace Tizen.Content.MediaContent /// The value type is integer. /// /// + /// 4 public static string Id => "BOOKMARK_ID"; /// @@ -697,6 +759,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string Name => "BOOKMARK_NAME"; } @@ -710,6 +773,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static class FaceInfoColumns { /// @@ -720,6 +784,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string Tag => "MEDIA_FACE_TAG"; /// @@ -730,6 +795,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string Id => "MEDIA_FACE_ID"; } @@ -742,6 +808,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public static class StorageColumns { /// @@ -752,6 +819,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string Id => "STORAGE_ID"; /// @@ -762,6 +830,7 @@ namespace Tizen.Content.MediaContent /// The value type is string. /// /// + /// 4 public static string Path => "STORAGE_PATH"; /// @@ -773,6 +842,7 @@ namespace Tizen.Content.MediaContent /// The value should be an integer that is one of the values. /// /// + /// 4 public static string Type => "MEDIA_STORAGE_TYPE"; } } diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Enums.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Enums.cs index f020dfc..5a5e19c 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Enums.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Enums.cs @@ -42,6 +42,7 @@ namespace Tizen.Content.MediaContent /// /// Specifies the storage types. /// + /// 4 public enum StorageType { /// @@ -63,6 +64,7 @@ namespace Tizen.Content.MediaContent /// /// Specifies database operation types. /// + /// 4 public enum OperationType { /// @@ -90,6 +92,7 @@ namespace Tizen.Content.MediaContent /// /// Specifies types of the . /// + /// 4 public enum MediaType { /// @@ -125,6 +128,7 @@ namespace Tizen.Content.MediaContent /// /// Specifies orientation types of media. /// + /// 4 public enum Orientation { /// diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/EventArgs.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/EventArgs.cs index 8a5e559..da82fbe 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/EventArgs.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/EventArgs.cs @@ -22,6 +22,7 @@ namespace Tizen.Content.MediaContent /// /// Provides data for the event. /// + /// 4 public class MediaInfoUpdatedEventArgs : EventArgs { internal MediaInfoUpdatedEventArgs(int pid, @@ -40,6 +41,7 @@ namespace Tizen.Content.MediaContent /// Gets the process ID which triggers the event. /// /// The process ID which triggers the event. + /// 4 public int ProcessId { get; @@ -49,6 +51,7 @@ namespace Tizen.Content.MediaContent /// Gets the operation type. /// /// The operation type which triggers the event. + /// 4 public OperationType OperationType { get; @@ -58,6 +61,7 @@ namespace Tizen.Content.MediaContent /// Gets the ID of the media updated. /// /// The ID of the media updated. + /// 4 public string Id { get; @@ -67,6 +71,7 @@ namespace Tizen.Content.MediaContent /// Gets the path of the media updated. /// /// The path of the media updated. + /// 4 public string Path { get; @@ -76,6 +81,7 @@ namespace Tizen.Content.MediaContent /// Gets the type of the media updated. /// /// The of the media updated. + /// 4 public MediaType MediaType { get; @@ -85,6 +91,7 @@ namespace Tizen.Content.MediaContent /// The MIME type of the media updated. /// /// The MIME type of the media updated. + /// 4 public string MimeType { get; @@ -95,6 +102,7 @@ namespace Tizen.Content.MediaContent /// /// Provides data for the event. /// + /// 4 public class FolderUpdatedEventArgs : EventArgs { internal FolderUpdatedEventArgs(OperationType operationType, string id, string path) @@ -108,6 +116,7 @@ namespace Tizen.Content.MediaContent /// Gets the operation type. /// /// The operation type which triggers the event. + /// 4 public OperationType OperationType { get; @@ -117,6 +126,7 @@ namespace Tizen.Content.MediaContent /// Gets the ID of the folder updated. /// /// The ID of the folder updated. + /// 4 public string Id { get; @@ -126,6 +136,7 @@ namespace Tizen.Content.MediaContent /// Gets the path of the folder updated. /// /// The path of the folder updated. + /// 4 public string Path { get; diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/FaceInfo.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/FaceInfo.cs index a92aeee..53adc29 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/FaceInfo.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/FaceInfo.cs @@ -21,6 +21,7 @@ namespace Tizen.Content.MediaContent /// /// Represents the face information for the media. /// + /// 4 public class FaceInfo { internal FaceInfo(IntPtr handle) @@ -49,30 +50,35 @@ namespace Tizen.Content.MediaContent /// /// The coordinates of the rectangle are orientation-applied values. /// + /// 4 public Rectangle Rect { get; } /// /// Gets the ID of face information. /// /// The unique ID of face information. + /// 4 public string Id { get; } /// /// Gets the media ID that the face information is added. /// /// The media ID that the face information is added. + /// 4 public string MediaInfoId { get; } /// /// Gets the tag. /// /// The tag of face information. + /// 4 public string Tag { get; } /// /// Gets the orientation of face information. /// /// The orientation of face information. + /// 4 public Orientation Orientation { get; } internal static FaceInfo FromHandle(IntPtr handle) @@ -84,6 +90,7 @@ namespace Tizen.Content.MediaContent /// Returns a string representation of the face information. /// /// A string representation of the current face info. + /// 4 public override string ToString() => $"Id={Id}, MediaInfoId={MediaInfoId}, Rect=({Rect}), Tag={Tag}"; } diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/FaceInfoCommand.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/FaceInfoCommand.cs index ed9c1c2..aee0da0 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/FaceInfoCommand.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/FaceInfoCommand.cs @@ -22,6 +22,7 @@ namespace Tizen.Content.MediaContent /// Provides commands to manage face information in the database. /// /// + /// 4 public class FaceInfoCommand : MediaCommand { /// @@ -30,6 +31,7 @@ namespace Tizen.Content.MediaContent /// The that the commands run on. /// is null. /// has already been disposed of. + /// 4 public FaceInfoCommand(MediaDatabase database) : base(database) { } @@ -46,6 +48,7 @@ namespace Tizen.Content.MediaContent /// is null. /// is a zero-length string, contains only white space. /// The caller has no required privilege. + /// 4 public bool Delete(string faceInfoId) { ValidateDatabase(); @@ -70,6 +73,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader Select() { return Select(null); @@ -83,6 +87,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader Select(SelectArguments filter) { ValidateDatabase(); @@ -103,6 +108,7 @@ namespace Tizen.Content.MediaContent /// is null. /// is a zero-length string, contains only white space. /// The caller has no required privilege. + /// 4 public bool UpdateTag(string faceInfoId, string tag) { ValidateDatabase(); diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Folder.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Folder.cs index 3aed397..0da577a 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Folder.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Folder.cs @@ -25,6 +25,7 @@ namespace Tizen.Content.MediaContent /// The is used to organize media content files, i.e., image, audio, and video files, /// in the physical storage of the device. /// + /// 4 public class Folder { internal Folder(IntPtr handle) @@ -43,36 +44,42 @@ namespace Tizen.Content.MediaContent /// Gets the ID of the folder. /// /// The unique ID of the folder. + /// 4 public string Id { get; } /// /// Gets the path of the folder. /// /// The path of the folder. + /// 4 public string Path { get; } /// /// Gets the name of the folder. /// /// The name of the folder. + /// 4 public string Name { get; } /// /// Gets the of the storage that the folder exists. /// /// The of the storage that the folder exists. + /// 4 public StorageType StorageType { get; } /// /// Gets the storage ID of the storage that the folder exists. /// /// The storage ID of the storage that the folder exists. + /// 4 public string StorageId { get; } /// /// Returns a string representation of the folder. /// /// A string representation of the current folder. + /// 4 public override string ToString() => $"Id={Id}, Name={Name}, Path={Path}, StorageType={StorageType}, StorageId={StorageType}"; } diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/FolderCommand.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/FolderCommand.cs index abfdd12..31712ec 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/FolderCommand.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/FolderCommand.cs @@ -21,6 +21,7 @@ namespace Tizen.Content.MediaContent /// /// Provides commands to manage folders and query related media items in the database. /// + /// 4 public class FolderCommand : MediaCommand { /// @@ -29,6 +30,7 @@ namespace Tizen.Content.MediaContent /// The that the commands run on. /// is null. /// has already been disposed of. + /// 4 public FolderCommand(MediaDatabase database) : base(database) { } @@ -40,6 +42,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public int Count() { return Count(null); @@ -53,6 +56,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public int Count(CountArguments arguments) { ValidateDatabase(); @@ -67,6 +71,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader Select() { return Select(arguments: null); @@ -80,6 +85,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader Select(SelectArguments arguments) { ValidateDatabase(); @@ -97,6 +103,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public Folder Select(string folderId) { ValidateDatabase(); @@ -130,6 +137,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public int CountMedia(string folderId) { return CountMedia(folderId, null); @@ -146,6 +154,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public int CountMedia(string folderId, CountArguments arguments) { ValidateDatabase(); @@ -165,6 +174,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public MediaDataReader SelectMedia(string folderId) { return SelectMedia(folderId, null); @@ -181,6 +191,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public MediaDataReader SelectMedia(string folderId, SelectArguments filter) { ValidateDatabase(); diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/ImageInfo.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/ImageInfo.cs index 8562b23..4fc3682 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/ImageInfo.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/ImageInfo.cs @@ -22,6 +22,7 @@ namespace Tizen.Content.MediaContent /// /// Represents the image media stored in the device. /// + /// 4 public class ImageInfo : MediaInfo { internal ImageInfo(Interop.MediaInfoHandle handle) : base(handle) @@ -58,48 +59,56 @@ namespace Tizen.Content.MediaContent /// Gets the image width in pixels. /// /// The image width in pixels. + /// 4 public int Width { get; } /// /// Gets the image height in pixels. /// /// The image height in pixels. + /// 4 public int Height { get; } /// /// Gets the orientation of image. /// /// The orientation of image. + /// 4 public Orientation Orientation { get; } /// /// Gets the date of the creation time as a formatted string. /// /// The date of the creation time as a formatted string. + /// 4 public string DateTaken { get; } /// /// Gets the exposure time from EXIF. /// /// The exposure time from EXIF. + /// 4 public string ExposureTime { get; } /// /// Gets the FNumber from EXIF. /// /// The FNumber from EXIF. + /// 4 public double FNumber { get; } /// /// Gets the ISO from EXIF. /// /// The iso from EXIF. + /// 4 public int Iso { get; } /// /// Gets the model from EXIF. /// /// The model from EXIF. + /// 4 public string Model { get; } } } diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaCommand.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaCommand.cs index 41e5e36..1ca4d37 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaCommand.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaCommand.cs @@ -22,6 +22,7 @@ namespace Tizen.Content.MediaContent /// /// The is a base class for command classes. /// + /// 4 public abstract class MediaCommand { /// @@ -30,6 +31,7 @@ namespace Tizen.Content.MediaContent /// The that the commands run on. /// is null. /// has already been disposed of. + /// 4 protected MediaCommand(MediaDatabase database) { Database = database ?? throw new ArgumentNullException(nameof(database)); @@ -49,24 +51,28 @@ namespace Tizen.Content.MediaContent /// Gets the . /// /// The which commands execute on. + /// 4 public MediaDatabase Database { get; } } /// /// Provides a means of reading results obtained by executing a query. /// + /// 4 public interface IMediaDataReader { /// /// Advances to the next record. /// /// true if there are more rows; otherwise false. + /// 4 bool Read(); /// /// Gets the current record. /// /// The current record object. + /// 4 object Current { get; } } @@ -74,6 +80,7 @@ namespace Tizen.Content.MediaContent /// Provides a means of reading results obtained by executing a query. /// /// + /// 4 public class MediaDataReader : IMediaDataReader, IDisposable { private readonly IEnumerator _enumerator; @@ -87,6 +94,7 @@ namespace Tizen.Content.MediaContent /// Gets the current record. /// /// The current record if the position is valid; otherwise null. + /// 4 public TRecord Current { get @@ -100,6 +108,7 @@ namespace Tizen.Content.MediaContent /// Advances to the next record. /// /// true if there are more rows; otherwise false. + /// 4 public bool Read() { ValidateNotDisposed(); @@ -115,6 +124,7 @@ namespace Tizen.Content.MediaContent /// Disposes of the resources (other than memory) used by the MediaDataReader. /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// 4 protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -126,6 +136,7 @@ namespace Tizen.Content.MediaContent /// /// Releases all resources used by the current instance. /// + /// 4 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaDatabase.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaDatabase.cs index 88e9d90..90a034f 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaDatabase.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaDatabase.cs @@ -24,11 +24,13 @@ namespace Tizen.Content.MediaContent /// /// Provides the ability to connect to and manage the database. /// + /// 4 public class MediaDatabase : IDisposable { /// /// Initializes a new instance of the class. /// + /// 4 public MediaDatabase() { } @@ -41,6 +43,7 @@ namespace Tizen.Content.MediaContent /// The database is already connected. /// The has already been disposed of. /// An error occurred while connecting. + /// 4 public void Connect() { ValidateNotDisposed(); @@ -64,6 +67,7 @@ namespace Tizen.Content.MediaContent /// The database is not connected. /// The has already been disposed of. /// An error occurred while connecting. + /// 4 public void Disconnect() { ValidateNotDisposed(); @@ -101,6 +105,7 @@ namespace Tizen.Content.MediaContent /// /// Occurs when there is a change for media in the database. /// + /// 4 public static event EventHandler MediaInfoUpdated { add @@ -154,6 +159,7 @@ namespace Tizen.Content.MediaContent /// /// Occurs when there is a change for the folder in the database. /// + /// 4 public static event EventHandler FolderUpdated { add @@ -217,6 +223,7 @@ namespace Tizen.Content.MediaContent /// contains a directory containing the ".scan_ignore" file. /// /// The caller has no required privilege. + /// 4 public void ScanFile(string path) { ValidateState(); @@ -250,6 +257,7 @@ namespace Tizen.Content.MediaContent /// -or-
/// contains a directory containing the ".scan_ignore" file. /// + /// 4 public Task ScanFolderAsync(string folderPath) { return ScanFolderAsync(folderPath, true); @@ -280,6 +288,7 @@ namespace Tizen.Content.MediaContent /// -or-
/// contains a directory containing the ".scan_ignore" file. /// + /// 4 public Task ScanFolderAsync(string folderPath, bool recursive) { return ScanFolderAsync(folderPath, recursive, CancellationToken.None); @@ -310,6 +319,7 @@ namespace Tizen.Content.MediaContent /// -or-
/// contains a directory containing the ".scan_ignore" file. /// + /// 4 public Task ScanFolderAsync(string folderPath, CancellationToken cancellationToken) { return ScanFolderAsync(folderPath, true, cancellationToken); @@ -341,6 +351,7 @@ namespace Tizen.Content.MediaContent /// -or-
/// contains a directory containing the ".scan_ignore" file. /// + /// 4 public Task ScanFolderAsync(string folderPath, bool recursive, CancellationToken cancellationToken) { ValidateState(); @@ -434,6 +445,7 @@ namespace Tizen.Content.MediaContent /// Disposes of the resources (other than memory) used by the MediaDatabase. ///
/// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// 4 protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -455,6 +467,7 @@ namespace Tizen.Content.MediaContent /// /// Releases all the resources. /// + /// 4 public void Dispose() { Dispose(true); @@ -464,6 +477,7 @@ namespace Tizen.Content.MediaContent /// Gets the value indicating whether the database has been disposed of. ///
/// true if the database has been disposed of; otherwise, false. + /// 4 public bool IsDisposed => _disposed; #endregion diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaDatabaseException.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaDatabaseException.cs index c94a5fe..b19309e 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaDatabaseException.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaDatabaseException.cs @@ -21,6 +21,7 @@ namespace Tizen.Content.MediaContent /// /// Specifies the database errors. /// + /// 4 public enum MediaDatabaseError { /// @@ -37,6 +38,7 @@ namespace Tizen.Content.MediaContent /// /// The exception that is thrown when a database operation failed. /// + /// 4 public class MediaDatabaseException : Exception { internal MediaDatabaseException(MediaDatabaseError error) : this(error, error.ToString()) @@ -57,6 +59,7 @@ namespace Tizen.Content.MediaContent /// Gets the error that causes the exception. /// /// The that causes the exception. + /// 4 public MediaDatabaseError Error { get; } } } diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaInfo.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaInfo.cs index 8ec0c56..38ea5f9 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaInfo.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaInfo.cs @@ -23,6 +23,7 @@ namespace Tizen.Content.MediaContent /// Represents the information related to the media stored. ///
/// + /// 4 public class MediaInfo { internal MediaInfo(Interop.MediaInfoHandle handle) @@ -62,48 +63,56 @@ namespace Tizen.Content.MediaContent /// Gets the ID of media. ///
/// The unique ID of media. + /// 4 public string Id { get; } /// /// Gets the path to media. /// /// The full path of the media file. + /// 4 public string Path { get; } /// /// Gets the name of media. /// /// The base name of the media file. + /// 4 public string DisplayName { get; } /// /// Gets the of media. /// /// The of media. + /// 4 public MediaType MediaType { get; } /// /// Gets the mime type from media. /// /// The mime type of media. + /// 4 public string MimeType { get; } /// /// Gets the file size of media in bytes. /// /// The file size of media in bytes. + /// 4 public long FileSize { get; } /// /// Gets the date of addition of media. /// /// The date of addition of media. + /// 4 public DateTimeOffset DateAdded { get; } /// /// Gets the date of modification of media. /// /// The date of modification of media. + /// 4 public DateTimeOffset DateModified { get; } /// @@ -113,78 +122,91 @@ namespace Tizen.Content.MediaContent /// The creation date if the file has the creation information (like recorded date or image creation date), /// otherwise the modified date. /// + /// 4 public DateTimeOffset Timeline { get; } /// /// Gets the thumbnail of media. /// /// The thumbnail path of media. + /// 4 public string ThumbnailPath { get; } /// /// Gets the description of media. /// /// The description from the metadata. + /// 4 public string Description { get; } /// /// Gets the longitude of media. /// /// The longitude. + /// 4 public double Longitude { get; } /// /// Gets the latitude of media. /// /// The latitude. + /// 4 public double Latitude { get; } /// /// Gets the altitude of media. /// /// The altitude. + /// 4 public double Altitude { get; } /// /// Gets the rating of media. /// /// The rating from the metadata. + /// 4 public int Rating { get; } /// /// Gets the favorite status of media. /// /// true if media is set as favorite, otherwise false. + /// 4 public bool IsFavorite { get; } /// /// Gets the title of media. /// /// The title of media. + /// 4 public string Title { get; } /// /// Gets the storage ID of the storage that the media is stored on. /// /// The storage ID of the storage that the media is stored on. + /// 4 public string StorageId { get; } /// /// Gets the value indicating whether the media is DRM-protected. /// /// A bool value indicating whether the media is DRM-protected. + /// 4 public bool IsDrm { get; } /// /// Gets the storage type of the storage that the media is stored on. /// /// The storage type of the storage that the media is stored on. + /// 4 public StorageType StorageType { get; } /// /// Returns a string representation of the media information. /// /// A string representation of the current media information. + /// 4 public override string ToString() => $"Id={Id}, Path={Path}, MediaType={MediaType}"; internal static MediaInfo FromHandle(Interop.MediaInfoHandle handle) diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaInfoColumnKey.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaInfoColumnKey.cs index a0031ba..9748bb1 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaInfoColumnKey.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaInfoColumnKey.cs @@ -19,6 +19,7 @@ namespace Tizen.Content.MediaContent /// /// Specifies the group keys for . /// + /// 4 public enum MediaInfoColumnKey { /// diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaInfoCommand.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaInfoCommand.cs index 1e52a97..874964f 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaInfoCommand.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/MediaInfoCommand.cs @@ -26,6 +26,7 @@ namespace Tizen.Content.MediaContent /// /// Provides commands to manage the media information and query related items in the database. /// + /// 4 public class MediaInfoCommand : MediaCommand { /// @@ -34,6 +35,7 @@ namespace Tizen.Content.MediaContent /// The that the commands run on. /// is null. /// has already been disposed of. + /// 4 public MediaInfoCommand(MediaDatabase database) : base(database) { } @@ -48,6 +50,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public int CountBookmark(string mediaId) { return CountBookmark(mediaId, null); @@ -64,6 +67,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public int CountBookmark(string mediaId, CountArguments arguments) { ValidateDatabase(); @@ -83,6 +87,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public MediaDataReader SelectBookmark(string mediaId) { return SelectBookmark(mediaId, null); @@ -99,6 +104,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public MediaDataReader SelectBookmark(string mediaId, SelectArguments filter) { ValidateDatabase(); @@ -119,6 +125,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public int CountFaceInfo(string mediaId) { return CountFaceInfo(mediaId, null); @@ -135,6 +142,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public int CountFaceInfo(string mediaId, CountArguments arguments) { ValidateDatabase(); @@ -154,6 +162,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public MediaDataReader SelectFaceInfo(string mediaId) { return SelectFaceInfo(mediaId, null); @@ -170,6 +179,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public MediaDataReader SelectFaceInfo(string mediaId, SelectArguments arguments) { ValidateDatabase(); @@ -190,6 +200,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public int CountTag(string mediaId) { return CountTag(mediaId, null); @@ -206,6 +217,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public int CountTag(string mediaId, CountArguments arguments) { ValidateDatabase(); @@ -225,6 +237,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public MediaDataReader SelectTag(string mediaId) { return SelectTag(mediaId, null); @@ -241,6 +254,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public MediaDataReader SelectTag(string mediaId, SelectArguments filter) { ValidateDatabase(); @@ -258,6 +272,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public int CountMedia() { return CountMedia(null); @@ -271,6 +286,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public int CountMedia(CountArguments arguments) { ValidateDatabase(); @@ -288,6 +304,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public MediaInfo SelectMedia(string mediaId) { ValidateDatabase(); @@ -316,6 +333,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// An error occurred while executing the command. /// is invalid. + /// 4 public int CountGroupBy(MediaInfoColumnKey columnKey) { return CountGroupBy(columnKey, null); @@ -331,6 +349,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// An error occurred while executing the command. /// is invalid. + /// 4 public int CountGroupBy(MediaInfoColumnKey columnKey, CountArguments arguments) { ValidateDatabase(); @@ -353,6 +372,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// An error occurred while executing the command. /// is invalid. + /// 4 public MediaDataReader SelectGroupBy(MediaInfoColumnKey columnKey) { return SelectGroupBy(columnKey, null); @@ -368,6 +388,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// An error occurred while executing the command. /// is invalid. + /// 4 public MediaDataReader SelectGroupBy(MediaInfoColumnKey columnKey, SelectArguments arguments) { ValidateDatabase(); @@ -396,6 +417,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader SelectMedia() { return SelectMedia(arguments: null); @@ -409,6 +431,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader SelectMedia(SelectArguments arguments) { ValidateDatabase(); @@ -460,6 +483,7 @@ namespace Tizen.Content.MediaContent /// is null. /// is a zero-length string, contains only white space. /// The caller has no required privilege. + /// 4 public bool Delete(string mediaId) { ValidateDatabase(); @@ -505,6 +529,7 @@ namespace Tizen.Content.MediaContent /// /// does not exists. /// The caller has no required privilege. + /// 4 public MediaInfo Add(string path) { ValidateDatabase(); @@ -593,6 +618,7 @@ namespace Tizen.Content.MediaContent /// /// contains a path that does not exist. /// The caller has no required privilege. + /// 4 public async Task AddAsync(IEnumerable paths) { ValidateDatabase(); @@ -635,6 +661,7 @@ namespace Tizen.Content.MediaContent /// is null. /// is a zero-length string, contains only white space. /// The caller has no required privilege. + /// 4 public bool UpdateFavorite(string mediaId, bool value) { ValidateDatabase(); @@ -701,6 +728,7 @@ namespace Tizen.Content.MediaContent /// /// does not exists. /// The caller has no required privilege. + /// 4 public bool Move(string mediaId, string newPath) { ValidateDatabase(); @@ -766,6 +794,7 @@ namespace Tizen.Content.MediaContent /// -or-
/// The media is in the external USB storage ( is ). /// + /// 4 public Task CreateThumbnailAsync(string mediaId) { return CreateThumbnailAsync(mediaId, CancellationToken.None); @@ -797,6 +826,7 @@ namespace Tizen.Content.MediaContent /// -or-
/// The media is in the external USB storage ( is ). /// + /// 4 public Task CreateThumbnailAsync(string mediaId, CancellationToken cancellationToken) { ValidateDatabase(); @@ -904,6 +934,7 @@ namespace Tizen.Content.MediaContent /// Face detection is not available for the given media. /// The required feature is not supported. /// The caller has no required privilege. + /// 4 public Task DetectFaceAsync(string mediaId) { return DetectFaceAsync(mediaId, CancellationToken.None); @@ -940,6 +971,7 @@ namespace Tizen.Content.MediaContent /// The media is in the external USB storage ( is ). /// /// The required feature is not supported. + /// 4 public Task DetectFaceAsync(string mediaId, CancellationToken cancellationToken) { if (Features.IsSupported(Features.FaceRecognition) == false) diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/PlayList.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/PlayList.cs index a7bb9d5..a762611 100755 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/PlayList.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/PlayList.cs @@ -21,6 +21,7 @@ namespace Tizen.Content.MediaContent /// /// Represents the playlist that is a group of media (usually songs). /// + /// 4 public class Playlist { internal Playlist(IntPtr handle) @@ -37,24 +38,28 @@ namespace Tizen.Content.MediaContent /// Gets the ID of the playlist. ///
/// The unique ID of the playlist. + /// 4 public int Id { get; } /// /// Gets the name of the playlist. /// /// The name of the playlist. + /// 4 public string Name { get; } /// /// Gets the path to the thumbnail. /// /// The path to the thumbnail. + /// 4 public string ThumbnailPath { get; } /// /// Returns a string representation of the playlist. /// /// A string representation of the current playlist. + /// 4 public override string ToString() => $"Id={Id}, Name={Name}, ThumbnailPath={ThumbnailPath}"; } @@ -66,6 +71,7 @@ namespace Tizen.Content.MediaContent /// The values only set in the object will be affected to the update command. /// /// + /// 4 public class PlaylistUpdateValues { /// @@ -73,6 +79,7 @@ namespace Tizen.Content.MediaContent /// /// If the value is null, the update operation will have no effect on the field. /// A string for name; the field will not be updated if null. + /// 4 public string Name { get; set; } /// @@ -80,12 +87,14 @@ namespace Tizen.Content.MediaContent /// /// If the value is null, the update operation will have no effect on the field. /// A string for the thumbnail path; the field will not be updated if null. + /// 4 public string ThumbnailPath { get; set; } } /// /// Represents an order of a member of the playlist. /// + /// 4 public class PlayOrder { /// @@ -98,6 +107,7 @@ namespace Tizen.Content.MediaContent /// -or-
/// is less than zero. /// + /// 4 public PlayOrder(int memberId, int orderValue) { MemberId = memberId; @@ -113,6 +123,7 @@ namespace Tizen.Content.MediaContent /// /// is less than or equal to zero. /// + /// 4 public int MemberId { get => _memberId; @@ -136,6 +147,7 @@ namespace Tizen.Content.MediaContent /// /// is less than zero. /// + /// 4 public int Value { get => _value; diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/PlaylistCommand.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/PlaylistCommand.cs index 653d70f..04a4a71 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/PlaylistCommand.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/PlaylistCommand.cs @@ -25,6 +25,7 @@ namespace Tizen.Content.MediaContent /// Provides the commands to manage playlists in the database. ///
/// + /// 4 public class PlaylistCommand : MediaCommand { /// @@ -33,6 +34,7 @@ namespace Tizen.Content.MediaContent /// A that the commands run on. /// is null. /// has already been disposed of. + /// 4 public PlaylistCommand(MediaDatabase database) : base(database) { } @@ -44,6 +46,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public int Count() { return Count(null); @@ -57,6 +60,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public int Count(CountArguments arguments) { ValidateDatabase(); @@ -78,6 +82,7 @@ namespace Tizen.Content.MediaContent /// -or-
/// is less than or equal to zero. /// + /// 4 public int GetPlayOrder(int playlistId, int memberId) { ValidateDatabase(); @@ -110,6 +115,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is less than or equal to zero. /// The caller has no required privilege. + /// 4 public bool Delete(int playlistId) { ValidateDatabase(); @@ -157,6 +163,7 @@ namespace Tizen.Content.MediaContent /// /// does not exists. /// The caller has no required privilege. + /// 4 public Playlist InsertFromFile(string name, string path) { ValidateDatabase(); @@ -214,6 +221,7 @@ namespace Tizen.Content.MediaContent /// is less than or equal to zero. /// No matching playlist exists. /// The caller has no required privilege. + /// 4 public void ExportToFile(int playlistId, string path) { ValidateDatabase(); @@ -259,6 +267,7 @@ namespace Tizen.Content.MediaContent /// is null. /// is a zero-length string. /// The caller has no required privilege. + /// 4 public Playlist Insert(string name) { return Insert(name, null); @@ -277,6 +286,7 @@ namespace Tizen.Content.MediaContent /// is null. /// is a zero-length string. /// The caller has no required privilege. + /// 4 public Playlist Insert(string name, string thumbnailPath) { ValidateDatabase(); @@ -322,6 +332,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader Select() { return Select(null); @@ -335,6 +346,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader Select(SelectArguments filter) { ValidateDatabase(); @@ -352,6 +364,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// An error occurred while executing the command. /// is less than or equal to zero. + /// 4 public Playlist Select(int playlistId) { ValidateDatabase(); @@ -393,6 +406,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// An error occurred while executing the command. /// is less than or equal to zero. + /// 4 public int CountMember(int playlistId) { return CountMember(playlistId, null); @@ -408,6 +422,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// An error occurred while executing the command. /// is less than or equal to zero. + /// 4 public int CountMember(int playlistId, CountArguments arguments) { ValidateDatabase(); @@ -465,6 +480,7 @@ namespace Tizen.Content.MediaContent /// is less than or equal to zero. /// is null. /// is a zero-length string, contains only white space. + /// 4 public int GetMemberId(int playlistId, string mediaId) { ValidateDatabase(); @@ -495,6 +511,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// An error occurred while executing the command. /// is less than or equal to zero. + /// 4 public MediaDataReader SelectMember(int playlistId) { return SelectMember(playlistId, null); @@ -510,6 +527,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// An error occurred while executing the command. /// is less than or equal to zero. + /// 4 public MediaDataReader SelectMember(int playlistId, SelectArguments filter) { ValidateDatabase(); @@ -537,6 +555,7 @@ namespace Tizen.Content.MediaContent /// is null. /// is less than or equal to zero. /// The caller has no required privilege. + /// 4 public bool Update(int playlistId, PlaylistUpdateValues values) { ValidateDatabase(); @@ -597,6 +616,7 @@ namespace Tizen.Content.MediaContent /// is null. /// is a zero-length string, contains only white space. /// is less than or equal to zero. + /// 4 public bool AddMember(int playlistId, string mediaId) { ValidationUtil.ValidateNotNullOrEmpty(mediaId, nameof(mediaId)); @@ -623,6 +643,7 @@ namespace Tizen.Content.MediaContent /// contains a zero-length string or white space. /// /// is less than or equal to zero. + /// 4 public bool AddMembers(int playlistId, IEnumerable mediaIds) { ValidateDatabase(); @@ -696,6 +717,7 @@ namespace Tizen.Content.MediaContent /// -or-
/// is less than or equal to zero. /// + /// 4 public bool RemoveMember(int playlistId, int memberId) { if (memberId <= 0) @@ -724,6 +746,7 @@ namespace Tizen.Content.MediaContent /// contains a value which is less than or equal to zero. /// /// is less than or equal to zero. + /// 4 public bool RemoveMembers(int playlistId, IEnumerable memberIds) { ValidateDatabase(); @@ -790,6 +813,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is less than or equal to zero. + /// 4 public bool UpdatePlayOrder(int playlistId, PlayOrder playOrder) { if (playOrder == null) @@ -816,6 +840,7 @@ namespace Tizen.Content.MediaContent /// contains a null value. /// /// is less than or equal to zero. + /// 4 public bool UpdatePlayOrders(int playlistId, IEnumerable orders) { ValidateDatabase(); diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/PlaylistMember.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/PlaylistMember.cs index 9d93dbd..8ebf307 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/PlaylistMember.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/PlaylistMember.cs @@ -19,18 +19,21 @@ namespace Tizen.Content.MediaContent /// /// Represents a member of the . /// + /// 4 public class PlaylistMember { /// /// Gets the member ID. /// /// The member ID of the playlist. + /// 4 public int MemberId { get; } /// /// Gets the media information of the member. /// /// The of the member. + /// 4 public MediaInfo MediaInfo { get; } internal PlaylistMember(int memberId, MediaInfo mediaInfo) diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/QueryArguments.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/QueryArguments.cs index c595e0b..765a740 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/QueryArguments.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/QueryArguments.cs @@ -27,6 +27,7 @@ namespace Tizen.Content.MediaContent /// A filter is required for filtering information associated with Album, Folder, Tag, Bookmark, Playlist, /// and MediaInfo on the basis of details like limit, order, and condition. /// + /// 4 public class QueryArguments { private string _filter; @@ -70,6 +71,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public string FilterExpression { get => _filter; @@ -92,6 +94,7 @@ namespace Tizen.Content.MediaContent ///
/// The storage ID to restrict storage to search, or null for all storages. /// is a zero-length string, contains only white space. + /// 4 public string StorageId { get => _storageId; @@ -168,6 +171,7 @@ namespace Tizen.Content.MediaContent /// A filter is required for filtering information associated with Album, Folder, Tag, Bookmark, Playlist, /// and MediaInfo. /// + /// 4 public class SelectArguments : QueryArguments { private int _startRowIndex; @@ -177,6 +181,7 @@ namespace Tizen.Content.MediaContent ///
/// An integer value that indicates the starting row position of a query. /// is less than zero.
+ /// 4 public int StartRowIndex { get => _startRowIndex; @@ -198,6 +203,7 @@ namespace Tizen.Content.MediaContent ///
/// An integer value that indicates the limit of rows of the result. /// is less than zero. + /// 4 public int TotalRowCount { get => _totalRowCount; @@ -230,6 +236,7 @@ namespace Tizen.Content.MediaContent /// /// /// + /// 4 public string SortOrder { get => _sortOrder; @@ -273,6 +280,7 @@ namespace Tizen.Content.MediaContent /// A filter is required for filtering information associated with Album, Folder, Tag, Bookmark, Playlist, /// and MediaInfo. /// + /// 4 public class CountArguments : QueryArguments { } diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/RecordNotFoundException.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/RecordNotFoundException.cs index 452fb0f..ac23249 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/RecordNotFoundException.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/RecordNotFoundException.cs @@ -21,11 +21,13 @@ namespace Tizen.Content.MediaContent /// /// The exception that is thrown when no record is found in the database. /// + /// 4 public class RecordNotFoundException : Exception { /// /// Initializes a new instance of the class. /// + /// 4 public RecordNotFoundException() : base("No record found.") { } @@ -34,6 +36,7 @@ namespace Tizen.Content.MediaContent /// Initializes a new instance of the class with a specified error message. ///
/// The message that describes the error. + /// 4 public RecordNotFoundException(string message) : base(message) { } @@ -44,6 +47,7 @@ namespace Tizen.Content.MediaContent ///
/// The message that describes the error. /// The exception that is the cause of the current exception. + /// 4 public RecordNotFoundException(string message, Exception innerException) : base(message, innerException) { } diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Rectangle.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Rectangle.cs index 822a689..03cad36 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Rectangle.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Rectangle.cs @@ -22,6 +22,7 @@ namespace Tizen.Content.MediaContent /// Represents the location of the object bounded by the rectangle defined by /// coordinates of top left corner, width, and height. ///
+ /// 4 public struct Rectangle { /// @@ -31,6 +32,7 @@ namespace Tizen.Content.MediaContent /// The y-coordinate of the upper-left corner of the rectangle. /// The width of the rectangle. /// The height of the rectangle. + /// 4 public Rectangle(int x, int y, int width, int height) { X = x; @@ -43,54 +45,63 @@ namespace Tizen.Content.MediaContent /// Gets or sets the x-coordinate of the upper-left corner of the rectangle. /// /// The x-coordinate of the upper-left edge of the rectangle. + /// 4 public int X { get; set; } /// /// Gets or sets the y-coordinate of the upper-left corner of the rectangle. /// /// The y-coordinate of the upper-left edge of the rectangle. + /// 4 public int Y { get; set; } /// /// Gets or sets the width of the rectangle. /// /// The width of the rectangle. + /// 4 public int Width { get; set; } /// /// Gets or sets the height of the rectangle. /// /// The height of the rectangle. + /// 4 public int Height { get; set; } /// /// Gets the x-coordinate of the left edge of the rectangle. /// /// The x-coordinate of the left edge of the rectangle. + /// 4 public int Left => X; /// /// Gets the y-coordinate of the top edge of the rectangle. /// /// The y-coordinate of the top edge of the rectangle. + /// 4 public int Top => Y; /// /// Gets the x-coordinate of the right edge of the rectangle. /// /// The x-coordinate of the right edge of the rectangle. + /// 4 public int Right => X + Width; /// /// Gets the y-coordinate of the bottom edge of the rectangle. /// /// The y-coordinate of the bottom edge of the rectangle. + /// 4 public int Bottom => Y + Height; /// /// Returns a string representation of the rectangle. /// /// A string representation of the current rectangle. + /// 4 public override string ToString() => $"X={X.ToString()}, Y={Y.ToString()}, Width={Width.ToString()}, Height={Height.ToString()}"; @@ -98,6 +109,7 @@ namespace Tizen.Content.MediaContent /// Returns the hash code for this rectangle structure. ///
/// An integer that represents the hash code for this rectangle. + /// 4 public override int GetHashCode() => new { X, Y, Width, Height }.GetHashCode(); /// @@ -108,6 +120,7 @@ namespace Tizen.Content.MediaContent /// true if object is a rectangle structure and its x, y, width, and height properties are /// equal to the corresponding properties of this rectangle structure; otherwise, false. /// + /// 4 public override bool Equals(object obj) => obj is Rectangle && this == (Rectangle)obj; /// @@ -116,6 +129,7 @@ namespace Tizen.Content.MediaContent /// The to compare. /// The to compare. /// true if the two rectangle structures have equal x, y, width, and height properties; otherwise, false. + /// 4 public static bool operator ==(Rectangle rect1, Rectangle rect2) => rect1.X == rect2.X && rect1.Y == rect2.Y && rect1.Width == rect2.Width && rect1.Height == rect2.Height; @@ -125,6 +139,7 @@ namespace Tizen.Content.MediaContent /// The to compare. /// The to compare. /// true if any of the x, y, width, or height properties of the two rectangle structures are unequal; otherwise false. + /// 4 public static bool operator !=(Rectangle rect1, Rectangle rect2) => !(rect1 == rect2); } } diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Storage.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Storage.cs index 0db0876..621fa1f 100755 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Storage.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Storage.cs @@ -25,6 +25,7 @@ namespace Tizen.Content.MediaContent /// The system generates the storage ID when the external storage is added and manages the media information /// in each of the storage by using the storage ID. /// + /// 3 public class Storage { internal Storage(IntPtr handle) @@ -40,24 +41,28 @@ namespace Tizen.Content.MediaContent /// Gets the ID of the storage. /// /// The unique ID of the storage. + /// 3 public string Id { get; } /// /// Gets the path of the storage. /// /// The path of the storage. + /// 4 public string Path { get; } /// /// Gets the type of the storage. /// /// The type of the storage. + /// 4 public StorageType Type { get; } /// /// Returns a string representation of the storage. /// /// A string representation of the current storage. + /// 4 public override string ToString() => $"Id={Id}, Path={Path}, Type={Type}"; } diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/StorageCommand.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/StorageCommand.cs index 7cda0ec..f0b4992 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/StorageCommand.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/StorageCommand.cs @@ -25,6 +25,7 @@ namespace Tizen.Content.MediaContent /// The internal storage is not managed. /// /// + /// 4 public class StorageCommand : MediaCommand { /// @@ -33,6 +34,7 @@ namespace Tizen.Content.MediaContent /// The that the commands run on. /// is null. /// has already been disposed of. + /// 4 public StorageCommand(MediaDatabase database) : base(database) { } @@ -44,6 +46,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public int Count() => Count(arguments: null); /// @@ -54,6 +57,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public int Count(CountArguments arguments) { ValidateDatabase(); @@ -71,6 +75,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public Storage Select(string storageId) { ValidateDatabase(); @@ -101,6 +106,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader Select() => Select(arguments: null); /// @@ -111,6 +117,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader Select(SelectArguments arguments) { ValidateDatabase(); @@ -137,6 +144,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public int CountMedia(string storageId) => CountMedia(storageId, null); /// @@ -150,6 +158,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public int CountMedia(string storageId, CountArguments arguments) { if (Exists(storageId) == false) @@ -170,6 +179,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public MediaDataReader SelectMedia(string storageId) => SelectMedia(storageId, null); /// @@ -183,6 +193,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// is a zero-length string, contains only white space. + /// 4 public MediaDataReader SelectMedia(string storageId, SelectArguments filter) { if (Exists(storageId) == false) diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Tag.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Tag.cs index e3ea3cd..6b4c500 100755 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Tag.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/Tag.cs @@ -23,6 +23,7 @@ namespace Tizen.Content.MediaContent /// Tagging allows a user to organize large number of items into logical groups providing /// a simplified and faster way of accessing media items. /// + /// 3 public class Tag { internal Tag(IntPtr handle) @@ -35,12 +36,14 @@ namespace Tizen.Content.MediaContent /// Gets the ID of the tag. /// /// The unique ID of the tag. + /// 3 public int Id { get; } /// /// Gets the name of the tag. /// /// The name of the tag. + /// 3 public string Name { get; } internal static Tag FromHandle(IntPtr handle) => new Tag(handle); @@ -49,6 +52,7 @@ namespace Tizen.Content.MediaContent /// Returns a string representation of the tag. /// /// A string representation of the current tag. + /// 4 public override string ToString() => $"Id={Id}, Name={Name}"; } diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/TagCommand.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/TagCommand.cs index 60d703d..0d82b53 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/TagCommand.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/TagCommand.cs @@ -24,6 +24,7 @@ namespace Tizen.Content.MediaContent /// Provides the commands to manage tags in the database. /// /// + /// 4 public class TagCommand : MediaCommand { /// @@ -32,6 +33,7 @@ namespace Tizen.Content.MediaContent /// The that the commands run on. /// is null. /// has already been disposed of. + /// 4 public TagCommand(MediaDatabase database) : base(database) { } @@ -43,6 +45,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public int Count() { return Count(arguments: null); @@ -56,6 +59,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public int Count(CountArguments arguments) { ValidateDatabase(); @@ -75,6 +79,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is less than or equal to zero. /// The caller has no required privilege. + /// 4 public bool Delete(int tagId) { ValidateDatabase(); @@ -106,6 +111,7 @@ namespace Tizen.Content.MediaContent /// An error occurred while executing the command. /// is null. /// The caller has no required privilege. + /// 4 public Tag Insert(string name) { ValidateDatabase(); @@ -145,6 +151,7 @@ namespace Tizen.Content.MediaContent /// is null. /// is less than or equal to zero. /// The caller has no required privilege. + /// 4 public bool UpdateName(int tagId, string name) { ValidateDatabase(); @@ -189,6 +196,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// An error occurred while executing the command. /// is less than or equal to zero. + /// 4 public Tag Select(int tagId) { ValidateDatabase(); @@ -228,6 +236,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader Select() { return Select(arguments: null); @@ -241,6 +250,7 @@ namespace Tizen.Content.MediaContent /// The is disconnected. /// The has already been disposed of. /// An error occurred while executing the command. + /// 4 public MediaDataReader Select(SelectArguments arguments) { ValidateDatabase(); @@ -257,6 +267,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// An error occurred while executing the command. /// is less than or equal to zero. + /// 4 public int CountMedia(int tagId) { return CountMedia(tagId, null); @@ -272,6 +283,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// An error occurred while executing the command. /// is less than or equal to zero. + /// 4 public int CountMedia(int tagId, CountArguments arguments) { ValidateDatabase(); @@ -294,6 +306,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// An error occurred while executing the command. /// is less than or equal to zero. + /// 4 public MediaDataReader SelectMedia(int tagId) { return SelectMedia(tagId, null); @@ -309,6 +322,7 @@ namespace Tizen.Content.MediaContent /// The has already been disposed of. /// An error occurred while executing the command. /// is less than or equal to zero. + /// 4 public MediaDataReader SelectMedia(int tagId, SelectArguments filter) { ValidateDatabase(); @@ -393,6 +407,7 @@ namespace Tizen.Content.MediaContent /// is null. /// is a zero-length string, contains only white space. /// is less than or equal to zero. + /// 4 public bool AddMedia(int tagId, string mediaId) { ValidationUtil.ValidateNotNullOrEmpty(mediaId, nameof(mediaId)); @@ -419,6 +434,7 @@ namespace Tizen.Content.MediaContent /// contains a zero-length string, contains only white space. /// /// is less than or equal to zero. + /// 4 public bool AddMedia(int tagId, IEnumerable mediaIds) { return UpdateMember(tagId, mediaIds, Interop.Tag.AddMedia); @@ -437,6 +453,7 @@ namespace Tizen.Content.MediaContent /// is null. /// is a zero-length string, contains only white space. /// is less than or equal to zero. + /// 4 public bool RemoveMedia(int tagId, string mediaId) { ValidationUtil.ValidateNotNullOrEmpty(mediaId, nameof(mediaId)); @@ -463,6 +480,7 @@ namespace Tizen.Content.MediaContent /// contains a zero-length string or white space. /// /// is less than or equal to zero. + /// 4 public bool RemoveMedia(int tagId, IEnumerable mediaIds) { return UpdateMember(tagId, mediaIds, Interop.Tag.RemoveMedia); diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/UnsupportedContentException.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/UnsupportedContentException.cs index a0b1b69..0dd8a4a 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/UnsupportedContentException.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/UnsupportedContentException.cs @@ -21,11 +21,13 @@ namespace Tizen.Content.MediaContent /// /// The exception that is thrown when a requested operation is not supported for content. /// + /// 4 public class UnsupportedContentException : Exception { /// /// Initializes a new instance of the class. /// + /// 4 public UnsupportedContentException() : base("The operation is not supported for the given media.") { } @@ -34,6 +36,7 @@ namespace Tizen.Content.MediaContent /// Initializes a new instance of the class with a specified error message. /// /// The message that describes the error. + /// 4 public UnsupportedContentException(string message) : base(message) { } @@ -44,6 +47,7 @@ namespace Tizen.Content.MediaContent /// /// The message that describes the error. /// The exception that is the cause of the current exception. + /// 4 public UnsupportedContentException(string message, Exception innerException) : base(message, innerException) { } diff --git a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/VideoInfo.cs b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/VideoInfo.cs index bca5890..fbb6ad9 100644 --- a/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/VideoInfo.cs +++ b/src/Tizen.Content.MediaContent/Tizen.Content.MediaContent/VideoInfo.cs @@ -22,6 +22,7 @@ namespace Tizen.Content.MediaContent /// /// Represents a video media information. /// + /// 4 public class VideoInfo : MediaInfo { internal VideoInfo(Interop.MediaInfoHandle handle) : base(handle) @@ -59,78 +60,91 @@ namespace Tizen.Content.MediaContent /// Gets the album name. /// /// The album name from the metadata. + /// 4 public string Album { get; } /// /// Gets the artist name. /// /// The artist name from the metadata. + /// 4 public string Artist { get; } /// /// Gets the album artist name. /// /// The album artist name from the metadata. + /// 4 public string AlbumArtist { get; } /// /// Gets the genre. /// /// The genre name from the metadata. + /// 4 public string Genre { get; } /// /// Gets the composer name. /// /// The composer name from the metadata. + /// 4 public string Composer { get; } /// /// Gets the year. /// /// The year from the metadata. + /// 4 public string Year { get; } /// /// Gets the recorded date. /// /// The recorded date information from the metadata if exists; otherwise, the modified date of the file. + /// 4 public string DateRecorded { get; } /// /// Gets the copyright notice. /// /// The copyright notice from the metadata. + /// 4 public string Copyright { get; } /// /// Gets the track number. /// /// The track number from the metadata. + /// 4 public string TrackNumber { get; } /// /// Gets the bitrate in bit per second. /// /// The bit rate of the video. + /// 4 public int BitRate { get; } /// /// Gets the track duration in milliseconds. /// /// The track duration of the video in milliseconds. + /// 4 public int Duration { get; } /// /// Gets the video width in pixels. /// /// The width of the video in pixels. + /// 4 public int Width { get; } /// /// Gets the video height in pixels. /// /// The height of the video in pixels. + /// 4 public int Height { get; } } diff --git a/src/Tizen.Content.MimeType/Tizen.Content.MimeType/MimeUtil.cs b/src/Tizen.Content.MimeType/Tizen.Content.MimeType/MimeUtil.cs index 49dff2e..dfce947 100644 --- a/src/Tizen.Content.MimeType/Tizen.Content.MimeType/MimeUtil.cs +++ b/src/Tizen.Content.MimeType/Tizen.Content.MimeType/MimeUtil.cs @@ -28,6 +28,7 @@ namespace Tizen.Content.MimeType /// /// Conversions are provided from the file extensions to MIME types and from the MIME types to file extensions. /// + /// 3 public static class MimeUtil { /// @@ -40,6 +41,7 @@ namespace Tizen.Content.MimeType /// string mimeType = MimeUtil.GetMimeType("png"); /// /// + /// 3 public static string GetMimeType(string fileExtension) { string mime; @@ -68,6 +70,7 @@ namespace Tizen.Content.MimeType /// } /// /// + /// 3 public static IEnumerable GetFileExtension(string mime) { IntPtr extensionArray = IntPtr.Zero; diff --git a/src/Tizen.Context/Tizen.Context.AppHistory/BatteryStatistics.cs b/src/Tizen.Context/Tizen.Context.AppHistory/BatteryStatistics.cs index 3f9c11b..d06cfd6 100644 --- a/src/Tizen.Context/Tizen.Context.AppHistory/BatteryStatistics.cs +++ b/src/Tizen.Context/Tizen.Context.AppHistory/BatteryStatistics.cs @@ -214,6 +214,7 @@ namespace Tizen.Context.AppHistory /// /// Sorts the apps by consumption, the most battery consuming apps appear first (default). /// + /// 4 ConsumptionMost = 0 } } diff --git a/src/Tizen.Context/Tizen.Context.AppHistory/UsageStatistics.cs b/src/Tizen.Context/Tizen.Context.AppHistory/UsageStatistics.cs index f818df3..a1d30c3 100644 --- a/src/Tizen.Context/Tizen.Context.AppHistory/UsageStatistics.cs +++ b/src/Tizen.Context/Tizen.Context.AppHistory/UsageStatistics.cs @@ -196,10 +196,12 @@ namespace Tizen.Context.AppHistory /// /// Sorts the apps by the last launch time, the most recently launched apps appear first (default). /// + /// 4 LastLaunchTimeNewest = 0, /// /// Sorts the apps by the launch count of being launched, the most frequently launched apps appear first. /// + /// 4 LaunchCountMost } } diff --git a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/Fence.cs b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/Fence.cs index 128378a..f310bd7 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/Fence.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/Fence.cs @@ -292,6 +292,7 @@ namespace Tizen.Location.Geofence /// /// Dispose. /// + /// 3 protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceStatus.cs b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceStatus.cs index 1f33a55..66e8200 100644 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceStatus.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/FenceStatus.cs @@ -117,6 +117,7 @@ namespace Tizen.Location.Geofence /// /// Dispose. /// + /// 3 protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceManager.cs b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceManager.cs index b97acc8..f85cd7e 100755 --- a/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceManager.cs +++ b/src/Tizen.Location.Geofence/Tizen.Location.Geofence/GeofenceManager.cs @@ -288,6 +288,7 @@ namespace Tizen.Location.Geofence /// /// Dispose. /// + /// 3 protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Location/Tizen.Location/LocationBoundary.cs b/src/Tizen.Location/Tizen.Location/LocationBoundary.cs index 9ab11fa..5953d31 100755 --- a/src/Tizen.Location/Tizen.Location/LocationBoundary.cs +++ b/src/Tizen.Location/Tizen.Location/LocationBoundary.cs @@ -79,6 +79,7 @@ namespace Tizen.Location /// /// Dispose. /// + /// 3 protected virtual void Dispose(bool disposing) { Log.Info(Globals.LogTag, "Dispose"); diff --git a/src/Tizen.Location/Tizen.Location/Locator.cs b/src/Tizen.Location/Tizen.Location/Locator.cs index 7ff1ab1..39b3db3 100755 --- a/src/Tizen.Location/Tizen.Location/Locator.cs +++ b/src/Tizen.Location/Tizen.Location/Locator.cs @@ -155,7 +155,7 @@ namespace Tizen.Location /// The time interval between the position collection in batch mode. /// Should be in the range of 1~255 seconds. /// - /// 3 + /// 4 /// Thrown when an invalid argument is used. public int BatchInterval { @@ -183,7 +183,7 @@ namespace Tizen.Location /// The time interval between batch callback updates. The BatchPeriod should be greater than or equal to the BatchInterval. If the BatchPeriod is zero or smaller than the BatchInterval, then the batch mode will not work. In addition, sometimes the period may not work as you intended, the maximum permissible value for the batch period is device specific. /// Should be in the range of 0~60000 seconds. ///
- /// 3 + /// 4 /// Thrown when an invalid argument is used. public int BatchPeriod { @@ -564,6 +564,7 @@ namespace Tizen.Location /// /// Dispose. /// + /// 3 protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Location/Tizen.Location/LocatorHelper.cs b/src/Tizen.Location/Tizen.Location/LocatorHelper.cs index 4bb7a7f..48e9ebb 100755 --- a/src/Tizen.Location/Tizen.Location/LocatorHelper.cs +++ b/src/Tizen.Location/Tizen.Location/LocatorHelper.cs @@ -68,7 +68,7 @@ namespace Tizen.Location /// /// Sets the specified geographical positioning type. /// - /// 3 + /// 4 /// http://tizen.org/privilege/location.enable /// platform /// The back-end positioning method to be used for LBS. diff --git a/src/Tizen.Log/Tizen/Log.cs b/src/Tizen.Log/Tizen/Log.cs index d7c345a..7d0baeb 100644 --- a/src/Tizen.Log/Tizen/Log.cs +++ b/src/Tizen.Log/Tizen/Log.cs @@ -24,6 +24,7 @@ namespace Tizen /// /// Provides methods to print log messages to the Tizen logging system. /// + /// 3 public class Log { /// @@ -127,6 +128,7 @@ namespace Tizen /// /// Provides methods to print log messages to the Tizen logging system. /// + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] public class InternalLog { @@ -232,6 +234,7 @@ namespace Tizen /// /// Provides methods to print log messages to the Tizen logging system. /// + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] public class SecureLog { diff --git a/src/Tizen.Maps/Tizen.Maps/Area.cs b/src/Tizen.Maps/Tizen.Maps/Area.cs index 3f440bf..94a5a20 100755 --- a/src/Tizen.Maps/Tizen.Maps/Area.cs +++ b/src/Tizen.Maps/Tizen.Maps/Area.cs @@ -66,6 +66,7 @@ namespace Tizen.Maps /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. /// /// If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposedValue) diff --git a/src/Tizen.Maps/Tizen.Maps/Geocoordinates.cs b/src/Tizen.Maps/Tizen.Maps/Geocoordinates.cs index 13284c2..59244e1 100755 --- a/src/Tizen.Maps/Tizen.Maps/Geocoordinates.cs +++ b/src/Tizen.Maps/Tizen.Maps/Geocoordinates.cs @@ -85,6 +85,7 @@ namespace Tizen.Maps /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. ///
/// If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposedValue) diff --git a/src/Tizen.Maps/Tizen.Maps/MapService.cs b/src/Tizen.Maps/Tizen.Maps/MapService.cs index e8b016f..dab53f4 100755 --- a/src/Tizen.Maps/Tizen.Maps/MapService.cs +++ b/src/Tizen.Maps/Tizen.Maps/MapService.cs @@ -85,7 +85,7 @@ namespace Tizen.Maps /// /// Gets a user consent for the map service provider /// - /// 3 + /// 4 /// http://tizen.org/privilege/mapservice public bool UserConsented { @@ -195,7 +195,7 @@ namespace Tizen.Maps /// /// Gets the user's consent to use maps data. /// - /// 3 + /// 4 /// Returns true if user agreed that the application can use maps data, otherwise false. /// http://tizen.org/privilege/mapservice /// Thrown when the required feature is not supported. @@ -362,6 +362,7 @@ namespace Tizen.Maps /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. ///
/// If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposedValue) diff --git a/src/Tizen.Maps/Tizen.Maps/MapServiceRequest.cs b/src/Tizen.Maps/Tizen.Maps/MapServiceRequest.cs index 498b0ac..36c66e6 100755 --- a/src/Tizen.Maps/Tizen.Maps/MapServiceRequest.cs +++ b/src/Tizen.Maps/Tizen.Maps/MapServiceRequest.cs @@ -95,6 +95,7 @@ namespace Tizen.Maps /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. ///
/// If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposedValue) diff --git a/src/Tizen.Maps/Tizen.Maps/MapView.cs b/src/Tizen.Maps/Tizen.Maps/MapView.cs index c3a0082..c20c060 100755 --- a/src/Tizen.Maps/Tizen.Maps/MapView.cs +++ b/src/Tizen.Maps/Tizen.Maps/MapView.cs @@ -465,7 +465,7 @@ namespace Tizen.Maps /// /// Indicates whether the scale-bar is enabled or not. /// - /// 3 + /// 4 /// http://tizen.org/privilege/mapservice /// http://tizen.org/privilege/internet /// http://tizen.org/privilege/network.get @@ -757,6 +757,7 @@ namespace Tizen.Maps /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. ///
/// If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposedValue) diff --git a/src/Tizen.Maps/Tizen.Maps/Marker.cs b/src/Tizen.Maps/Tizen.Maps/Marker.cs index 8b968a9..91ae93a 100755 --- a/src/Tizen.Maps/Tizen.Maps/Marker.cs +++ b/src/Tizen.Maps/Tizen.Maps/Marker.cs @@ -169,6 +169,7 @@ namespace Tizen.Maps /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. ///
/// If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposedValue) diff --git a/src/Tizen.Maps/Tizen.Maps/Overlay.cs b/src/Tizen.Maps/Tizen.Maps/Overlay.cs index 5c010e2..d1551c3 100755 --- a/src/Tizen.Maps/Tizen.Maps/Overlay.cs +++ b/src/Tizen.Maps/Tizen.Maps/Overlay.cs @@ -132,6 +132,7 @@ namespace Tizen.Maps /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. ///
/// If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposedValue) diff --git a/src/Tizen.Maps/Tizen.Maps/Place.cs b/src/Tizen.Maps/Tizen.Maps/Place.cs index 34fbb98..1b0ae6e 100755 --- a/src/Tizen.Maps/Tizen.Maps/Place.cs +++ b/src/Tizen.Maps/Tizen.Maps/Place.cs @@ -245,6 +245,7 @@ namespace Tizen.Maps /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. ///
/// If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposedValue) diff --git a/src/Tizen.Maps/Tizen.Maps/PlaceAddress.cs b/src/Tizen.Maps/Tizen.Maps/PlaceAddress.cs index 18cd873..05df11b 100755 --- a/src/Tizen.Maps/Tizen.Maps/PlaceAddress.cs +++ b/src/Tizen.Maps/Tizen.Maps/PlaceAddress.cs @@ -141,7 +141,7 @@ namespace Tizen.Maps /// /// Gets a free text associated with this address. /// - /// 3 + /// 4 public string FreeText { get @@ -219,6 +219,7 @@ namespace Tizen.Maps /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. ///
/// If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposedValue) diff --git a/src/Tizen.Maps/Tizen.Maps/PlaceCategory.cs b/src/Tizen.Maps/Tizen.Maps/PlaceCategory.cs index 0f50051..9645609 100755 --- a/src/Tizen.Maps/Tizen.Maps/PlaceCategory.cs +++ b/src/Tizen.Maps/Tizen.Maps/PlaceCategory.cs @@ -89,6 +89,7 @@ namespace Tizen.Maps /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. ///
/// If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposedValue) diff --git a/src/Tizen.Maps/Tizen.Maps/PlaceFilter.cs b/src/Tizen.Maps/Tizen.Maps/PlaceFilter.cs index 244b34b..6501c58 100755 --- a/src/Tizen.Maps/Tizen.Maps/PlaceFilter.cs +++ b/src/Tizen.Maps/Tizen.Maps/PlaceFilter.cs @@ -116,6 +116,7 @@ namespace Tizen.Maps /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. ///
/// If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposedValue) diff --git a/src/Tizen.Maps/Tizen.Maps/Polygon.cs b/src/Tizen.Maps/Tizen.Maps/Polygon.cs index d01b831..599dd8e 100755 --- a/src/Tizen.Maps/Tizen.Maps/Polygon.cs +++ b/src/Tizen.Maps/Tizen.Maps/Polygon.cs @@ -131,6 +131,7 @@ namespace Tizen.Maps /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. ///
/// If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposedValue) diff --git a/src/Tizen.Maps/Tizen.Maps/Polyline.cs b/src/Tizen.Maps/Tizen.Maps/Polyline.cs index bc84c4d..918a94f 100755 --- a/src/Tizen.Maps/Tizen.Maps/Polyline.cs +++ b/src/Tizen.Maps/Tizen.Maps/Polyline.cs @@ -148,6 +148,7 @@ namespace Tizen.Maps /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. ///
/// If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposedValue) diff --git a/src/Tizen.Maps/Tizen.Maps/Route.cs b/src/Tizen.Maps/Tizen.Maps/Route.cs index bec87b7..799a70b 100755 --- a/src/Tizen.Maps/Tizen.Maps/Route.cs +++ b/src/Tizen.Maps/Tizen.Maps/Route.cs @@ -163,6 +163,7 @@ namespace Tizen.Maps /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. ///
/// If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposedValue) diff --git a/src/Tizen.Maps/Tizen.Maps/SearchPreference.cs b/src/Tizen.Maps/Tizen.Maps/SearchPreference.cs index 06ce362..e751ccf 100755 --- a/src/Tizen.Maps/Tizen.Maps/SearchPreference.cs +++ b/src/Tizen.Maps/Tizen.Maps/SearchPreference.cs @@ -235,6 +235,7 @@ namespace Tizen.Maps /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. ///
/// If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposedValue) diff --git a/src/Tizen.Maps/Tizen.Maps/ServiceData.cs b/src/Tizen.Maps/Tizen.Maps/ServiceData.cs index 7772c84..f5e7534 100755 --- a/src/Tizen.Maps/Tizen.Maps/ServiceData.cs +++ b/src/Tizen.Maps/Tizen.Maps/ServiceData.cs @@ -91,6 +91,7 @@ namespace Tizen.Maps /// /// Indicates availability of scale bar on the map. /// + /// 4 ViewScaleBar = Interop.ServiceData.ViewScaleBar, } } diff --git a/src/Tizen.Maps/Tizen.Maps/TransportMode.cs b/src/Tizen.Maps/Tizen.Maps/TransportMode.cs index 9d94781..21c057e 100755 --- a/src/Tizen.Maps/Tizen.Maps/TransportMode.cs +++ b/src/Tizen.Maps/Tizen.Maps/TransportMode.cs @@ -37,6 +37,7 @@ namespace Tizen.Maps /// /// Indicates that the route is to be traveled using public transport. /// + /// 4 PublicTransit = Interop.RouteTransportMode.PublicTransit, /// /// Indicates that the route is for a truck. diff --git a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailAttachment.cs b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailAttachment.cs index 357e144..b561ddc 100644 --- a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailAttachment.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailAttachment.cs @@ -19,15 +19,18 @@ namespace Tizen.Messaging.Email /// /// Represents an email attachment. /// + /// 3 public class EmailAttachment { /// /// The absolute full path of the file to be attached. /// + /// 3 public string FilePath { get; set; } /// /// The constructor. /// + /// 3 public EmailAttachment() { diff --git a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailEnumerations.cs b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailEnumerations.cs index 45fa335..36d3117 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailEnumerations.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailEnumerations.cs @@ -19,6 +19,7 @@ namespace Tizen.Messaging.Email /// /// Result of sending the email. /// + /// 3 public enum EmailSendResult { /// diff --git a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailMessage.cs b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailMessage.cs index 50bb943..65306b0 100644 --- a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailMessage.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailMessage.cs @@ -23,6 +23,7 @@ namespace Tizen.Messaging.Email /// /// This class contains the Messaging API to support sending email messages. /// + /// 3 public class EmailMessage : IDisposable { internal IntPtr _emailHandle = IntPtr.Zero; @@ -37,6 +38,7 @@ namespace Tizen.Messaging.Email /// /// The constructor. /// + /// 3 public EmailMessage() { int ret = Interop.Email.CreateEmail(out _emailHandle); @@ -50,6 +52,7 @@ namespace Tizen.Messaging.Email /// /// The subject of the email message. /// + /// 3 public string Subject { set @@ -72,6 +75,7 @@ namespace Tizen.Messaging.Email /// /// The body of the email message. /// + /// 3 public string Body { set @@ -93,6 +97,7 @@ namespace Tizen.Messaging.Email /// /// The list of file attachments. /// + /// 3 public IList Attachments { get @@ -107,6 +112,7 @@ namespace Tizen.Messaging.Email /// /// The email address should be in the standard format (as described in the Internet standards RFC 5321 and RFC 5322). /// + /// 3 public ICollection To { get @@ -121,6 +127,7 @@ namespace Tizen.Messaging.Email /// /// The email address should be in the standard format (as described in the Internet standards RFC 5321 and RFC 5322). /// + /// 3 public ICollection Cc { get @@ -135,6 +142,7 @@ namespace Tizen.Messaging.Email /// /// The email address should be in the standard format (as described in the Internet standards RFC 5321 and RFC 5322). /// + /// 3 public ICollection Bcc { get @@ -160,6 +168,7 @@ namespace Tizen.Messaging.Email /// /// Releases all resources used by the EmailMessage. /// + /// 3 public void Dispose() { Dispose(true); @@ -170,6 +179,7 @@ namespace Tizen.Messaging.Email /// Releases all resources used by the EmailMessage. /// /// Disposing by User + /// 3 protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailRecipient.cs b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailRecipient.cs index 99d5de3..69ff503 100644 --- a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailRecipient.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailRecipient.cs @@ -19,15 +19,18 @@ namespace Tizen.Messaging.Email /// /// This class represents recipients of an email. /// + /// 3 public class EmailRecipient { /// /// The email address of the recipient. /// + /// 3 public string Address { get; set; } /// /// The constructor. /// + /// 3 public EmailRecipient() { diff --git a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailSender.cs b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailSender.cs index 5c75996..a153a0d 100644 --- a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailSender.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailSender.cs @@ -22,6 +22,7 @@ namespace Tizen.Messaging.Email /// /// This class is used to send email messages. /// + /// 3 public static class EmailSender { /// @@ -29,6 +30,7 @@ namespace Tizen.Messaging.Email /// /// The email message. /// Failure if the email sending activity failed, otherwise Success. + /// 3 public static async Task SendAsync(EmailMessage email) { var task = new TaskCompletionSource(); diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/CBMessage.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/CBMessage.cs index 88d1f38..08ddae8 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/CBMessage.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/CBMessage.cs @@ -21,6 +21,7 @@ namespace Tizen.Messaging.Messages /// /// This class represents the cell broadcast messages. /// + /// 3 public class CBMessage : Message { internal CBMessage(IntPtr messageHandle) : base(messageHandle) diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/Message.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/Message.cs index 7bd72ab..c2c2a28 100644 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/Message.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/Message.cs @@ -23,6 +23,7 @@ namespace Tizen.Messaging.Messages /// /// This class represents all the messages. /// + /// 3 public abstract class Message : IDisposable { internal IntPtr _messageHandle = IntPtr.Zero; @@ -70,6 +71,7 @@ namespace Tizen.Messaging.Messages /// /// Releases all resources used by the Message. /// + /// 3 public void Dispose() { Dispose(true); @@ -186,6 +188,7 @@ namespace Tizen.Messaging.Messages /// /// After creating the Message object, the default value of this property is 0. After sending, this value is changed. /// + /// 3 public int Id { get @@ -204,6 +207,7 @@ namespace Tizen.Messaging.Messages /// /// The destination port of the message. /// + /// 3 public int Port { get @@ -222,6 +226,7 @@ namespace Tizen.Messaging.Messages /// /// The message box type. /// + /// 3 public MessageBoxType BoxType { get @@ -249,6 +254,7 @@ namespace Tizen.Messaging.Messages /// /// The text of the message. /// + /// 3 public string Text { get @@ -276,6 +282,7 @@ namespace Tizen.Messaging.Messages /// /// The time of the message. /// + /// 3 public DateTime Time { get @@ -303,6 +310,7 @@ namespace Tizen.Messaging.Messages /// /// The SIM slot index of the message. /// + /// 3 public SimSlotId SimId { get @@ -330,6 +338,7 @@ namespace Tizen.Messaging.Messages /// /// Indicates the sender of the message. /// + /// 3 public IReadOnlyCollection From { get diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessageReceivedEventArgs.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessageReceivedEventArgs.cs index f98bc6f..c91c601 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessageReceivedEventArgs.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessageReceivedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Messaging.Messages /// /// An extended EventArgs class, which contains a received message. /// + /// 3 public class MessageReceivedEventArgs : EventArgs { private Message _message; @@ -33,6 +34,7 @@ namespace Tizen.Messaging.Messages /// /// The received message. /// + /// 3 public Message ReceivedMessage { get diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesAddress.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesAddress.cs index 3e13494..74f834f 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesAddress.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesAddress.cs @@ -19,18 +19,21 @@ namespace Tizen.Messaging.Messages /// /// This class is used to manage the information of the message address. /// + /// 3 public class MessagesAddress { internal RecipientType Type; /// /// The address of the sender/recipient. /// + /// 3 public string Number { get; } /// /// Creates a message address. /// /// The recipient's address to receive a message. + /// 3 public MessagesAddress(string number) { Number = number; diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesAttachment.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesAttachment.cs index c37428e..d06d605 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesAttachment.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesAttachment.cs @@ -19,16 +19,19 @@ namespace Tizen.Messaging.Messages /// /// This class is used to manage the information of the message attachment. /// + /// 3 public class MessagesAttachment { /// /// The media type of the attachment. /// + /// 3 public MediaType Type { get; } /// /// The file path of the attachment. /// + /// 3 public string FilePath { get; } /// @@ -36,6 +39,7 @@ namespace Tizen.Messaging.Messages /// /// The attachment's type. /// The file path to attach. + /// 3 public MessagesAttachment(MediaType type, string filePath) { Type = type; diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesEnumerations.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesEnumerations.cs index 2fa1626..f95ed7c 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesEnumerations.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesEnumerations.cs @@ -19,6 +19,7 @@ namespace Tizen.Messaging.Messages /// /// Enumeration for the result of sending a message. /// + /// 3 public enum SentResult { /// @@ -34,6 +35,7 @@ namespace Tizen.Messaging.Messages /// /// Enumeration for the message type. /// + /// 3 public enum MessageType { /// @@ -61,6 +63,7 @@ namespace Tizen.Messaging.Messages /// /// Enumeration for the message box type. /// + /// 3 public enum MessageBoxType { /// @@ -88,6 +91,7 @@ namespace Tizen.Messaging.Messages /// /// Enumeration for the SIM slot index of a message. /// + /// 3 public enum SimSlotId { /// @@ -130,6 +134,7 @@ namespace Tizen.Messaging.Messages /// /// Enumeration for the attachment type for the MMS messaging. /// + /// 3 public enum MediaType { /// diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesManager.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesManager.cs index e9571bd..ce41df0 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesManager.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesManager.cs @@ -24,6 +24,7 @@ namespace Tizen.Messaging.Messages /// This class is used for the message management. It allows applications to use the message service. /// /// http://tizen.org/privilege/message.read + /// 3 public static class MessagesManager { /// @@ -37,6 +38,7 @@ namespace Tizen.Messaging.Messages /// Thrown when the message service is not supported. /// Thrown when input coordinates are invalid. /// Thrown when an application does not have proper privileges. + /// 3 public static Task SendMessageAsync(Message message, bool saveToSentbox) { return MessagesManagerImpl.Instance.SendMessageAsync(message, saveToSentbox); @@ -53,6 +55,7 @@ namespace Tizen.Messaging.Messages /// Thrown when input coordinates are invalid. /// Thrown when failed due to out of memory. /// Thrown when an application does not have proper privileges. + /// 3 public static Task> SearchMessageAsync(MessagesSearchFilter filter) { return MessagesManagerImpl.Instance.SearchMessageAsync(filter); @@ -62,6 +65,7 @@ namespace Tizen.Messaging.Messages /// The MessageReceived event that is raised when receiving a message. /// /// http://tizen.org/privilege/message.read + /// 3 static public event EventHandler MessageReceived { add diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesSearchFilter.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesSearchFilter.cs index 0d8c80b..44d7f54 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesSearchFilter.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesSearchFilter.cs @@ -19,11 +19,13 @@ namespace Tizen.Messaging.Messages /// /// This class represents message search filters. /// + /// 3 public class MessagesSearchFilter { /// /// Creates a search filter for searching messages. /// + /// 3 public MessagesSearchFilter() { } @@ -31,18 +33,22 @@ namespace Tizen.Messaging.Messages /// /// The message box type. /// + /// 3 public MessageBoxType MessageBoxType { get; set; } /// /// The message type. /// + /// 3 public MessageType MessageType { get; set; } /// /// The keyword to search in the text and the subject. /// + /// 3 public string TextKeyword { get; set; } /// /// The recipient address. /// + /// 3 public string AddressKeyword { get; set; } } } diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/MmsMessage.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/MmsMessage.cs index 88a01ca..83d9fdc 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/MmsMessage.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/MmsMessage.cs @@ -22,6 +22,7 @@ namespace Tizen.Messaging.Messages /// /// This class represents multimedia messages. /// + /// 3 public class MmsMessage : Message { private IList _attachment = new List(); @@ -29,6 +30,7 @@ namespace Tizen.Messaging.Messages /// /// Creates a multimedia message. /// + /// 3 public MmsMessage() : base(MessageType.Mms) { } @@ -41,6 +43,7 @@ namespace Tizen.Messaging.Messages /// /// The subject of the multimedia message. /// + /// 3 public string Subject { get @@ -68,6 +71,7 @@ namespace Tizen.Messaging.Messages /// /// The collection of normal message recipients. /// + /// 3 public ICollection To { get @@ -79,6 +83,7 @@ namespace Tizen.Messaging.Messages /// /// The collection of CC (carbon copy) message recipients. /// + /// 3 public ICollection Cc { get @@ -90,6 +95,7 @@ namespace Tizen.Messaging.Messages /// /// The collection of BCC (blind carbon copy) message recipients. /// + /// 3 public ICollection Bcc { get @@ -101,6 +107,7 @@ namespace Tizen.Messaging.Messages /// /// The list of attachment files. /// + /// 3 public IList Attachments { get diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/PushMessage.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/PushMessage.cs index d14f3c1..eaca56a 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/PushMessage.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/PushMessage.cs @@ -21,6 +21,7 @@ namespace Tizen.Messaging.Messages /// /// This class represents the WAP push messages. /// + /// 3 public class PushMessage : Message { internal PushMessage(IntPtr messageHandle) : base(messageHandle) diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/SmsMessage.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/SmsMessage.cs index 456962c..76f5b1d 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/SmsMessage.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/SmsMessage.cs @@ -22,11 +22,13 @@ namespace Tizen.Messaging.Messages /// /// This class represents short text messages. /// + /// 3 public class SmsMessage : Message { /// /// Creates a short text message. /// + /// 3 public SmsMessage() : base(MessageType.Sms) { } @@ -38,6 +40,7 @@ namespace Tizen.Messaging.Messages /// /// The collection of normal message recipients. /// + /// 3 public ICollection To { get diff --git a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioCapture.cs b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioCapture.cs index fea275a..8104a31 100644 --- a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioCapture.cs +++ b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioCapture.cs @@ -24,18 +24,21 @@ namespace Tizen.Multimedia /// Provides the ability to directly manage the system audio input devices. /// /// http://tizen.org/privilege/recorder + /// 3 public abstract class AudioCaptureBase : IDisposable { /// /// Specifies the minimum value allowed for the audio capture, in Hertz (Hz). /// /// + /// 3 public static readonly int MinSampleRate = 8000; /// /// Specifies the maximum value allowed for the audio capture, in Hertz (Hz). /// /// + /// 3 public static readonly int MaxSampleRate = 48000; internal IntPtr _handle = IntPtr.Zero; @@ -74,6 +77,7 @@ namespace Tizen.Multimedia /// /// Occurs when the state of the AudioCapture is changed. /// + /// 3 public event EventHandler StateChanged; private AudioStateChangedCallback _stateChangedCallback; @@ -98,6 +102,7 @@ namespace Tizen.Multimedia /// /// Releases all resources used by the object. /// + /// 3 public void Dispose() { Dispose(true); @@ -110,6 +115,7 @@ namespace Tizen.Multimedia /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. /// + /// 3 protected virtual void Dispose(bool disposing) { if (_isDisposed) @@ -155,22 +161,26 @@ namespace Tizen.Multimedia /// /// Gets the sample rate of the audio input data stream, in Hertz (Hz). /// + /// 3 public int SampleRate { get; } /// /// Gets the channel type of the audio input data stream. /// + /// 3 public AudioChannel Channel { get; } /// /// Gets the sample type of the audio input data stream. /// + /// 3 public AudioSampleType SampleType { get; } /// /// Gets the size allocated for the audio input buffer. /// /// The AudioCaptureBase has already been disposed of. + /// 3 public int GetBufferSize() { ValidateNotDisposed(); @@ -189,6 +199,7 @@ namespace Tizen.Multimedia /// /// The AudioCaptureBase has already been disposed of. /// + /// 3 public void Prepare() { ValidateState(AudioIOState.Idle); @@ -207,6 +218,7 @@ namespace Tizen.Multimedia /// /// The AudioCaptureBase has already been disposed of. /// + /// 3 public void Unprepare() { ValidateState(AudioIOState.Running, AudioIOState.Paused); @@ -225,6 +237,7 @@ namespace Tizen.Multimedia /// /// The AudioCaptureBase has already been disposed of. /// + /// 3 public void Pause() { if (_state == AudioIOState.Paused) @@ -245,6 +258,7 @@ namespace Tizen.Multimedia /// /// The AudioCaptureBase has already been disposed of. /// + /// 3 public void Resume() { if (_state == AudioIOState.Running) @@ -261,6 +275,7 @@ namespace Tizen.Multimedia /// /// The current state is . /// The AudioCaptureBase has already been disposed of. + /// 3 public void Flush() { ValidateState(AudioIOState.Running, AudioIOState.Paused); @@ -282,6 +297,7 @@ namespace Tizen.Multimedia /// /// is not supported. /// Not able to retrieve information from . + /// 3 public void ApplyStreamPolicy(AudioStreamPolicy streamPolicy) { if (streamPolicy == null) @@ -299,6 +315,7 @@ namespace Tizen.Multimedia /// Provides the ability to record audio from system audio input devices in a synchronous way. /// /// http://tizen.org/privilege/recorder + /// 3 public class AudioCapture : AudioCaptureBase { /// @@ -319,6 +336,7 @@ namespace Tizen.Multimedia /// /// The required privilege is not specified. /// The system does not support microphone. + /// 3 public AudioCapture(int sampleRate, AudioChannel channel, AudioSampleType sampleType) : base(sampleRate, channel, sampleType) { @@ -332,6 +350,7 @@ namespace Tizen.Multimedia /// The current state is not . /// is equal to or less than zero. /// The AudioCapture has already been disposed of. + /// 3 public byte[] Read(int count) { if (count <= 0) @@ -354,12 +373,14 @@ namespace Tizen.Multimedia /// Provides the ability to record audio from system audio input devices in an asynchronous way. /// /// http://tizen.org/privilege/recorder + /// 3 public class AsyncAudioCapture : AudioCaptureBase { /// /// Occurs when audio data is available. /// + /// 3 public event EventHandler DataAvailable; /// @@ -380,6 +401,7 @@ namespace Tizen.Multimedia /// /// The required privilege is not specified. /// The system does not support microphone. + /// 3 public AsyncAudioCapture(int sampleRate, AudioChannel channel, AudioSampleType sampleType) : base(sampleRate, channel, sampleType) { diff --git a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioDataAvailableEventArgs.cs b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioDataAvailableEventArgs.cs index 72fbc0a..be2877d 100644 --- a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioDataAvailableEventArgs.cs +++ b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioDataAvailableEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class AudioDataAvailableEventArgs : EventArgs { internal AudioDataAvailableEventArgs(byte[] data) @@ -31,6 +32,7 @@ namespace Tizen.Multimedia /// /// Gets the audio data captured. /// + /// 3 public byte[] Data { get; } } } diff --git a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioIOEnums.cs b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioIOEnums.cs index 533a576..83879df 100644 --- a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioIOEnums.cs +++ b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioIOEnums.cs @@ -24,6 +24,7 @@ namespace Tizen.Multimedia /// /// /// + /// 3 public enum AudioChannel { /// @@ -56,6 +57,7 @@ namespace Tizen.Multimedia /// /// Specifies the states for the , , and . /// + /// 3 public enum AudioIOState { /// @@ -77,6 +79,7 @@ namespace Tizen.Multimedia /// /// Specifies the audio sample types. /// + /// 3 public enum AudioSampleType { /// diff --git a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioIOStateChangedEventArgs.cs b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioIOStateChangedEventArgs.cs index 5ade7ed..be1a0cb 100644 --- a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioIOStateChangedEventArgs.cs +++ b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioIOStateChangedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event and the event. /// + /// 3 public class AudioIOStateChangedEventArgs : EventArgs { internal AudioIOStateChangedEventArgs(AudioIOState previous, AudioIOState current, bool byPolicy) @@ -33,16 +34,19 @@ namespace Tizen.Multimedia /// /// Gets the previous state. /// + /// 3 public AudioIOState Previous { get; } /// /// Gets the current state. /// + /// 3 public AudioIOState Current { get; } /// /// Gets the value indicating whether the state is changed by a policy or not. /// + /// 3 public bool ByPolicy { get; } } } diff --git a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioPlayback.cs b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioPlayback.cs index 4dde0a9..9e98640 100644 --- a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioPlayback.cs +++ b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioPlayback.cs @@ -22,18 +22,21 @@ namespace Tizen.Multimedia /// /// Provides the ability to directly manage the system audio output devices and play the PCM (pulse-code modulation) data. /// + /// 3 public class AudioPlayback : IDisposable { /// /// Specifies the minimum value allowed for the audio capture, in Hertz (Hz). /// /// + /// 3 public static readonly int MinSampleRate = 8000; /// /// Specifies the maximum value allowed for the audio capture, in Hertz (Hz). /// /// + /// 3 public static readonly int MaxSampleRate = 48000; private IntPtr _handle = IntPtr.Zero; @@ -45,6 +48,7 @@ namespace Tizen.Multimedia /// Occurs when the audio playback data can be written. /// /// + /// 3 public event EventHandler BufferAvailable; private AudioStreamCallback _streamCallback; @@ -64,6 +68,7 @@ namespace Tizen.Multimedia /// /// Occurs when the state of the AudioPlayback is changed. /// + /// 3 public event EventHandler StateChanged; private AudioStateChangedCallback _stateChangedCallback; @@ -100,6 +105,7 @@ namespace Tizen.Multimedia /// -or-
/// is invalid. /// + /// 3 public AudioPlayback(int sampleRate, AudioChannel channel, AudioSampleType sampleType) { if (sampleRate < MinSampleRate || MaxSampleRate < sampleRate) @@ -137,6 +143,7 @@ namespace Tizen.Multimedia /// /// Releases all resources used by the object. /// + /// 3 public void Dispose() { Dispose(true); @@ -149,6 +156,7 @@ namespace Tizen.Multimedia /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. /// + /// 3 protected virtual void Dispose(bool disposing) { if (_isDisposed) @@ -194,22 +202,26 @@ namespace Tizen.Multimedia /// /// Gets the sample rate of the audio output data stream, in Hertz (Hz). /// + /// 3 public int SampleRate { get; } /// /// Gets the channel type of the audio output data stream. /// + /// 3 public AudioChannel Channel { get; } /// /// Gets the sample type of the audio output data stream. /// + /// 3 public AudioSampleType SampleType { get; } /// /// Gets the sound type supported by the audio output device. /// /// The AudioPlayback has already been disposed of. + /// 3 public AudioStreamType StreamType { get @@ -228,6 +240,7 @@ namespace Tizen.Multimedia /// Gets the size allocated for the audio output buffer. ///
/// The AudioPlayback has already been disposed of. + /// 3 public int GetBufferSize() { AudioIOUtil.ThrowIfError(AudioOutput.GetBufferSize(_handle, out var size)); @@ -240,6 +253,7 @@ namespace Tizen.Multimedia ///
/// The AudioPlayback has already been disposed of. /// The current state is . + /// 3 public void Drain() { ValidateState(AudioIOState.Running, AudioIOState.Paused); @@ -258,6 +272,7 @@ namespace Tizen.Multimedia /// The length of is zero. /// The current state is not . /// The AudioPlayback has already been disposed of. + /// 3 public int Write(byte[] buffer) { ValidateState(AudioIOState.Running); @@ -292,6 +307,7 @@ namespace Tizen.Multimedia /// /// The AudioPlayback has already been disposed of. /// + /// 3 public void Prepare() { ValidateState(AudioIOState.Idle); @@ -310,6 +326,7 @@ namespace Tizen.Multimedia /// /// The AudioPlayback has already been disposed of. /// + /// 3 public void Unprepare() { ValidateState(AudioIOState.Running, AudioIOState.Paused); @@ -329,6 +346,7 @@ namespace Tizen.Multimedia /// /// The AudioPlayback has already been disposed of. /// + /// 3 public void Pause() { if (_state == AudioIOState.Paused) @@ -351,6 +369,7 @@ namespace Tizen.Multimedia /// /// The AudioPlayback has already been disposed of. /// + /// 3 public void Resume() { if (_state == AudioIOState.Running) @@ -367,6 +386,7 @@ namespace Tizen.Multimedia ///
/// The current state is . /// The AudioPlayback has already been disposed of. + /// 3 public void Flush() { ValidateState(AudioIOState.Running, AudioIOState.Paused); @@ -388,6 +408,7 @@ namespace Tizen.Multimedia /// /// is not supported. /// Not able to retrieve information from . + /// 3 public void ApplyStreamPolicy(AudioStreamPolicy streamPolicy) { if (streamPolicy == null) diff --git a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioPlaybackBufferAvailableEventArgs.cs b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioPlaybackBufferAvailableEventArgs.cs index b834894..869a275 100644 --- a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioPlaybackBufferAvailableEventArgs.cs +++ b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioPlaybackBufferAvailableEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class AudioPlaybackBufferAvailableEventArgs : EventArgs { internal AudioPlaybackBufferAvailableEventArgs(int length) @@ -33,6 +34,7 @@ namespace Tizen.Multimedia ///
/// The length of the buffer that can be written. /// + /// 3 public int Length { get; } } } diff --git a/src/Tizen.Multimedia.AudioIO/TonePlayer/TonePlayer.cs b/src/Tizen.Multimedia.AudioIO/TonePlayer/TonePlayer.cs index 718c4fe..e262561 100644 --- a/src/Tizen.Multimedia.AudioIO/TonePlayer/TonePlayer.cs +++ b/src/Tizen.Multimedia.AudioIO/TonePlayer/TonePlayer.cs @@ -24,6 +24,7 @@ namespace Tizen.Multimedia /// /// Provides the ability to play a tone. /// + /// 3 public static class TonePlayer { /// @@ -39,6 +40,7 @@ namespace Tizen.Multimedia /// Any invalid operations occurred. /// is not a supported type. /// has already been disposed of. + /// 3 public static Task StartAsync(ToneType tone, AudioStreamPolicy streamPolicy, int durationMilliseconds) { @@ -59,6 +61,7 @@ namespace Tizen.Multimedia /// Any invalid operations occurred. /// is not a supported type. /// has already been disposed of. + /// 3 public static Task StartAsync(ToneType tone, AudioStreamPolicy streamPolicy, int durationMilliseconds, CancellationToken cancellationToken) { diff --git a/src/Tizen.Multimedia.AudioIO/TonePlayer/ToneType.cs b/src/Tizen.Multimedia.AudioIO/TonePlayer/ToneType.cs index 1cfc2ec..dbca8a6 100644 --- a/src/Tizen.Multimedia.AudioIO/TonePlayer/ToneType.cs +++ b/src/Tizen.Multimedia.AudioIO/TonePlayer/ToneType.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia /// /// Specifies the audio codec. /// + /// 3 public enum ToneType { /// @@ -116,6 +117,7 @@ namespace Tizen.Multimedia /// /// Call supervisory tone, Congestion: CEPT, JAPAN: 425Hz, 200ms ON, 200ms OFF. /// + /// 4 SupCongestion, /// /// Call supervisory tone, Congestion: ANSI (IS-95): 480Hz+620Hz, 250ms ON, 250ms OFF. @@ -132,6 +134,7 @@ namespace Tizen.Multimedia /// /// Call supervisory tone, Radio path not available: 425Hz, 200ms ON, 200 OFF 3 bursts. /// + /// 4 SupRadioNotAvailable, /// /// Call supervisory tone, Error/Special info: 950Hz+1400Hz+1800Hz, 330ms ON, 1s OFF. @@ -232,6 +235,7 @@ namespace Tizen.Multimedia /// /// CDMA Network Callwaiting tone: 440Hz 300ms ON. /// + /// 4 CdmaNetworkCallWaiting, /// /// CDMA PIP tone: 480Hz 100ms ON, 100ms OFF repeated for 4 times. @@ -408,6 +412,7 @@ namespace Tizen.Multimedia /// ///CDMA Alert Auto Redial tone: {1245Hz 62ms ON, 659Hz 62ms ON} 3 times, 1245 62ms ON. /// + /// 4 CdmaAlertAutoRedialLite, /// /// CDMA One Min Beep tone: 1150Hz+770Hz 400ms ON. @@ -440,6 +445,7 @@ namespace Tizen.Multimedia /// /// CDMA CALLDROP LITE tone: 1480Hz 125ms, 1397Hz 125ms, 784Hz 125ms. /// + /// 4 CdmaCallDropLite, /// /// CDMA_NETWORK_BUSY_ONE_SHOT tone: 425Hz 500ms ON, 500ms OFF. diff --git a/src/Tizen.Multimedia.AudioIO/WavPlayer/WavPlayer.cs b/src/Tizen.Multimedia.AudioIO/WavPlayer/WavPlayer.cs index 6e848fe..1f14f3f 100644 --- a/src/Tizen.Multimedia.AudioIO/WavPlayer/WavPlayer.cs +++ b/src/Tizen.Multimedia.AudioIO/WavPlayer/WavPlayer.cs @@ -25,6 +25,7 @@ namespace Tizen.Multimedia /// /// Provides the ability to play a wav file. /// + /// 3 public static class WavPlayer { /// @@ -42,6 +43,7 @@ namespace Tizen.Multimedia /// does not exists. /// The format of is not supported. /// has already been disposed of. + /// 3 public static Task StartAsync(string path, AudioStreamPolicy streamPolicy) { return StartAsync(path, streamPolicy, CancellationToken.None); @@ -63,6 +65,7 @@ namespace Tizen.Multimedia /// does not exists. /// The format of is not supported. /// has already been disposed of. + /// 3 public static Task StartAsync(string path, AudioStreamPolicy streamPolicy, CancellationToken cancellationToken) { diff --git a/src/Tizen.Multimedia.Camera/Camera/Camera.cs b/src/Tizen.Multimedia.Camera/Camera/Camera.cs index f521f9a..9d7dc54 100644 --- a/src/Tizen.Multimedia.Camera/Camera/Camera.cs +++ b/src/Tizen.Multimedia.Camera/Camera/Camera.cs @@ -38,6 +38,7 @@ namespace Tizen.Multimedia /// and functions for picture manipulations like sepia, negative, and many more. /// It also notifies you when a significant picture parameter changes, (For example, focus). /// + /// 3 public class Camera : IDisposable, IDisplayable { private IntPtr _handle = IntPtr.Zero; @@ -74,6 +75,7 @@ namespace Tizen.Multimedia /// /// Gets the native handle of the camera. /// + /// 3 public IntPtr Handle => GetHandle(); internal IntPtr GetHandle() @@ -87,6 +89,7 @@ namespace Tizen.Multimedia /// Releases the unmanaged resources used by the camera. /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -152,6 +155,7 @@ namespace Tizen.Multimedia /// /// An event that occurs when the camera interrupt is started by the policy. /// + /// 4 public event EventHandler InterruptStarted; private Native.InterruptStartedCallback _interruptStartedCallback; @@ -364,13 +368,13 @@ namespace Tizen.Multimedia /// /// Gets or sets the various camera settings. /// - /// 3 + /// 4 public CameraSettings Settings { get; } /// /// Gets the various camera capabilities. /// - /// 3 + /// 4 public CameraCapabilities Capabilities { get; } /// @@ -569,7 +573,7 @@ namespace Tizen.Multimedia /// /// Gets the device state. /// - /// 3 + /// 4 /// The device to get the state. /// Returns the state of the camera device. /// In case of invalid parameters. diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraCapabilities.cs b/src/Tizen.Multimedia.Camera/Camera/CameraCapabilities.cs index 1c00021..7103bc8 100755 --- a/src/Tizen.Multimedia.Camera/Camera/CameraCapabilities.cs +++ b/src/Tizen.Multimedia.Camera/Camera/CameraCapabilities.cs @@ -25,6 +25,7 @@ namespace Tizen.Multimedia /// The CameraCapabilities class provides properties /// to get various capability information of the camera device. /// + /// 4 public class CameraCapabilities { internal readonly Camera _camera; @@ -84,97 +85,97 @@ namespace Tizen.Multimedia /// Gets the face detection feature's supported state. /// /// true if supported, otherwise false. - /// 3 + /// 4 public bool IsFaceDetectionSupported { get; } /// /// Gets the media packet preview callback feature's supported state. /// /// true if supported, otherwise false. - /// 3 + /// 4 public bool IsMediaPacketPreviewCallbackSupported { get; } /// /// Gets the zero shutter lag feature's supported state. /// /// true if supported, otherwise false. - /// 3 + /// 4 public bool IsZeroShutterLagSupported { get; } /// /// Gets the continuous capture feature's supported state. /// /// true if supported, otherwise false. - /// 3 + /// 4 public bool IsContinuousCaptureSupported { get; } /// /// Gets the support state of the HDR capture. /// /// true if supported, otherwise false. - /// 3 + /// 4 public bool IsHdrCaptureSupported { get; } /// /// Gets the support state of the anti-shake feature. /// /// true if supported, otherwise false. - /// 3 + /// 4 public bool IsAntiShakeSupported { get; } /// /// Gets the support state of the video stabilization feature. /// /// true if supported, otherwise false. - /// 3 + /// 4 public bool IsVideoStabilizationSupported { get; } /// /// Gets the support state of auto contrast feature. /// /// true if supported, otherwise false. - /// 3 + /// 4 public bool IsAutoContrastSupported { get; } /// /// Gets the support state of the brightness feature. /// /// true if supported, otherwise false. - /// 3 + /// 4 public bool IsBrigtnessSupported { get; } /// /// Gets the support state of the exposure feature. /// /// true if supported, otherwise false. - /// 3 + /// 4 public bool IsExposureSupported { get; } /// /// Gets the support state of the zoom feature. /// /// true if supported, otherwise false. - /// 3 + /// 4 public bool IsZoomSupported { get; } /// /// Gets the support state of the pan feature. /// /// true if supported, otherwise false. - /// 3 + /// 4 public bool IsPanSupported { get; } /// /// Gets the support state of the tilt feature. /// /// true if supported, otherwise false. - /// 3 + /// 4 public bool IsTiltSupported { get; } /// /// Retrieves all the preview resolutions supported by the camera. /// - /// 3 + /// 4 /// /// It returns a list containing all the supported preview resolutions. /// @@ -195,7 +196,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the capture resolutions supported by the camera. /// - /// 3 + /// 4 /// /// It returns a list containing all the supported capture resolutions. /// @@ -216,7 +217,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the capture formats supported by the camera. /// - /// 3 + /// 4 /// /// It returns a list containing all the supported . /// @@ -237,7 +238,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the preview formats supported by the camera. /// - /// 3 + /// 4 /// /// It returns a list containing all the supported . /// @@ -258,7 +259,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the fps supported by the camera. /// - /// 3 + /// 4 /// /// It returns a list containing all the supported . /// @@ -279,7 +280,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the fps by resolution supported by the camera. /// - /// 3 + /// 4 /// The width of required preview resolution. /// The height of required preview resolution. /// @@ -294,7 +295,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the fps by resolution supported by the camera. /// - /// 3 + /// 4 /// The size of required preview resolution. /// /// It returns a list containing all the supported by resolution. @@ -308,7 +309,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the auto focus modes supported by the camera. /// - /// 3 + /// 4 /// /// It returns a list containing all the supported . /// @@ -329,7 +330,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the exposure modes supported by the camera. /// - /// 3 + /// 4 /// /// It returns a list containing all the supported . /// @@ -350,7 +351,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the ISO levels supported by the camera. /// - /// 3 + /// 4 /// /// It returns a list containing all the supported . /// @@ -371,7 +372,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the theater modes supported by the camera. /// - /// 3 + /// 4 /// /// It returns a list containing all the supported . /// @@ -392,7 +393,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the white balance modes supported by the camera. /// - /// 3 + /// 4 /// /// It returns a list containing all the supported . /// @@ -413,7 +414,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the flash modes supported by the camera. /// - /// 3 + /// 4 /// /// It returns a list containing all the supported . /// @@ -434,7 +435,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the scene modes supported by the camera. /// - /// 3 + /// 4 /// /// It returns a list containing all the supported . /// @@ -455,7 +456,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the effect modes supported by the camera. /// - /// 3 + /// 4 /// /// It returns a list containing all the supported . /// @@ -476,7 +477,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the stream rotations supported by the camera. /// - /// 3 + /// 4 /// /// An IEnumerable containing all the supported . /// @@ -497,7 +498,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the flips supported by the camera. /// - /// 3 + /// 4 /// /// It returns a list containing all the supported . /// @@ -518,7 +519,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the PTZ types by the camera. /// - /// 3 + /// 4 /// /// It returns a list containing all the supported . /// diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraCapturingEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/CameraCapturingEventArgs.cs index befb012..f4277c0 100755 --- a/src/Tizen.Multimedia.Camera/Camera/CameraCapturingEventArgs.cs +++ b/src/Tizen.Multimedia.Camera/Camera/CameraCapturingEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class CameraCapturingEventArgs : EventArgs { internal CameraCapturingEventArgs(StillImage main, StillImage post, StillImage thumbnail) @@ -33,7 +34,7 @@ namespace Tizen.Multimedia /// /// Gets the main image data of the captured still image. /// - /// 3 + /// 4 public StillImage MainImage { get; } /// diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraDeviceStateChangedEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/CameraDeviceStateChangedEventArgs.cs index b647736..611eff2 100755 --- a/src/Tizen.Multimedia.Camera/Camera/CameraDeviceStateChangedEventArgs.cs +++ b/src/Tizen.Multimedia.Camera/Camera/CameraDeviceStateChangedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class CameraDeviceStateChangedEventArgs : EventArgs { internal CameraDeviceStateChangedEventArgs(CameraDevice device, CameraDeviceState state) diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraDisplaySettings.cs b/src/Tizen.Multimedia.Camera/Camera/CameraDisplaySettings.cs index 3f90093..31788ae 100755 --- a/src/Tizen.Multimedia.Camera/Camera/CameraDisplaySettings.cs +++ b/src/Tizen.Multimedia.Camera/Camera/CameraDisplaySettings.cs @@ -24,6 +24,7 @@ namespace Tizen.Multimedia /// It allows to set and get various display properties, such as /// rotation, display visibility, and display mode. /// + /// 3 public class CameraDisplaySettings { internal readonly Camera _camera; diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraErrorOccurredEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/CameraErrorOccurredEventArgs.cs index 650288e..9de9484 100755 --- a/src/Tizen.Multimedia.Camera/Camera/CameraErrorOccurredEventArgs.cs +++ b/src/Tizen.Multimedia.Camera/Camera/CameraErrorOccurredEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class CameraErrorOccurredEventArgs : EventArgs { internal CameraErrorOccurredEventArgs(CameraErrorCode error, CameraState state) diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraException.cs b/src/Tizen.Multimedia.Camera/Camera/CameraException.cs index e75d678..345e5f4 100644 --- a/src/Tizen.Multimedia.Camera/Camera/CameraException.cs +++ b/src/Tizen.Multimedia.Camera/Camera/CameraException.cs @@ -21,11 +21,13 @@ namespace Tizen.Multimedia /// /// The base exception class that is thrown when specific camera related error occurs. /// + /// 3 public class CameraException : Exception { /// /// Initializes a new instance of the class. /// + /// 3 public CameraException() : base() { } @@ -33,6 +35,7 @@ namespace Tizen.Multimedia /// /// Initializes a new instance of the class with a specified error message. /// + /// 3 public CameraException(string message) : base(message) { } @@ -41,11 +44,13 @@ namespace Tizen.Multimedia /// /// The exception that is thrown when a camera device-related error occurs. /// + /// 3 public class CameraDeviceException : CameraException { /// /// Initializes a new instance of the class. /// + /// 3 public CameraDeviceException() : base() { } @@ -53,6 +58,7 @@ namespace Tizen.Multimedia /// /// Initializes a new instance of the class with a specified error message. /// + /// 3 public CameraDeviceException(string message) : base(message) { } @@ -61,11 +67,13 @@ namespace Tizen.Multimedia /// /// The exception that is thrown when a camera device is not available. /// + /// 3 public class CameraDeviceNotFoundException : CameraException { /// /// Initializes a new instance of the class. /// + /// 3 public CameraDeviceNotFoundException() : base() { } @@ -73,6 +81,7 @@ namespace Tizen.Multimedia /// /// Initializes a new instance of the class with a specified error message. /// + /// 3 public CameraDeviceNotFoundException(string message) : base(message) { } diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraFocusStateChangedEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/CameraFocusStateChangedEventArgs.cs index 63931d4..048a2a9 100755 --- a/src/Tizen.Multimedia.Camera/Camera/CameraFocusStateChangedEventArgs.cs +++ b/src/Tizen.Multimedia.Camera/Camera/CameraFocusStateChangedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class CameraFocusStateChangedEventArgs : EventArgs { internal CameraFocusStateChangedEventArgs(CameraFocusState state) diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraInterruptStartedEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/CameraInterruptStartedEventArgs.cs index ec969cf..b1d5a8e 100755 --- a/src/Tizen.Multimedia.Camera/Camera/CameraInterruptStartedEventArgs.cs +++ b/src/Tizen.Multimedia.Camera/Camera/CameraInterruptStartedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 4 public class CameraInterruptStartedEventArgs : EventArgs { internal CameraInterruptStartedEventArgs(CameraPolicy policy, CameraState state) @@ -32,11 +33,13 @@ namespace Tizen.Multimedia /// /// Gets the current state of the camera. /// + /// 4 public CameraState State { get; } /// /// Gets the policy that interrupted the camera. /// + /// 4 public CameraPolicy Policy { get; } } } diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraInterruptedEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/CameraInterruptedEventArgs.cs index ec2d277..62c2723 100755 --- a/src/Tizen.Multimedia.Camera/Camera/CameraInterruptedEventArgs.cs +++ b/src/Tizen.Multimedia.Camera/Camera/CameraInterruptedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class CameraInterruptedEventArgs : EventArgs { internal CameraInterruptedEventArgs(CameraPolicy policy, CameraState previous, CameraState current) diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraSettings.cs b/src/Tizen.Multimedia.Camera/Camera/CameraSettings.cs index 903f17c..4cdb384 100755 --- a/src/Tizen.Multimedia.Camera/Camera/CameraSettings.cs +++ b/src/Tizen.Multimedia.Camera/Camera/CameraSettings.cs @@ -25,6 +25,7 @@ namespace Tizen.Multimedia /// The camera setting class provides methods/properties to get and /// set basic camera attributes. /// + /// 3 public class CameraSettings { internal readonly Camera _camera; @@ -883,7 +884,7 @@ namespace Tizen.Multimedia /// /// Turn the shutter sound on or off, if it is permitted by policy. /// - /// 3 + /// 4 /// Shutter sound On/Off flag /// /// If this value is true, shutter sound will be disabled, otherwise enabled. diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraStateChangedEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/CameraStateChangedEventArgs.cs index 57f8722..d0d3918 100755 --- a/src/Tizen.Multimedia.Camera/Camera/CameraStateChangedEventArgs.cs +++ b/src/Tizen.Multimedia.Camera/Camera/CameraStateChangedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class CameraStateChangedEventArgs : EventArgs { internal CameraStateChangedEventArgs(CameraState previous, CameraState current, bool policy) diff --git a/src/Tizen.Multimedia.Camera/Camera/DoublePlane.cs b/src/Tizen.Multimedia.Camera/Camera/DoublePlane.cs index 887388a..15f81fd 100755 --- a/src/Tizen.Multimedia.Camera/Camera/DoublePlane.cs +++ b/src/Tizen.Multimedia.Camera/Camera/DoublePlane.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia /// /// The class containing image data which has two planes. /// + /// 3 public class DoublePlane : IPreviewPlane { internal DoublePlane(DoublePlaneStruct unmanaged) diff --git a/src/Tizen.Multimedia.Camera/Camera/EncodedPlane.cs b/src/Tizen.Multimedia.Camera/Camera/EncodedPlane.cs index 48524b7..30aaff9 100755 --- a/src/Tizen.Multimedia.Camera/Camera/EncodedPlane.cs +++ b/src/Tizen.Multimedia.Camera/Camera/EncodedPlane.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia /// /// The class containing the encoded image data. /// + /// 3 public class EncodedPlane : IPreviewPlane { internal EncodedPlane(EncodedPlaneStruct unmanagedData) diff --git a/src/Tizen.Multimedia.Camera/Camera/FaceDetectedEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/FaceDetectedEventArgs.cs index 3b9e7eb..63492bd 100755 --- a/src/Tizen.Multimedia.Camera/Camera/FaceDetectedEventArgs.cs +++ b/src/Tizen.Multimedia.Camera/Camera/FaceDetectedEventArgs.cs @@ -23,6 +23,7 @@ namespace Tizen.Multimedia /// Provides data for the event. /// If the user needs to keep the faces data, the user has to copy the data. /// + /// 3 public class FaceDetectedEventArgs : EventArgs { internal FaceDetectedEventArgs(List faces) diff --git a/src/Tizen.Multimedia.Camera/Camera/FaceDetectionData.cs b/src/Tizen.Multimedia.Camera/Camera/FaceDetectionData.cs index 0a3f6c0..bc4adfd 100755 --- a/src/Tizen.Multimedia.Camera/Camera/FaceDetectionData.cs +++ b/src/Tizen.Multimedia.Camera/Camera/FaceDetectionData.cs @@ -23,6 +23,7 @@ namespace Tizen.Multimedia /// /// The class contains the details of the detected face. /// + /// 3 public class FaceDetectionData { internal FaceDetectionData(IntPtr ptr) diff --git a/src/Tizen.Multimedia.Camera/Camera/HdrCaptureProgressEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/HdrCaptureProgressEventArgs.cs index cf44765..fcc7cc3 100755 --- a/src/Tizen.Multimedia.Camera/Camera/HdrCaptureProgressEventArgs.cs +++ b/src/Tizen.Multimedia.Camera/Camera/HdrCaptureProgressEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class HdrCaptureProgressEventArgs : EventArgs { internal HdrCaptureProgressEventArgs(int percent) diff --git a/src/Tizen.Multimedia.Camera/Camera/IPreviewPlane.cs b/src/Tizen.Multimedia.Camera/Camera/IPreviewPlane.cs index 8a9dc83..0883478 100644 --- a/src/Tizen.Multimedia.Camera/Camera/IPreviewPlane.cs +++ b/src/Tizen.Multimedia.Camera/Camera/IPreviewPlane.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia /// /// Provides interface for various preview plane types. /// + /// 3 public interface IPreviewPlane { } diff --git a/src/Tizen.Multimedia.Camera/Camera/Location.cs b/src/Tizen.Multimedia.Camera/Camera/Location.cs index 8160f4e..23a7896 100755 --- a/src/Tizen.Multimedia.Camera/Camera/Location.cs +++ b/src/Tizen.Multimedia.Camera/Camera/Location.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia /// /// The location class containing GPS data details. /// + /// 3 public class Location { /// @@ -27,6 +28,7 @@ namespace Tizen.Multimedia /// The latitude data. /// The longitude data. /// The altitude data. + /// 3 public Location(double latitude, double longitude, double altitude) { Latitude = latitude; diff --git a/src/Tizen.Multimedia.Camera/Camera/MediaPacketPreviewEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/MediaPacketPreviewEventArgs.cs index b60083b..5b406a4 100755 --- a/src/Tizen.Multimedia.Camera/Camera/MediaPacketPreviewEventArgs.cs +++ b/src/Tizen.Multimedia.Camera/Camera/MediaPacketPreviewEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class MediaPacketPreviewEventArgs : EventArgs { internal MediaPacketPreviewEventArgs(MediaPacket packet) diff --git a/src/Tizen.Multimedia.Camera/Camera/PreviewEventArgs.cs b/src/Tizen.Multimedia.Camera/Camera/PreviewEventArgs.cs index fbda63c..52cd268 100755 --- a/src/Tizen.Multimedia.Camera/Camera/PreviewEventArgs.cs +++ b/src/Tizen.Multimedia.Camera/Camera/PreviewEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class PreviewEventArgs : EventArgs { internal PreviewEventArgs(PreviewFrame preview) diff --git a/src/Tizen.Multimedia.Camera/Camera/PreviewFrame.cs b/src/Tizen.Multimedia.Camera/Camera/PreviewFrame.cs index 3777018..edb233b 100755 --- a/src/Tizen.Multimedia.Camera/Camera/PreviewFrame.cs +++ b/src/Tizen.Multimedia.Camera/Camera/PreviewFrame.cs @@ -24,6 +24,7 @@ namespace Tizen.Multimedia /// /// The class containing the preview image data. /// + /// 4 public class PreviewFrame { internal PreviewFrame(IntPtr ptr) @@ -87,31 +88,31 @@ namespace Tizen.Multimedia /// /// The pixel format of the image. /// - /// 3 + /// 4 public CameraPixelFormat Format { get; } /// /// The resolution of the preview image. /// - /// 3 + /// 4 public Size Resolution { get; } /// /// The time stamp of the preview frame. /// - /// 3 + /// 4 public uint TimeStamp { get; } /// /// The type of the preview plane. /// - /// 3 + /// 4 public PlaneType PlaneType { get; } /// /// The buffer including the preview frame. /// - /// 3 + /// 4 public IPreviewPlane Plane { get; } } } diff --git a/src/Tizen.Multimedia.Camera/Camera/SinglePlane.cs b/src/Tizen.Multimedia.Camera/Camera/SinglePlane.cs index d627c5d..a9a3a68 100755 --- a/src/Tizen.Multimedia.Camera/Camera/SinglePlane.cs +++ b/src/Tizen.Multimedia.Camera/Camera/SinglePlane.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia /// /// The class containing the image data, which has a single plane. /// + /// 3 public class SinglePlane : IPreviewPlane { internal SinglePlane(SinglePlaneStruct unmanaged) diff --git a/src/Tizen.Multimedia.Camera/Camera/StillImage.cs b/src/Tizen.Multimedia.Camera/Camera/StillImage.cs index fabb9eb..64cdcc5 100755 --- a/src/Tizen.Multimedia.Camera/Camera/StillImage.cs +++ b/src/Tizen.Multimedia.Camera/Camera/StillImage.cs @@ -24,6 +24,7 @@ namespace Tizen.Multimedia /// /// The class containing the captured still image. /// + /// 4 public class StillImage { internal StillImage(IntPtr ptr) @@ -54,26 +55,26 @@ namespace Tizen.Multimedia /// /// The pixel format of the still image. /// - /// 3 + /// 4 public CameraPixelFormat Format { get; } /// /// The resolution of the still image. /// - /// 3 + /// 4 public Size Resolution { get; } /// /// The buffer containing the still image. /// - /// 3 + /// 4 public byte[] Data { get; } /// /// The Exif data describing additional metadata of still image. /// Please refer Exif specification for more details. /// - /// 3 + /// 4 public byte[] Exif { get; } } } diff --git a/src/Tizen.Multimedia.Camera/Camera/TriplePlane.cs b/src/Tizen.Multimedia.Camera/Camera/TriplePlane.cs index 0d50515..5563535 100755 --- a/src/Tizen.Multimedia.Camera/Camera/TriplePlane.cs +++ b/src/Tizen.Multimedia.Camera/Camera/TriplePlane.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia /// /// The class containing image data which has three planes. /// + /// 3 public class TriplePlane : IPreviewPlane { internal TriplePlane(TriplePlaneStruct unmanaged) diff --git a/src/Tizen.Multimedia.MediaCodec/MediaCodec/BufferStatusChangedEventArgs.cs b/src/Tizen.Multimedia.MediaCodec/MediaCodec/BufferStatusChangedEventArgs.cs index d5bb05f..9853da0 100644 --- a/src/Tizen.Multimedia.MediaCodec/MediaCodec/BufferStatusChangedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaCodec/MediaCodec/BufferStatusChangedEventArgs.cs @@ -21,12 +21,14 @@ namespace Tizen.Multimedia.MediaCodec /// /// Provides data for the event. /// + /// 3 public class BufferStatusChangedEventArgs : EventArgs { /// /// Initializes a new instance of the BufferStatusChangedEventArgs class. /// /// The value representing new status of the codec. + /// 3 public BufferStatusChangedEventArgs(MediaCodecStatus status) { Status = status; @@ -35,6 +37,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// Gets the value indicating the new status of the codec. /// + /// 3 public MediaCodecStatus Status { get; } } diff --git a/src/Tizen.Multimedia.MediaCodec/MediaCodec/InputProcessedEventArgs.cs b/src/Tizen.Multimedia.MediaCodec/MediaCodec/InputProcessedEventArgs.cs index b10d0d3..132821e 100644 --- a/src/Tizen.Multimedia.MediaCodec/MediaCodec/InputProcessedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaCodec/MediaCodec/InputProcessedEventArgs.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// Provides data for the event. /// + /// 3 public class InputProcessedEventArgs : EventArgs { /// @@ -38,6 +39,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// Gets the packet processed by the codec. /// + /// 3 public MediaPacket Packet { get; } } } diff --git a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodec.cs b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodec.cs index cc1b40f..252af73 100644 --- a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodec.cs +++ b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodec.cs @@ -23,6 +23,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// Provides a means to encode and decode the video and the audio data. /// + /// 3 public class MediaCodec : IDisposable { private const int CodecTypeMask = 0xFFFF; @@ -35,6 +36,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// Initializes a new instance of the MediaCodec class. /// + /// 3 public MediaCodec() { int ret = Interop.MediaCodec.Create(out _handle); @@ -59,6 +61,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. /// + /// 3 protected virtual void Dispose(bool disposing) { if (!_isDisposed) @@ -84,6 +87,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// Releases all resources used by the object. /// + /// 3 public void Dispose() { Dispose(true); @@ -109,6 +113,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// Gets the audio codec list that the current device supports. /// + /// 3 public static IEnumerable SupportedVideoCodecs { get @@ -128,6 +133,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// Gets the audio codec list that the current device supports. /// + /// 3 public static IEnumerable SupportedAudioCodecs { get @@ -204,6 +210,7 @@ namespace Tizen.Multimedia.MediaCodec /// -or-
/// Internal error. /// + /// 3 public void Prepare() { ValidateNotDisposed(); @@ -225,6 +232,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// Unprepares the MediaCodec. /// + /// 3 public void Unprepare() { ValidateNotDisposed(); @@ -249,6 +257,7 @@ namespace Tizen.Multimedia.MediaCodec /// The mime type of the format is not supported. /// /// + /// 3 public void Configure(MediaFormat format, bool encoder, MediaCodecTypes codecType) { ValidateNotDisposed(); @@ -358,6 +367,7 @@ namespace Tizen.Multimedia.MediaCodec /// is null. /// The current codec is not prepared yet. /// Any attempts to modify the packet will fail until the event for the packet is invoked. + /// 3 public void ProcessInput(MediaPacket packet) { ValidateNotDisposed(); @@ -382,6 +392,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// Flushes both input and output buffers. /// + /// 3 public void FlushBuffers() { ValidateNotDisposed(); @@ -398,6 +409,7 @@ namespace Tizen.Multimedia.MediaCodec /// The mime type to query. /// The values indicating which codec types are supported on the current device. /// is invalid. + /// 3 public MediaCodecTypes GetCodecType(bool encoder, MediaFormatVideoMimeType type) { ValidateNotDisposed(); @@ -417,6 +429,7 @@ namespace Tizen.Multimedia.MediaCodec /// The mime type to query. /// The values indicating which codec types are supported on the current device. /// is invalid. + /// 3 public MediaCodecTypes GetCodecType(bool encoder, MediaFormatAudioMimeType type) { ValidateNotDisposed(); @@ -462,6 +475,7 @@ namespace Tizen.Multimedia.MediaCodec /// Occurs when an output buffer is available. ///
/// The output packet needs to be disposed after it is used to clean up unmanaged resources. + /// 3 public event EventHandler OutputAvailable { add @@ -541,6 +555,7 @@ namespace Tizen.Multimedia.MediaCodec /// Occurs when an input packet is processed. ///
/// + /// 3 public event EventHandler InputProcessed; private void RegisterInputProcessed() @@ -574,6 +589,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// Occurs whenever an error is produced in the codec. /// + /// 3 public event EventHandler ErrorOccurred; private void RegisterErrorOccurred() @@ -597,6 +613,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// Occurs when the codec processes all input data. /// + /// 3 public event EventHandler EosReached; private void RegisterEosReached() @@ -616,6 +633,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// Occurs when the codec needs more data or has enough data. /// + /// 3 public event EventHandler BufferStatusChanged; private void RegisterBufferStatusChanged() diff --git a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecError.cs b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecError.cs index 6a3c8a1..c5b22be 100644 --- a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecError.cs +++ b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecError.cs @@ -48,6 +48,7 @@ namespace Tizen.Multimedia.MediaCodec /// Specifies the errors of . ///
/// + /// 3 public enum MediaCodecError { /// diff --git a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecErrorOccurredEventArgs.cs b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecErrorOccurredEventArgs.cs index 0113b6a..a6262a3 100644 --- a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecErrorOccurredEventArgs.cs +++ b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecErrorOccurredEventArgs.cs @@ -21,12 +21,14 @@ namespace Tizen.Multimedia.MediaCodec /// /// Provides data for the event. /// + /// 3 public class MediaCodecErrorOccurredEventArgs : EventArgs { /// /// Initializes a new instance of the ErrorOccurredEventArgs class. /// /// The value representing the type of the error. + /// 3 public MediaCodecErrorOccurredEventArgs(MediaCodecError error) { Error = error; @@ -35,6 +37,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// Gets the value indicating what kind of the error. /// + /// 3 public MediaCodecError Error { get; } } } diff --git a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecStatus.cs b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecStatus.cs index 32e453d..aa91d37 100644 --- a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecStatus.cs +++ b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecStatus.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// Specifies the status of a codec. /// + /// 3 public enum MediaCodecStatus { /// diff --git a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecType.cs b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecType.cs index 2aaf82e..11bccad 100644 --- a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecType.cs +++ b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecType.cs @@ -31,6 +31,7 @@ namespace Tizen.Multimedia.MediaCodec /// This enumeration has a attribute that allows a bitwise combination of its member values. /// /// + /// 3 [Flags] public enum MediaCodecTypes { diff --git a/src/Tizen.Multimedia.MediaCodec/MediaCodec/OutputAvailableEventArgs.cs b/src/Tizen.Multimedia.MediaCodec/MediaCodec/OutputAvailableEventArgs.cs index 9c84828..81e37bf 100644 --- a/src/Tizen.Multimedia.MediaCodec/MediaCodec/OutputAvailableEventArgs.cs +++ b/src/Tizen.Multimedia.MediaCodec/MediaCodec/OutputAvailableEventArgs.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia.MediaCodec /// Provides data for the event. /// /// The output packet needs to be disposed after it is used to clean up unmanaged resources. + /// 3 public class OutputAvailableEventArgs : EventArgs { internal OutputAvailableEventArgs(IntPtr packetHandle) @@ -32,6 +33,7 @@ namespace Tizen.Multimedia.MediaCodec /// /// Gets the result packet. /// + /// 3 public MediaPacket Packet { get; } } } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs b/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs index a490997..fbc09e0 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia /// /// Provides the ability to control the audio effects for . /// + /// 3 public class AudioEffect { private readonly EqualizerBand[] _bands; @@ -67,6 +68,7 @@ namespace Tizen.Multimedia /// -or-
/// is equal to or greater than . /// + /// 3 public EqualizerBand this[int index] { get @@ -92,6 +94,7 @@ namespace Tizen.Multimedia /// Clears the equalizer effect. ///
/// The has already been disposed of. + /// 3 public void Clear() { Player.ValidateNotDisposed(); @@ -103,21 +106,25 @@ namespace Tizen.Multimedia /// /// Gets the number of items. /// + /// 3 public int Count { get; } /// /// Gets the band level range of the bands in the dB. /// + /// 3 public Range BandLevelRange { get; } /// /// Gets the value whether the AudioEffect is available or not. /// + /// 3 public bool IsAvailable { get; } /// /// Gets the player that this AudioEffect belongs to. /// + /// 3 public Player Player { get; } } } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/BufferingProgressChangedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/BufferingProgressChangedEventArgs.cs index 959ec9e..bf4fece 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/BufferingProgressChangedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/BufferingProgressChangedEventArgs.cs @@ -20,12 +20,14 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class BufferingProgressChangedEventArgs : EventArgs { /// /// Initializes a new instance of the BufferingProgressChangedEventArgs class. /// /// The value indicating the buffering percentage. + /// 3 public BufferingProgressChangedEventArgs(int percent) { Percent = percent; @@ -35,12 +37,14 @@ namespace Tizen.Multimedia /// Gets the value indicating the buffering percentage. ///
/// The percentage of the buffering. + /// 3 public int Percent { get; } /// /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() { return $"Percent={ Percent.ToString() }"; diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/CapturedFrame.cs b/src/Tizen.Multimedia.MediaPlayer/Player/CapturedFrame.cs index 1bd3cac..f17e7a4 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/CapturedFrame.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/CapturedFrame.cs @@ -20,6 +20,7 @@ namespace Tizen.Multimedia /// /// Represents data for a video frame captured. /// + /// 3 public class CapturedFrame { internal CapturedFrame(byte[] imageBuffer, int width, int height) @@ -37,11 +38,13 @@ namespace Tizen.Multimedia /// Gets the raw buffer of the captured image. ///
/// The color space format is RGB888. + /// 3 public byte[] Buffer { get; } /// /// Gets the size. /// + /// 3 public Size Size { get; } } } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/DownloadProgress.cs b/src/Tizen.Multimedia.MediaPlayer/Player/DownloadProgress.cs index bb5b7a9..1f7d84e 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/DownloadProgress.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/DownloadProgress.cs @@ -20,6 +20,7 @@ namespace Tizen.Multimedia /// /// Represents data for a downloading status. /// + /// 3 public struct DownloadProgress { /// @@ -27,6 +28,7 @@ namespace Tizen.Multimedia /// /// The position that downloading started in percentage. /// The position indicating the current downloading progress in percentage. + /// 3 public DownloadProgress(int start, int current) { Start = start; @@ -38,6 +40,7 @@ namespace Tizen.Multimedia /// Gets or sets the start position. ///
/// The position that downloading started in percentage. + /// 3 public int Start { get; @@ -48,6 +51,7 @@ namespace Tizen.Multimedia /// Gets or sets the current position. ///
/// The position indicating the current downloading progress in percentage. + /// 3 public int Current { get; @@ -58,6 +62,7 @@ namespace Tizen.Multimedia /// Returns a string that represents the current object. ///
/// A string that represents the current object. + /// 3 public override string ToString() { return $"Start={ Start.ToString() }, Current={ Current.ToString() }"; diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs b/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs index 199fbd1..8e66500 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs @@ -24,6 +24,7 @@ namespace Tizen.Multimedia /// /// Represents an equalizer band of . /// + /// 3 public class EqualizerBand { private readonly AudioEffect _owner; @@ -58,6 +59,7 @@ namespace Tizen.Multimedia /// /// is not inside of . /// + /// 3 public int Level { get @@ -91,11 +93,13 @@ namespace Tizen.Multimedia /// /// Gets the frequency in the dB. /// + /// 3 public int Frequency { get; } /// /// Gets the frequency range in the dB. /// + /// 3 public int FrequencyRange { get; } } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaBufferSource.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaBufferSource.cs index 1287349..baad627 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaBufferSource.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaBufferSource.cs @@ -27,6 +27,7 @@ namespace Tizen.Multimedia /// If you provide invalid data, you won't receive an error until is called. /// /// + /// 3 public sealed class MediaBufferSource : MediaSource { private byte[] _buffer; @@ -40,6 +41,7 @@ namespace Tizen.Multimedia /// -or-
/// is less than zero. /// + /// 3 public MediaBufferSource(int length) { if (length <= 0) @@ -56,6 +58,7 @@ namespace Tizen.Multimedia ///
/// The source array to be copied into the buffer. /// is null. + /// 3 public MediaBufferSource(byte[] buffer) : this(buffer, buffer == null ? 0 : buffer.Length) { } @@ -76,6 +79,7 @@ namespace Tizen.Multimedia /// -or-
/// + is greater than buffer.Length. /// + /// 3 public MediaBufferSource(byte[] buffer, int length, int offset = 0) { if (buffer == null) @@ -113,6 +117,7 @@ namespace Tizen.Multimedia ///
/// The array to be wrapped. /// A MediaBufferSource wrapping the byte array. + /// 3 public static MediaBufferSource Wrap(byte[] buffer) { if (buffer == null) @@ -129,6 +134,7 @@ namespace Tizen.Multimedia /// /// Gets the byte array of this buffer. /// + /// 3 public byte[] Buffer => _buffer; internal override void OnAttached(Player player) diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaSource.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaSource.cs index 8d980ce..a221511 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaSource.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaSource.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia /// /// MediaSource is a base class for sources. /// + /// 3 public abstract class MediaSource { internal MediaSource() diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamBufferStatusChangedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamBufferStatusChangedEventArgs.cs index be04411..dd48e88 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamBufferStatusChangedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamBufferStatusChangedEventArgs.cs @@ -22,12 +22,14 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class MediaStreamBufferStatusChangedEventArgs : EventArgs { /// /// Initializes a new instance of the MediaStreamBufferStatusChangedEventArgs class. /// /// The value indicating the status of the stream. + /// 3 public MediaStreamBufferStatusChangedEventArgs(MediaStreamBufferStatus status) { Status = status; @@ -36,12 +38,14 @@ namespace Tizen.Multimedia /// /// Gets the status. /// + /// 3 public MediaStreamBufferStatus Status { get; } /// /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() { return $"Status : { Status.ToString() }"; diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamConfiguration.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamConfiguration.cs index 5cf47cf..172cba5 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamConfiguration.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamConfiguration.cs @@ -24,6 +24,7 @@ namespace Tizen.Multimedia /// Provides a means to configure properties and handle events for . ///
/// + /// 3 public class MediaStreamConfiguration { private const ulong DefaultBufferMaxSize = 200000; @@ -47,12 +48,14 @@ namespace Tizen.Multimedia /// The event handler will be executed on an internal thread. /// /// + /// 3 public event EventHandler BufferStatusChanged; /// /// Occurs when the seeking is requested. /// /// The event handler will be executed on an internal thread. + /// 3 public event EventHandler SeekingOccurred; /// @@ -63,6 +66,7 @@ namespace Tizen.Multimedia /// The is not assigned to a player. /// is zero. /// + /// 3 public ulong BufferMaxSize { get @@ -98,6 +102,7 @@ namespace Tizen.Multimedia /// The is not assigned to a player. /// is greater than 100. /// + /// 3 public uint BufferMinThreshold { get diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSeekingOccurredEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSeekingOccurredEventArgs.cs index 97c4755..e033ed9 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSeekingOccurredEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSeekingOccurredEventArgs.cs @@ -21,12 +21,14 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class MediaStreamSeekingOccurredEventArgs : EventArgs { /// /// Initializes a new instance of the MediaStreamSeekingOccurredEventArgs class. /// /// The value indicating the new position to seek. + /// 3 public MediaStreamSeekingOccurredEventArgs(ulong offset) { Offset = offset; @@ -35,12 +37,14 @@ namespace Tizen.Multimedia /// /// Gets the offset. /// + /// 3 public ulong Offset { get; } /// /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() => $"Offset : { Offset.ToString() }"; } } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSource.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSource.cs index ac6f9ce..032de67 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSource.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSource.cs @@ -28,6 +28,7 @@ namespace Tizen.Multimedia /// /// The source must be set as a source to a player before pushing. /// + /// 3 public sealed class MediaStreamSource : MediaSource { private readonly MediaFormat _audioMediaFormat; @@ -36,6 +37,7 @@ namespace Tizen.Multimedia /// /// Gets all supported audio types. /// + /// 3 public static IEnumerable SupportedAudioTypes { get @@ -47,6 +49,7 @@ namespace Tizen.Multimedia /// /// Gets all supported video types. /// + /// 3 public static IEnumerable SupportedVideoTypes { get @@ -105,6 +108,7 @@ namespace Tizen.Multimedia /// /// /// + /// 3 public MediaStreamSource(AudioMediaFormat audioMediaFormat, VideoMediaFormat videoMediaFormat) { if (audioMediaFormat == null && videoMediaFormat == null) @@ -127,6 +131,7 @@ namespace Tizen.Multimedia /// is null. /// is not supported. /// + /// 3 public MediaStreamSource(AudioMediaFormat audioMediaFormat) { if (audioMediaFormat == null) @@ -146,6 +151,7 @@ namespace Tizen.Multimedia /// is null. /// is not supported. /// + /// 3 public MediaStreamSource(VideoMediaFormat videoMediaFormat) { if (videoMediaFormat == null) @@ -161,11 +167,13 @@ namespace Tizen.Multimedia /// /// Gets the audio configuration, or null if no AudioMediaFormat is specified in the constructor. /// + /// 3 public MediaStreamConfiguration AudioConfiguration { get; } /// /// Gets the video configuration, or null if no VideoMediaFormat is specified in the constructor. /// + /// 3 public MediaStreamConfiguration VideoConfiguration { get; } /// @@ -190,6 +198,7 @@ namespace Tizen.Multimedia /// /// /// + /// 3 public void Push(MediaPacket packet) { if (_player == null) @@ -292,6 +301,7 @@ namespace Tizen.Multimedia /// Gets the that this source is assigned to as a source, or null if this source is not assigned. /// /// + /// 3 public Player Player => _player; } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaUriSource.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaUriSource.cs index 40f66d4..3fcace7 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaUriSource.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaUriSource.cs @@ -28,6 +28,7 @@ namespace Tizen.Multimedia /// The externalstorage privilege(http://tizen.org/privilege/externalstorage) must be added if any video/audio files are used to play located in the external storage. /// /// + /// 3 public sealed class MediaUriSource : MediaSource { // TODO consider using Uri class. @@ -37,6 +38,7 @@ namespace Tizen.Multimedia /// For HTTP or RSTP, uri should start with "http://" or "rtsp://". /// The default protocol is "file://". /// If you provide an invalid uri, you won't receive an error until is called. + /// 3 public MediaUriSource(string uri) { Uri = uri ?? throw new ArgumentNullException(nameof(uri)); @@ -45,6 +47,7 @@ namespace Tizen.Multimedia /// /// Gets the uri. /// + /// 3 public string Uri { get; } internal override void OnAttached(Player player) diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlaybackInterruptedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlaybackInterruptedEventArgs.cs index 0829466..47475e7 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlaybackInterruptedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlaybackInterruptedEventArgs.cs @@ -21,12 +21,14 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class PlaybackInterruptedEventArgs : EventArgs { /// /// Initializes a new instance of the PlaybackInterruptedEventArgs class. /// /// The enum value indicating the reason. + /// 3 public PlaybackInterruptedEventArgs(PlaybackInterruptionReason reason) { Reason = reason; @@ -35,12 +37,14 @@ namespace Tizen.Multimedia /// /// Gets the reason. /// + /// 3 public PlaybackInterruptionReason Reason { get; } /// /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() { return $"Reason : { Reason.ToString() }"; diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/Player.Events.cs b/src/Tizen.Multimedia.MediaPlayer/Player/Player.Events.cs index 11fee2d..559bcf4 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/Player.Events.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/Player.Events.cs @@ -28,12 +28,14 @@ namespace Tizen.Multimedia /// /// Occurs when the playback of a media is finished. /// + /// 3 public event EventHandler PlaybackCompleted; private NativePlayer.PlaybackCompletedCallback _playbackCompletedCallback; /// /// Occurs when the playback of a media is interrupted. /// + /// 3 public event EventHandler PlaybackInterrupted; private NativePlayer.PlaybackInterruptedCallback _playbackInterruptedCallback; @@ -41,6 +43,7 @@ namespace Tizen.Multimedia /// Occurs when any error occurs. ///
/// The event handler will be executed on an internal thread. + /// 3 public event EventHandler ErrorOccurred; private NativePlayer.PlaybackErrorCallback _playbackErrorCallback; @@ -48,6 +51,7 @@ namespace Tizen.Multimedia /// Occurs when the video stream is changed. ///
/// The event handler will be executed on an internal thread. + /// 3 public event EventHandler VideoStreamChanged; private NativePlayer.VideoStreamChangedCallback _videoStreamChangedCallback; @@ -55,12 +59,14 @@ namespace Tizen.Multimedia /// Occurs when the subtitle is updated. ///
/// The event handler will be executed on an internal thread. + /// 3 public event EventHandler SubtitleUpdated; private NativePlayer.SubtitleUpdatedCallback _subtitleUpdatedCallback; /// /// Occurs when there is a change in the buffering status of streaming. /// + /// 3 public event EventHandler BufferingProgressChanged; private NativePlayer.BufferingProgressCallback _bufferingProgressCallback; @@ -170,6 +176,7 @@ namespace Tizen.Multimedia /// http://tizen.org/feature/multimedia.raw_video /// The required feature is not supported. /// + /// 3 public event EventHandler VideoFrameDecoded { add diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/Player.Properties.cs b/src/Tizen.Multimedia.MediaPlayer/Player/Player.Properties.cs index 8dc3f24..6dc0322 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/Player.Properties.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/Player.Properties.cs @@ -24,6 +24,7 @@ using static Interop; namespace Tizen.Multimedia { + /// 3 public partial class Player { private void RetrieveProperties() @@ -39,6 +40,7 @@ namespace Tizen.Multimedia ///
/// An IntPtr that contains the native handle of the player. /// The player has already been disposed of. + /// 3 public IntPtr Handle { get @@ -59,6 +61,7 @@ namespace Tizen.Multimedia /// The player is not in the valid state. /// The player has already been disposed of. /// The value to set is null. + /// 3 public string Cookie { get @@ -89,6 +92,7 @@ namespace Tizen.Multimedia /// The player is not in the valid state. /// The player has already been disposed of. /// The value to set is null. + /// 3 public string UserAgent { get @@ -118,6 +122,7 @@ namespace Tizen.Multimedia ///
/// The current state of the player. /// The player has already been disposed of. + /// 3 public PlayerState State { get @@ -150,6 +155,7 @@ namespace Tizen.Multimedia /// /// The player has already been disposed of. /// The value is not valid. + /// 3 public AudioLatencyMode AudioLatencyMode { get @@ -181,6 +187,7 @@ namespace Tizen.Multimedia ///
/// true if the playback is looping; otherwise, false. The default value is false. /// The player has already been disposed of. + /// 3 public bool IsLooping { get @@ -208,6 +215,7 @@ namespace Tizen.Multimedia /// Gets the display settings. ///
/// A that specifies the display settings. + /// 3 public PlayerDisplaySettings DisplaySettings { get; } private Display _display; @@ -237,6 +245,7 @@ namespace Tizen.Multimedia /// The player has already been disposed of. /// The value has already been assigned to another player. /// The player is not in the valid state. + /// 3 public Display Display { get @@ -287,6 +296,7 @@ namespace Tizen.Multimedia /// Gets the track info for the audio. ///
/// A for audio. + /// 3 public PlayerTrackInfo AudioTrackInfo { get @@ -305,6 +315,7 @@ namespace Tizen.Multimedia /// Gets the track info for the subtitle. ///
/// A for the subtitle. + /// 3 public PlayerTrackInfo SubtitleTrackInfo { get @@ -323,6 +334,7 @@ namespace Tizen.Multimedia /// Gets the stream information. ///
/// A for this player. + /// 3 public StreamInfo StreamInfo { get @@ -342,6 +354,7 @@ namespace Tizen.Multimedia ///
/// http://tizen.org/feature/multimedia.custom_audio_effect /// The required feature is not supported. + /// 3 public AudioEffect AudioEffect { get @@ -360,6 +373,7 @@ namespace Tizen.Multimedia ///
/// true if the player is muted; otherwise, false. /// The player has already been disposed of. + /// 3 public bool Muted { get @@ -387,6 +401,7 @@ namespace Tizen.Multimedia /// -or-
/// is greater than 1.0. /// + /// 3 public float Volume { get diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs b/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs index 23be412..6eece57 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs @@ -44,6 +44,7 @@ namespace Tizen.Multimedia /// /// Initializes a new instance of the class. /// + /// 3 public Player() { NativePlayer.Create(out _handle).ThrowIfFailed("Failed to create player"); @@ -87,6 +88,7 @@ namespace Tizen.Multimedia /// /// Releases all resources used by the current instance. /// + /// 3 public void Dispose() { Dispose(true); @@ -144,6 +146,7 @@ namespace Tizen.Multimedia /// The player is not in the valid state. /// /// The player has already been disposed of. + /// 3 public DownloadProgress GetDownloadProgress() { ValidatePlayerState(PlayerState.Playing, PlayerState.Paused); @@ -169,6 +172,7 @@ namespace Tizen.Multimedia /// is an empty string. /// The specified path does not exist. /// is null. + /// 3 public void SetSubtitle(string path) { ValidateNotDisposed(); @@ -198,6 +202,7 @@ namespace Tizen.Multimedia /// The player must be in the state. /// The player has already been disposed of. /// The player is not in the valid state. + /// 3 public void ClearSubtitle() { ValidatePlayerState(PlayerState.Idle); @@ -218,6 +223,7 @@ namespace Tizen.Multimedia /// No subtitle is set. /// /// + /// 3 public void SetSubtitleOffset(int offset) { ValidatePlayerState(PlayerState.Playing, PlayerState.Paused); @@ -240,6 +246,7 @@ namespace Tizen.Multimedia /// /// Called when the is invoked. /// + /// 3 protected virtual void OnPreparing() { RegisterEvents(); @@ -254,6 +261,7 @@ namespace Tizen.Multimedia /// No source is set. /// The player has already been disposed of. /// The player is not in the valid state. + /// 3 public virtual Task PrepareAsync() { if (_source == null) @@ -300,6 +308,7 @@ namespace Tizen.Multimedia /// /// The player has already been disposed of. /// The player is not in the valid state. + /// 3 public virtual void Unprepare() { if (State == PlayerState.Idle) @@ -318,6 +327,7 @@ namespace Tizen.Multimedia /// Called after the is unprepared. ///
/// + /// 3 protected virtual void OnUnprepared() { _source?.DetachFrom(this); @@ -340,6 +350,7 @@ namespace Tizen.Multimedia /// /// /// + /// 3 public virtual void Start() { if (State == PlayerState.Playing) @@ -363,6 +374,7 @@ namespace Tizen.Multimedia /// The player is not in the valid state. /// /// + /// 3 public virtual void Stop() { if (State == PlayerState.Ready) @@ -385,6 +397,7 @@ namespace Tizen.Multimedia /// The player has already been disposed of. /// The player is not in the valid state. /// + /// 3 public virtual void Pause() { if (State == PlayerState.Paused) @@ -412,6 +425,7 @@ namespace Tizen.Multimedia /// It is not able to assign the source to the player. /// /// + /// 3 public void SetSource(MediaSource source) { ValidatePlayerState(PlayerState.Idle); @@ -438,6 +452,7 @@ namespace Tizen.Multimedia /// The player has already been disposed of. /// The player is not in the valid state. /// The required feature is not supported. + /// 3 public async Task CaptureVideoAsync() { ValidationUtil.ValidateFeatureSupported(Features.RawVideo); @@ -473,6 +488,7 @@ namespace Tizen.Multimedia /// The player has already been disposed of. /// The player is not in the valid state. /// + /// 3 public int GetPlayPosition() { ValidatePlayerState(PlayerState.Ready, PlayerState.Paused, PlayerState.Playing); @@ -520,6 +536,7 @@ namespace Tizen.Multimedia /// The player is not in the valid state. /// The specified position is not valid. /// + /// 3 public async Task SetPlayPositionAsync(int position, bool accurate) { ValidatePlayerState(PlayerState.Ready, PlayerState.Playing, PlayerState.Paused); @@ -564,6 +581,7 @@ namespace Tizen.Multimedia /// -or-
/// is zero. /// + /// 3 public void SetPlaybackRate(float rate) { if (rate < -5.0F || 5.0F < rate || rate == 0.0F) @@ -600,6 +618,7 @@ namespace Tizen.Multimedia /// of is not supported by . /// /// + /// 3 public void ApplyAudioStreamPolicy(AudioStreamPolicy policy) { if (policy == null) @@ -638,6 +657,7 @@ namespace Tizen.Multimedia /// /// This method supports the product infrastructure and is not intended to be used directly from application code. /// + /// 4 [EditorBrowsable(EditorBrowsableState.Never)] protected static Exception GetException(int errorCode, string message) => ((PlayerErrorCode)errorCode).GetException(message); diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs index 83e02ba..4aa2254 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs @@ -24,11 +24,13 @@ namespace Tizen.Multimedia /// /// Provides a means to configure display settings for video . /// + /// 3 public class PlayerDisplaySettings { /// /// This constructor supports the product infrastructure and is not intended to be used directly from application code. /// + /// 4 [EditorBrowsable(EditorBrowsableState.Never)] protected PlayerDisplaySettings(Player player) { @@ -46,6 +48,7 @@ namespace Tizen.Multimedia /// Gets the player of this instance. ///
/// The of this instance. + /// 4 protected Player Player { get; } /// @@ -56,6 +59,7 @@ namespace Tizen.Multimedia /// /// The player has already been disposed of. /// The specified value to set is invalid. + /// 3 public PlayerDisplayMode Mode { get @@ -82,6 +86,7 @@ namespace Tizen.Multimedia /// Operation failed; internal error. /// /// The player has already been disposed of. + /// 3 public bool IsVisible { get @@ -107,6 +112,7 @@ namespace Tizen.Multimedia /// /// The player has already been disposed of. /// The specified value to set is invalid. + /// 3 public Rotation Rotation { get @@ -139,6 +145,7 @@ namespace Tizen.Multimedia /// /// The player has already been disposed of. /// The width or the height is less than or equal to zero. + /// 3 public void SetRoi(Rectangle roi) { if (roi.Width <= 0) diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerEnums.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerEnums.cs index cfc5c38..10d2796 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerEnums.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerEnums.cs @@ -23,6 +23,7 @@ namespace Tizen.Multimedia /// /// /// + /// 3 public enum PlayerError { /// @@ -83,11 +84,13 @@ namespace Tizen.Multimedia /// /// Not supported audio codec. /// + /// 4 AudioCodecNotSupported = PlayerErrorCode.NotSupportedAudioCodec, /// /// Not supported video codec. /// + /// 4 VideoCodecNotSupported = PlayerErrorCode.NotSupportedVideoCodec, /// @@ -99,6 +102,7 @@ namespace Tizen.Multimedia /// /// Specifies states that a can have. /// + /// 3 public enum PlayerState { /// @@ -144,6 +148,7 @@ namespace Tizen.Multimedia /// Specifies audio latency modes for . /// /// + /// 3 public enum AudioLatencyMode { /// @@ -166,6 +171,7 @@ namespace Tizen.Multimedia /// Specifies display modes for . /// /// + /// 3 public enum PlayerDisplayMode { /// @@ -224,6 +230,7 @@ namespace Tizen.Multimedia /// /// /// + /// 3 public enum MediaStreamBufferStatus { /// @@ -241,6 +248,7 @@ namespace Tizen.Multimedia /// Specifies the reason for the playback interruption. /// /// + /// 3 public enum PlaybackInterruptionReason { /// @@ -253,6 +261,7 @@ namespace Tizen.Multimedia /// Specifies keys for the metadata. /// /// + /// 3 public enum StreamMetadataKey { /// diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerError.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerError.cs index a25bb4e..bb5a84d 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerError.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerError.cs @@ -128,12 +128,14 @@ namespace Tizen.Multimedia /// /// The exception that is thrown when there is no available space in a buffer. /// + /// 3 public class NoBufferSpaceException : InvalidOperationException { /// /// Initializes a new instance of the NoBufferSpaceException class with a specified error message. /// /// Error description. + /// 3 public NoBufferSpaceException(string message) : base(message) { } @@ -142,12 +144,14 @@ namespace Tizen.Multimedia /// /// The exception that is thrown when there is no available resource for internal use. /// + /// 3 public class ResourceLimitException : InvalidOperationException { /// /// Initializes a new instance of the ResourceLimitException class with a specified error message. /// /// Error description. + /// 3 public ResourceLimitException(string message) : base(message) { } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerErrorOccurredEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerErrorOccurredEventArgs.cs index 7971ed4..0aba0b8 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerErrorOccurredEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerErrorOccurredEventArgs.cs @@ -20,12 +20,14 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class PlayerErrorOccurredEventArgs : EventArgs { /// /// Initializes a new instance of the PlayerErrorOccurredEventArgs class. /// /// The value indicating the kind of error occurred. + /// 3 public PlayerErrorOccurredEventArgs(PlayerError error) { Error = error; @@ -34,12 +36,14 @@ namespace Tizen.Multimedia /// /// Gets the error. /// + /// 3 public PlayerError Error { get; } /// /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() { return $"Error={ Error.ToString() }"; diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerTrackInfo.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerTrackInfo.cs index 50345da..76da513 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerTrackInfo.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerTrackInfo.cs @@ -25,6 +25,7 @@ namespace Tizen.Multimedia /// /// /// + /// 3 public class PlayerTrackInfo { private readonly int _streamType; @@ -49,6 +50,7 @@ namespace Tizen.Multimedia /// /// The that this instance belongs to has been disposed of. /// The that this instance belongs to is not in the valid state. + /// 3 public int GetCount() { _owner.ValidatePlayerState(PlayerState.Ready, PlayerState.Playing, PlayerState.Paused); @@ -76,6 +78,7 @@ namespace Tizen.Multimedia /// -or-
/// is equal to or greater than . /// + /// 3 public string GetLanguageCode(int index) { _owner.ValidatePlayerState(PlayerState.Ready, PlayerState.Playing, PlayerState.Paused); @@ -125,6 +128,7 @@ namespace Tizen.Multimedia /// -or-
/// is equal to or greater than . /// + /// 3 public int Selected { get diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/StreamInfo.cs b/src/Tizen.Multimedia.MediaPlayer/Player/StreamInfo.cs index b82ba0c..ab0481d 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/StreamInfo.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/StreamInfo.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia /// /// Represents properties for the audio stream. /// + /// 3 public struct AudioStreamProperties { /// @@ -30,6 +31,7 @@ namespace Tizen.Multimedia /// The sample rate of the stream. /// The number of channels of the stream. /// The bit rate of the stream. + /// 3 public AudioStreamProperties(int sampleRate, int channels, int bitRate) { SampleRate = sampleRate; @@ -42,6 +44,7 @@ namespace Tizen.Multimedia /// Gets or sets the sample rate. /// /// The audio sample rate(Hz). + /// 3 public int SampleRate { get; @@ -51,6 +54,7 @@ namespace Tizen.Multimedia /// /// Gets or sets the channels. /// + /// 3 public int Channels { get; @@ -61,6 +65,7 @@ namespace Tizen.Multimedia /// Gets or sets the bit rate. ///
/// The audio bit rate(Hz). + /// 3 public int BitRate { get; @@ -71,6 +76,7 @@ namespace Tizen.Multimedia /// Returns a string that represents the current object. ///
/// A string that represents the current object. + /// 3 public override string ToString() => $"SampleRate={ SampleRate.ToString() }, Channels={ Channels.ToString() }, BitRate={ BitRate.ToString() }"; } @@ -78,6 +84,7 @@ namespace Tizen.Multimedia /// /// Represents properties for the video stream. /// + /// 3 public struct VideoStreamProperties { /// @@ -86,6 +93,7 @@ namespace Tizen.Multimedia /// The fps of the stream. /// The bit rate of the stream. /// The size of the stream. + /// 3 public VideoStreamProperties(int fps, int bitRate, Size size) { Fps = fps; @@ -101,6 +109,7 @@ namespace Tizen.Multimedia /// The bit rate of the stream. /// The width of the stream. /// The height of the stream. + /// 3 public VideoStreamProperties(int fps, int bitRate, int width, int height) { Fps = fps; @@ -113,6 +122,7 @@ namespace Tizen.Multimedia /// /// Gets or sets the fps. /// + /// 3 public int Fps { get; @@ -121,6 +131,7 @@ namespace Tizen.Multimedia /// /// Gets or sets the bit rate. /// + /// 3 public int BitRate { get; @@ -130,6 +141,7 @@ namespace Tizen.Multimedia /// /// Gets or sets the size. /// + /// 3 public Size Size { get; @@ -140,6 +152,7 @@ namespace Tizen.Multimedia /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() { return $"Fps={ Fps.ToString() }, BitRate={ BitRate.ToString() }, Size=[{ Size.ToString() }]"; @@ -149,6 +162,7 @@ namespace Tizen.Multimedia /// /// Provides a means to retrieve stream information. /// + /// 3 public class StreamInfo { internal StreamInfo(Player owner) @@ -170,6 +184,7 @@ namespace Tizen.Multimedia /// /// The that this instance belongs to is not in the valid state. /// + /// 3 public byte[] GetAlbumArt() { Player.ValidatePlayerState(PlayerState.Ready, PlayerState.Playing, PlayerState.Paused); @@ -221,6 +236,7 @@ namespace Tizen.Multimedia /// Retrieves the codec name of the audio or null if there is no audio. ///
/// A string that represents the codec name. + /// 3 public string GetAudioCodec() { return GetCodecInfo(true); @@ -230,6 +246,7 @@ namespace Tizen.Multimedia /// Retrieves the codec name of the video or null if there is no video. ///
/// A string that represents the codec name. + /// 3 public string GetVideoCodec() { return GetCodecInfo(false); @@ -249,6 +266,7 @@ namespace Tizen.Multimedia /// /// The that this instance belongs to is not in the valid state. /// + /// 3 public int GetDuration() { Player.ValidatePlayerState(PlayerState.Ready, PlayerState.Playing, PlayerState.Paused); @@ -275,6 +293,7 @@ namespace Tizen.Multimedia /// /// The that this instance belongs to is not in the valid state. /// + /// 3 public AudioStreamProperties GetAudioProperties() { Player.ValidatePlayerState(PlayerState.Ready, PlayerState.Playing, PlayerState.Paused); @@ -303,6 +322,7 @@ namespace Tizen.Multimedia /// /// The that this instance belongs to is not in the valid state. /// + /// 3 public VideoStreamProperties GetVideoProperties() { Player.ValidatePlayerState(PlayerState.Ready, PlayerState.Playing, PlayerState.Paused); @@ -343,6 +363,7 @@ namespace Tizen.Multimedia /// /// The that this instance belongs to is not in the valid state. /// + /// 3 public string GetMetadata(StreamMetadataKey key) { Player.ValidatePlayerState(PlayerState.Ready, PlayerState.Playing, PlayerState.Paused); @@ -367,6 +388,7 @@ namespace Tizen.Multimedia /// /// Gets the that owns this instance. /// + /// 3 public Player Player { get; } } } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/SubtitleUpdatedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/SubtitleUpdatedEventArgs.cs index 0aad452..f3ee00a 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/SubtitleUpdatedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/SubtitleUpdatedEventArgs.cs @@ -20,6 +20,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class SubtitleUpdatedEventArgs : EventArgs { internal SubtitleUpdatedEventArgs(uint duration, string text) @@ -31,17 +32,20 @@ namespace Tizen.Multimedia /// /// Gets the duration of the updated subtitle. /// + /// 3 public uint Duration { get; } /// /// Gets the text of the updated subtitle. /// + /// 3 public string Text { get; } /// /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() { return $"Duration={ Duration.ToString() }, Text={ Text }"; diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/VideoFrameDecodedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/VideoFrameDecodedEventArgs.cs index daa545d..89e97d2 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/VideoFrameDecodedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/VideoFrameDecodedEventArgs.cs @@ -20,6 +20,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class VideoFrameDecodedEventArgs : EventArgs { /// @@ -33,6 +34,7 @@ namespace Tizen.Multimedia /// /// Gets the packet containing the decoded frame. /// + /// 3 public MediaPacket Packet { get; } } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/VideoStreamChangedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/VideoStreamChangedEventArgs.cs index e269cac..ffd2d97 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/VideoStreamChangedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/VideoStreamChangedEventArgs.cs @@ -20,6 +20,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class VideoStreamChangedEventArgs : EventArgs { /// @@ -35,22 +36,26 @@ namespace Tizen.Multimedia /// /// Gets the of the new video. /// + /// 3 public Size Size { get; } /// /// Gets the fps of the new video. /// + /// 3 public int Fps { get; } /// /// Gets the bit rate of the new video. /// + /// 3 public int BitRate { get; } /// /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() { return $"Size=({ Size.ToString() }), Fps={ Fps.ToString() }, BitRate={ BitRate.ToString() }"; diff --git a/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs b/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs index 36ca2a2..e7d01b0 100644 --- a/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs +++ b/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs @@ -29,6 +29,7 @@ namespace Tizen.Multimedia /// Or if you want to access only an external storage, /// you should add privilege http://tizen.org/privilege/externalstorage. /// + /// 3 public class MetadataEditor : IDisposable { private bool _disposed = false; @@ -363,6 +364,7 @@ namespace Tizen.Multimedia /// The file is read-only. /// /// The has already been disposed of. + /// 3 public void Commit() { if (_isFileReadOnly) @@ -519,6 +521,7 @@ namespace Tizen.Multimedia /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. /// + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -536,6 +539,7 @@ namespace Tizen.Multimedia /// /// Releases all resources used by the object. /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Multimedia.Metadata/MetadataExtractor/Artwork.cs b/src/Tizen.Multimedia.Metadata/MetadataExtractor/Artwork.cs index 38afe72..26e6404 100755 --- a/src/Tizen.Multimedia.Metadata/MetadataExtractor/Artwork.cs +++ b/src/Tizen.Multimedia.Metadata/MetadataExtractor/Artwork.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia /// /// Represents the artwork information of the media. /// + /// 3 public class Artwork { /// diff --git a/src/Tizen.Multimedia.Metadata/MetadataExtractor/Metadata.cs b/src/Tizen.Multimedia.Metadata/MetadataExtractor/Metadata.cs index 873d33c..c81013c 100755 --- a/src/Tizen.Multimedia.Metadata/MetadataExtractor/Metadata.cs +++ b/src/Tizen.Multimedia.Metadata/MetadataExtractor/Metadata.cs @@ -23,6 +23,7 @@ namespace Tizen.Multimedia /// /// Represents the video metadata information. /// + /// 4 public class VideoMetadata { private VideoMetadata(int streamCount, MetadataExtractor extractor) @@ -49,42 +50,42 @@ namespace Tizen.Multimedia /// /// Gets the bitrate. /// - /// 3 + /// 4 /// The bitrate value, or null if the information does not exist. public int? BitRate { get; } /// /// Gets the video fps. /// - /// 3 + /// 4 /// The fps value, or null if the information does not exist. public int? Fps { get; } /// /// Gets the width of the video. /// - /// 3 + /// 4 /// The width value, or null if the information does not exist. public int? Width { get; } /// /// Gets the height of the video. /// - /// 3 + /// 4 /// The height value, or null if the information does not exist. public int? Height { get; } /// /// Gets the codec type of the video. /// - /// 3 + /// 4 /// A string representing the codec type, or null if the information does not exist. public string Codec { get; } /// /// Gets the video stream count. /// - /// 3 + /// 4 /// The number of video streams. public int StreamCount { get; } @@ -94,12 +95,14 @@ namespace Tizen.Multimedia /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 4 public override string ToString() => _description.Value; } /// /// Represents the audio metadata information. /// + /// 4 public class AudioMetadata { private AudioMetadata(int streamCount, MetadataExtractor extractor) @@ -126,42 +129,42 @@ namespace Tizen.Multimedia /// /// Gets the audio bitrate. /// - /// 3 + /// 4 /// The bit rate value, or null if the information does not exist. public int? BitRate { get; } /// /// Gets the audio channels. /// - /// 3 + /// 4 /// The number of the audio channels, or null if the information does not exist. public int? Channels { get; } /// /// Gets the audio sample rate. /// - /// 3 + /// 4 /// The sample rate, or null if the information does not exist. public int? SampleRate { get; } /// /// Gets the bit per sample of the audio. /// - /// 3 + /// 4 /// The bit per sample, or null if the information does not exist. public int? BitPerSample { get; } /// /// Gets the audio stream count. /// - /// 3 + /// 4 /// The number of audio streams. public int StreamCount { get; } /// /// Gets the audio codec type. /// - /// 3 + /// 4 public string Codec { get; } private Lazy _description; @@ -170,12 +173,14 @@ namespace Tizen.Multimedia /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 4 public override string ToString() => _description.Value; } /// /// Represents the metadata information of a media. /// + /// 3 public class Metadata { internal Metadata(MetadataExtractor extractor) @@ -215,21 +220,21 @@ namespace Tizen.Multimedia /// /// Gets the duration of the media. /// - /// 3 + /// 4 /// The duration value, or null if the information does not exist. public int? Duration { get; } /// /// Gets the video metadata. /// - /// 3 + /// 4 /// The video metadata, or null if the information does not exist. public VideoMetadata Video { get; } /// /// Gets the audio metadata. /// - /// 3 + /// 4 /// The audio metadata, or null if the information does not exist. public AudioMetadata Audio { get; } @@ -285,7 +290,7 @@ namespace Tizen.Multimedia /// /// Gets the release date of the media. /// - /// 3 + /// 4 /// A string representing the release date, or null if the information does not exist. public string DateReleased { get; } @@ -327,21 +332,21 @@ namespace Tizen.Multimedia /// /// Gets the longitude of the media. /// - /// 3 + /// 4 /// The longitude value, or null if the information does not exist. public double? Longitude { get; } /// /// Gets the latitude of the media. /// - /// 3 + /// 4 /// The latitude value, or null if the information does not exist. public double? Latitude { get; } /// /// Gets the altitude of the media. /// - /// 3 + /// 4 /// The altitude value, or null if the information does not exist. public double? Altitude { get; } @@ -355,28 +360,28 @@ namespace Tizen.Multimedia /// /// Gets the unsynchronized lyrics of the media. /// - /// 3 + /// 4 /// A string representing the unsynchronized lyrics, or null if the information does not exist. public string UnsyncLyrics { get; } /// /// Gets the number of synchronized lyrics of the media. /// - /// 3 + /// 4 /// The number of the synchronized lyrics. public int SyncLyricsCount { get; } /// /// Gets the recording date of the media. /// - /// 3 + /// 4 /// A string representing the recording date, or null if the information does not exist. public string DateRecorded { get; } /// /// Gets the rotate(orientation) information of the media. /// - /// 3 + /// 4 /// A string representing the rotation information, or null if the information does not exist. public string Rotation { get; } @@ -393,6 +398,7 @@ namespace Tizen.Multimedia /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() => _description.Value; } } diff --git a/src/Tizen.Multimedia.Metadata/MetadataExtractor/MetadataExtractor.cs b/src/Tizen.Multimedia.Metadata/MetadataExtractor/MetadataExtractor.cs index 21c9f92..83911e0 100644 --- a/src/Tizen.Multimedia.Metadata/MetadataExtractor/MetadataExtractor.cs +++ b/src/Tizen.Multimedia.Metadata/MetadataExtractor/MetadataExtractor.cs @@ -23,6 +23,7 @@ namespace Tizen.Multimedia /// /// Provides a means to get the metadata from a media file. /// + /// 3 public class MetadataExtractor : IDisposable { private bool _disposed = false; @@ -282,6 +283,7 @@ namespace Tizen.Multimedia /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. /// + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -314,6 +316,7 @@ namespace Tizen.Multimedia /// /// Releases all resources used by the object. /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs b/src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs index 43c03d3..6680aa6 100755 --- a/src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs +++ b/src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia /// /// Represents the synchronized lyrics information of the media. /// + /// 3 public class SyncLyrics { /// diff --git a/src/Tizen.Multimedia.Radio/Radio/Radio.cs b/src/Tizen.Multimedia.Radio/Radio/Radio.cs index 5b4f4cc..e1874b9 100755 --- a/src/Tizen.Multimedia.Radio/Radio/Radio.cs +++ b/src/Tizen.Multimedia.Radio/Radio/Radio.cs @@ -26,6 +26,7 @@ namespace Tizen.Multimedia /// /// Provides a means for using the radio feature. /// + /// 3 public class Radio : IDisposable { private RadioHandle _handle; @@ -36,6 +37,7 @@ namespace Tizen.Multimedia /// Initializes a new instance of the Radio class. /// /// The radio feature is not supported. + /// 3 public Radio() { CompatibilitySupport.DisableSessionBackwardCompatibility(); @@ -96,26 +98,31 @@ namespace Tizen.Multimedia /// /// Occurs when the radio scanning information is updated. /// + /// 3 public event EventHandler ScanUpdated; /// /// Occurs when the radio scanning stops. /// + /// 3 public event EventHandler ScanStopped; /// /// Occurs when the radio scanning is completed. /// + /// 3 public event EventHandler ScanCompleted; /// /// Occurs when the radio is interrupted. /// + /// 3 public event EventHandler Interrupted; /// /// Gets the current state of the radio. /// + /// 3 public RadioState State { get @@ -133,6 +140,7 @@ namespace Tizen.Multimedia /// -or-
/// is greater than of . /// + /// 3 public int Frequency { get @@ -155,6 +163,7 @@ namespace Tizen.Multimedia /// /// Gets the current signal strength in the range of -128 ~ 128 dBm. /// + /// 3 public int SignalStrength { get @@ -172,6 +181,7 @@ namespace Tizen.Multimedia /// true if the radio is muted; otherwise, false. /// The default is false. /// + /// 3 public bool IsMuted { get @@ -188,6 +198,7 @@ namespace Tizen.Multimedia /// /// Gets the channel spacing for the current region. /// + /// 3 public int ChannelSpacing { get @@ -208,6 +219,7 @@ namespace Tizen.Multimedia /// -or-
/// is greater than 1.0. /// + /// 3 public float Volume { get @@ -230,6 +242,7 @@ namespace Tizen.Multimedia /// /// Gets the frequency for the region in the range of 87500 ~ 108000 kHz. /// + /// 3 public Range FrequencyRange { get @@ -246,6 +259,7 @@ namespace Tizen.Multimedia ///
/// The radio must be in the state. /// The radio is not in the valid state. + /// 3 public void Start() { ValidateRadioState(RadioState.Ready); @@ -258,6 +272,7 @@ namespace Tizen.Multimedia ///
/// The radio must be in the state. /// The radio is not in the valid state. + /// 3 public void Stop() { ValidateRadioState(RadioState.Playing); @@ -272,6 +287,7 @@ namespace Tizen.Multimedia /// The radio is not in the valid state. /// /// + /// 3 public void StartScan() { ValidateRadioState(RadioState.Ready, RadioState.Playing); @@ -285,6 +301,7 @@ namespace Tizen.Multimedia /// The radio must be in the state. /// The radio is not in the valid state. /// + /// 3 public void StopScan() { ValidateRadioState(RadioState.Scanning); @@ -306,6 +323,7 @@ namespace Tizen.Multimedia /// -or-
/// Seeking is in progress. /// + /// 3 public Task SeekUpAsync() { return SeekAsync(Native.SeekUp); @@ -325,6 +343,7 @@ namespace Tizen.Multimedia /// -or-
/// Seeking is in progress. /// + /// 3 public Task SeekDownAsync() { return SeekAsync(Native.SeekDown); @@ -373,6 +392,7 @@ namespace Tizen.Multimedia /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. /// + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -388,6 +408,7 @@ namespace Tizen.Multimedia /// /// Releases all resources used by the object. /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Multimedia.Radio/Radio/RadioInterruptedEventArgs.cs b/src/Tizen.Multimedia.Radio/Radio/RadioInterruptedEventArgs.cs index 84e4340..d89cade 100644 --- a/src/Tizen.Multimedia.Radio/Radio/RadioInterruptedEventArgs.cs +++ b/src/Tizen.Multimedia.Radio/Radio/RadioInterruptedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class RadioInterruptedEventArgs : EventArgs { internal RadioInterruptedEventArgs(RadioInterruptedReason reason) @@ -32,12 +33,14 @@ namespace Tizen.Multimedia /// Gets the reason. ///
/// The reason for interruption. + /// 3 public RadioInterruptedReason Reason { get; } /// /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() => $"Reason={ Reason.ToString() }"; } } diff --git a/src/Tizen.Multimedia.Radio/Radio/RadioInterruptedReason.cs b/src/Tizen.Multimedia.Radio/Radio/RadioInterruptedReason.cs index d6cb24c..2b6756f 100644 --- a/src/Tizen.Multimedia.Radio/Radio/RadioInterruptedReason.cs +++ b/src/Tizen.Multimedia.Radio/Radio/RadioInterruptedReason.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia /// /// Specifies interrupted reasons. /// + /// 3 public enum RadioInterruptedReason { /// diff --git a/src/Tizen.Multimedia.Radio/Radio/RadioState.cs b/src/Tizen.Multimedia.Radio/Radio/RadioState.cs index 38db7f0..ab72846 100644 --- a/src/Tizen.Multimedia.Radio/Radio/RadioState.cs +++ b/src/Tizen.Multimedia.Radio/Radio/RadioState.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia /// /// Specifies states of the . /// + /// 3 public enum RadioState { /// diff --git a/src/Tizen.Multimedia.Radio/Radio/ScanUpdatedEventArgs.cs b/src/Tizen.Multimedia.Radio/Radio/ScanUpdatedEventArgs.cs index 72075d8..01f2aaa 100644 --- a/src/Tizen.Multimedia.Radio/Radio/ScanUpdatedEventArgs.cs +++ b/src/Tizen.Multimedia.Radio/Radio/ScanUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class ScanUpdatedEventArgs : EventArgs { internal ScanUpdatedEventArgs(int tunedFrequency) @@ -31,12 +32,14 @@ namespace Tizen.Multimedia /// /// Gets the tuned radio frequency that is scanned, in the range of 87500 ~ 108000 kHz. /// + /// 3 public int Frequency { get; } /// /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() { return $"Frequency={ Frequency.ToString() }"; diff --git a/src/Tizen.Multimedia.Recorder/Recorder/AudioRecorder.cs b/src/Tizen.Multimedia.Recorder/Recorder/AudioRecorder.cs index c1f97ec..d265440 100644 --- a/src/Tizen.Multimedia.Recorder/Recorder/AudioRecorder.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/AudioRecorder.cs @@ -23,6 +23,7 @@ namespace Tizen.Multimedia /// /// Provides the ability to control audio recording. /// + /// 4 public class AudioRecorder : Recorder { private static NativeHandle CreateHandle() @@ -69,6 +70,7 @@ namespace Tizen.Multimedia /// /// /// + /// 4 public AudioRecorder(RecorderAudioCodec audioCodec, RecorderFileFormat fileFormat) : base(CreateHandle()) { SetFormatAndCodec(audioCodec, fileFormat); @@ -96,6 +98,7 @@ namespace Tizen.Multimedia /// /// /// + /// 4 public void SetFormatAndCodec(RecorderAudioCodec audioCodec, RecorderFileFormat fileFormat) { ThrowIfCodecAndFormatNotValid(audioCodec, fileFormat); diff --git a/src/Tizen.Multimedia.Recorder/Recorder/AudioStreamStoringEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/AudioStreamStoringEventArgs.cs index decd536..ccd3798 100644 --- a/src/Tizen.Multimedia.Recorder/Recorder/AudioStreamStoringEventArgs.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/AudioStreamStoringEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 4 public class AudioStreamStoringEventArgs : EventArgs { internal AudioStreamStoringEventArgs(IMediaBuffer stream, AudioSampleType type, int channel, @@ -41,21 +42,25 @@ namespace Tizen.Multimedia /// The buffer is only valid in the event.
/// Any attempt to access to this buffer after the event ends will throw an exception. /// + /// 4 public IMediaBuffer Stream { get; } /// /// Gets the audio format type. /// + /// 4 public AudioSampleType Type { get; } /// /// Gets the number of channels. /// + /// 4 public int Channels { get; } /// /// Gets the timestamp(PTS) of stream buffer in milliseconds. /// + /// 4 public long Timestamp { get; } } } diff --git a/src/Tizen.Multimedia.Recorder/Recorder/MuxedStreamDeliveredEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/MuxedStreamDeliveredEventArgs.cs index c0730e6..cfd7b82 100644 --- a/src/Tizen.Multimedia.Recorder/Recorder/MuxedStreamDeliveredEventArgs.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/MuxedStreamDeliveredEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class MuxedStreamDeliveredEventArgs : EventArgs { internal MuxedStreamDeliveredEventArgs(IMediaBuffer stream, ulong offset) @@ -36,11 +37,13 @@ namespace Tizen.Multimedia /// This buffer is read-only and only valid in the event.
/// Any attempt to access to this buffer after the event ends will throw an exception. /// + /// 3 public IMediaBuffer Stream { get; } /// /// The file offset where the buffer will be written. /// + /// 3 public long Offset { get; } } } diff --git a/src/Tizen.Multimedia.Recorder/Recorder/Recorder.Capabilities.cs b/src/Tizen.Multimedia.Recorder/Recorder/Recorder.Capabilities.cs index be0b9a7..acd39c3 100644 --- a/src/Tizen.Multimedia.Recorder/Recorder/Recorder.Capabilities.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/Recorder.Capabilities.cs @@ -62,6 +62,7 @@ namespace Tizen.Multimedia } } + /// 3 public partial class Recorder { internal static Lazy Capabilities { get; } = new Lazy(LoadCapabilities); @@ -86,11 +87,13 @@ namespace Tizen.Multimedia /// /// Gets the file formats that the current device supports. /// + /// 4 public static IEnumerable GetSupportedFileFormats() => Capabilities.Value.SupportedFileFormats; /// /// Gets the audio encoders that the current device supports. /// + /// 4 public static IEnumerable GetSupportedAudioCodecs() => Capabilities.Value.SupportedAudioCodecs; internal static void ValidateFileFormat(RecorderFileFormat format) diff --git a/src/Tizen.Multimedia.Recorder/Recorder/Recorder.Events.cs b/src/Tizen.Multimedia.Recorder/Recorder/Recorder.Events.cs index 31d6447..21cd4c6 100755 --- a/src/Tizen.Multimedia.Recorder/Recorder/Recorder.Events.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/Recorder.Events.cs @@ -25,24 +25,28 @@ namespace Tizen.Multimedia /// /// Occurs when an error occurs during the recorder operation. /// + /// 3 public event EventHandler ErrorOccurred; private Native.RecorderErrorCallback _errorOccurredCallback; /// /// Occurs after interrupt handling is completed. /// + /// 3 public event EventHandler Interrupted; private Native.InterruptedCallback _interruptedCallback; /// /// This event occurs when the recorder state is changed. /// + /// 3 public event EventHandler StateChanged; private Native.StatechangedCallback _stateChangedCallback; /// /// Occurs when the recording information changes. /// + /// 4 public event EventHandler RecordingStatusChanged; private Native.RecordingProgressCallback _recordingProgressCallback; @@ -53,6 +57,7 @@ namespace Tizen.Multimedia /// /// Do not call and in this event. /// + /// 4 public event EventHandler AudioStreamStoring; private Native.AudioStreamCallback _audioStreamCallback; @@ -62,12 +67,14 @@ namespace Tizen.Multimedia /// /// After this event is raised, the recording data is discarded and not written in the recording file. /// + /// 3 public event EventHandler RecordingLimitReached; private Native.RecordingLimitReachedCallback _recordingLimitReachedCallback; /// /// Occurs when the muxed stream data is being delivered. /// + /// 3 public event EventHandler MuxedStreamDelivered; private Native.MuxedStreamCallback _muxedStreamCallback; @@ -176,6 +183,7 @@ namespace Tizen.Multimedia /// /// Occurs before interrupt handling is started. /// + /// 4 public event EventHandler Interrupting; private Native.InterruptStartedCallback _interruptingCallback; @@ -200,6 +208,7 @@ namespace Tizen.Multimedia /// /// Occurs when a recorder device state changes. /// + /// 4 public static event EventHandler DeviceStateChanged { add diff --git a/src/Tizen.Multimedia.Recorder/Recorder/Recorder.Settings.cs b/src/Tizen.Multimedia.Recorder/Recorder/Recorder.Settings.cs index c30c60b..4c9da41 100755 --- a/src/Tizen.Multimedia.Recorder/Recorder/Recorder.Settings.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/Recorder.Settings.cs @@ -28,6 +28,7 @@ namespace Tizen.Multimedia /// Gets the audio codec for encoding an audio stream. ///
/// + /// 4 public RecorderAudioCodec AudioCodec { get => _audioCodec; @@ -52,6 +53,7 @@ namespace Tizen.Multimedia /// Gets the file format of the recording result. ///
/// + /// 4 public RecorderFileFormat FileFormat { get => _fileFormat; @@ -80,6 +82,7 @@ namespace Tizen.Multimedia /// is less than or equal to zero. /// The recorder is not in the valid state. /// The recorder already has been disposed of. + /// 4 public int AudioChannels { get @@ -113,6 +116,7 @@ namespace Tizen.Multimedia /// is not valid. /// The recorder is not in the valid state. /// The recorder already has been disposed of. + /// 4 public RecorderAudioDevice AudioDevice { get @@ -141,6 +145,7 @@ namespace Tizen.Multimedia /// is less than or equal to zero. /// The recorder is not in the valid state. /// The recorder already has been disposed of. + /// 4 public int AudioSampleRate { get @@ -175,6 +180,7 @@ namespace Tizen.Multimedia /// is less than or equal to zero. /// The recorder is not in the valid state. /// The recorder already has been disposed of. + /// 4 public int AudioBitRate { get @@ -214,6 +220,7 @@ namespace Tizen.Multimedia /// is less than zero. /// The recorder is not in the valid state. /// The recorder already has been disposed of. + /// 4 public int SizeLimit { get @@ -255,6 +262,7 @@ namespace Tizen.Multimedia /// is less than zero. /// The recorder is not in the valid state. /// The recorder already has been disposed of. + /// 4 public int TimeLimit { get @@ -283,6 +291,7 @@ namespace Tizen.Multimedia /// Gets or sets the mute state of a recorder. ///
/// The recorder already has been disposed of. + /// 4 public bool Muted { get => Native.GetMute(Handle); diff --git a/src/Tizen.Multimedia.Recorder/Recorder/Recorder.cs b/src/Tizen.Multimedia.Recorder/Recorder/Recorder.cs index 630d210..b3fba7e 100755 --- a/src/Tizen.Multimedia.Recorder/Recorder/Recorder.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/Recorder.cs @@ -71,6 +71,7 @@ namespace Tizen.Multimedia /// /// Releases the unmanaged resources used by the Recorder. /// + /// 3 public void Dispose() { Dispose(true); @@ -82,6 +83,7 @@ namespace Tizen.Multimedia /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. /// + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -122,6 +124,7 @@ namespace Tizen.Multimedia ///
/// A that specifies the state of the recorder. /// The recorder already has been disposed of. + /// 3 public RecorderState State { get @@ -148,6 +151,7 @@ namespace Tizen.Multimedia /// An internal error occurred. /// /// The recorder already has been disposed of. + /// 3 public void Prepare() { if (_state == RecorderState.Ready) @@ -184,6 +188,7 @@ namespace Tizen.Multimedia /// An internal error occurred. /// /// The recorder already has been disposed of. + /// 3 public void Unprepare() { ThrowIfAccessedInAudioStreamStoring(); @@ -229,6 +234,7 @@ namespace Tizen.Multimedia /// Caller does not have required privilege. /// /// + /// 4 public void Start(string savePath) { ValidateState(RecorderState.Ready); @@ -264,6 +270,7 @@ namespace Tizen.Multimedia /// An internal error occurred. /// /// The recorder already has been disposed of. + /// 4 public void Resume() { if (_state == RecorderState.Recording) @@ -292,6 +299,7 @@ namespace Tizen.Multimedia /// An internal error occurred. /// /// The recorder already has been disposed of. + /// 3 public void Pause() { if (_state == RecorderState.Paused) @@ -321,6 +329,7 @@ namespace Tizen.Multimedia /// An internal error occurred. /// /// The recorder already has been disposed of. + /// 3 public void Commit() { ThrowIfAccessedInAudioStreamStoring(); @@ -348,6 +357,7 @@ namespace Tizen.Multimedia /// An internal error occurred. /// /// The recorder already has been disposed of. + /// 3 public void Cancel() { ThrowIfAccessedInAudioStreamStoring(); @@ -379,6 +389,7 @@ namespace Tizen.Multimedia /// -or-
/// already has been disposed of. /// + /// 4 public void ApplyAudioStreamPolicy(AudioStreamPolicy policy) { if (policy == null) @@ -400,6 +411,7 @@ namespace Tizen.Multimedia /// The recorder must be in the or the state. /// /// The recorder already has been disposed of. + /// 4 public double GetPeakAudioLevel() { ValidateState(RecorderState.Recording, RecorderState.Paused); @@ -413,6 +425,7 @@ namespace Tizen.Multimedia /// Returns the state of recorder device. ///
/// is invalid. + /// 4 public static RecorderDeviceState GetDeviceState(RecorderType type) { ValidationUtil.ValidateEnum(typeof(RecorderType), type, nameof(type)); diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecorderDeviceException.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecorderDeviceException.cs index 1267870..5d29110 100644 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecorderDeviceException.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecorderDeviceException.cs @@ -21,11 +21,13 @@ namespace Tizen.Multimedia /// /// The exception that is thrown when a recorder device-related error occurs. /// + /// 4 public class RecorderDeviceException : Exception { /// /// Initializes a new instance of the class. /// + /// 4 public RecorderDeviceException() : base() { } @@ -33,6 +35,7 @@ namespace Tizen.Multimedia /// /// Initializes a new instance of the class with a specified error message. /// + /// 4 public RecorderDeviceException(string message) : base(message) { } @@ -41,6 +44,7 @@ namespace Tizen.Multimedia /// Initializes a new instance of the class with /// a specified error message and inner exception. ///
+ /// 4 public RecorderDeviceException(string message, Exception innerException) : base(message, innerException) { } diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecorderDeviceStateChangedEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecorderDeviceStateChangedEventArgs.cs index 1b52f51..814aeef 100644 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecorderDeviceStateChangedEventArgs.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecorderDeviceStateChangedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 4 public class RecorderDeviceStateChangedEventArgs : EventArgs { internal RecorderDeviceStateChangedEventArgs(RecorderType type, RecorderDeviceState state) @@ -32,11 +33,13 @@ namespace Tizen.Multimedia /// /// Gets the recorder type. /// + /// 4 public RecorderType Type { get; } /// /// Gets the device state. /// + /// 4 public RecorderDeviceState DeviceState { get; } } } diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecorderEnums.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecorderEnums.cs index 8d93891..544a280 100755 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecorderEnums.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecorderEnums.cs @@ -20,11 +20,13 @@ namespace Tizen.Multimedia /// Specifies audio codecs for . ///
/// + /// 3 public enum RecorderAudioCodec { /// /// Disabled. /// + /// 4 None = -1, /// /// AMR codec. @@ -51,6 +53,7 @@ namespace Tizen.Multimedia /// /// Specifies audio capture devices for . /// + /// 3 public enum RecorderAudioDevice { /// @@ -67,6 +70,7 @@ namespace Tizen.Multimedia /// Specifies container formats for . /// /// + /// 3 public enum RecorderFileFormat { /// @@ -105,6 +109,7 @@ namespace Tizen.Multimedia /// /// /// + /// 3 public enum RecorderPolicy { /// @@ -123,6 +128,7 @@ namespace Tizen.Multimedia /// /// /// + /// 3 public enum RecordingLimitType { /// @@ -142,11 +148,13 @@ namespace Tizen.Multimedia /// /// Specifies states for . /// + /// 3 public enum RecorderState { /// /// Recorder is created, but not prepared. /// + /// 4 Idle = 1, /// /// Recorder is ready to record. In case of a video recorder, @@ -167,6 +175,7 @@ namespace Tizen.Multimedia /// Specifies video codecs for . /// /// + /// 3 public enum RecorderVideoCodec { /// @@ -191,6 +200,7 @@ namespace Tizen.Multimedia /// Specifies errors for . /// /// + /// 4 public enum RecorderError { /// @@ -222,6 +232,7 @@ namespace Tizen.Multimedia /// /// Specifies recorder types for . /// + /// 4 public enum RecorderType { /// @@ -238,6 +249,7 @@ namespace Tizen.Multimedia /// /// Specifies recorder device states for . /// + /// 4 public enum RecorderDeviceState { /// diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecorderExtensions.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecorderExtensions.cs index 9182089..19924b1 100644 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecorderExtensions.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecorderExtensions.cs @@ -23,6 +23,7 @@ namespace Tizen.Multimedia /// /// Provides extension methods for . /// + /// 4 public static class RecorderExtensions { /// @@ -31,6 +32,7 @@ namespace Tizen.Multimedia /// An IEnumerable of representing the supported file formats. /// The . /// is invalid. + /// 4 public static IEnumerable GetSupportedFileFormats(this RecorderVideoCodec videoCodec) { ValidationUtil.ValidateEnum(typeof(RecorderVideoCodec), videoCodec, nameof(videoCodec)); @@ -60,6 +62,7 @@ namespace Tizen.Multimedia /// An IEnumerable of representing the supported file formats. /// The . /// is invalid. + /// 4 public static IEnumerable GetSupportedFileFormats(this RecorderAudioCodec audioCodec) { ValidationUtil.ValidateEnum(typeof(RecorderAudioCodec), audioCodec, nameof(audioCodec)); diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptedEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptedEventArgs.cs index cae1329..d558ce6 100755 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptedEventArgs.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class RecorderInterruptedEventArgs : EventArgs { internal RecorderInterruptedEventArgs(RecorderPolicy policy, RecorderState previous, RecorderState current) @@ -33,16 +34,19 @@ namespace Tizen.Multimedia /// /// Gets the reason that interrupted the recorder. /// + /// 4 public RecorderPolicy Reason { get; } /// /// Gets the previous state of the recorder. /// + /// 3 public RecorderState Previous { get; } /// /// Gets the current state of the recorder. /// + /// 3 public RecorderState Current { get; } } } diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptingEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptingEventArgs.cs index 4e90317..7df770f 100644 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptingEventArgs.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptingEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 4 public class RecorderInterruptingEventArgs : EventArgs { internal RecorderInterruptingEventArgs(RecorderPolicy policy, RecorderState state) @@ -32,11 +33,13 @@ namespace Tizen.Multimedia /// /// Gets the reason of the interrupt. /// + /// 4 public RecorderPolicy Reason { get; } /// /// Gets the previous state of the recorder. /// + /// 4 public RecorderState State { get; } } } diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecorderStateChangedEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecorderStateChangedEventArgs.cs index 34b8522..0ed28c9 100755 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecorderStateChangedEventArgs.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecorderStateChangedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class RecorderStateChangedEventArgs : EventArgs { internal RecorderStateChangedEventArgs(RecorderState previous, RecorderState current, bool byPolicy) @@ -33,17 +34,20 @@ namespace Tizen.Multimedia /// /// Gets the previous state of the recorder. /// + /// 4 public RecorderState PreviousState { get; } /// /// Gets the current state of the recorder. /// + /// 4 public RecorderState CurrentState { get; } /// /// Gets the value indicating whether the state is changed by policy. /// /// true if the state changed by policy such as resource conflict or security, otherwise false. + /// 3 public bool IsStateChangedByPolicy { get; } } } diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecordingErrorOccurredEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecordingErrorOccurredEventArgs.cs index 059ae9f..e635ba9 100755 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecordingErrorOccurredEventArgs.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecordingErrorOccurredEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class RecordingErrorOccurredEventArgs : EventArgs { internal RecordingErrorOccurredEventArgs(RecorderError error, RecorderState state) @@ -31,6 +32,7 @@ namespace Tizen.Multimedia /// /// Gets the error. /// + /// 3 public RecorderError Error { get; } } } diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecordingLimitReachedEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecordingLimitReachedEventArgs.cs index 7fbcd4e..a13ab35 100755 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecordingLimitReachedEventArgs.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecordingLimitReachedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class RecordingLimitReachedEventArgs : EventArgs { /// @@ -28,6 +29,7 @@ namespace Tizen.Multimedia /// with the specified type. /// /// The type of the limit. + /// 3 public RecordingLimitReachedEventArgs(RecordingLimitType type) { Type = type; @@ -36,6 +38,7 @@ namespace Tizen.Multimedia /// /// Gets the type of the limit. /// + /// 3 public RecordingLimitType Type { get; } } } diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecordingStatusChangedEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecordingStatusChangedEventArgs.cs index 5c5726b..ed778c0 100644 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecordingStatusChangedEventArgs.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecordingStatusChangedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 4 public class RecordingStatusChangedEventArgs : EventArgs { /// @@ -29,6 +30,7 @@ namespace Tizen.Multimedia /// /// The time of the recording in milliseconds. /// The size of the recording in kilobytes. + /// 4 public RecordingStatusChangedEventArgs(long elapsedTime, long fileSize) { ElapsedTime = elapsedTime; @@ -38,11 +40,13 @@ namespace Tizen.Multimedia /// /// Gets the time of the recording in milliseconds. /// + /// 4 public long ElapsedTime { get; } /// /// Gets the size of the recording file in kilobytes. /// + /// 4 public long FileSize { get; } } } diff --git a/src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.Capabilities.cs b/src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.Capabilities.cs index 7f1d3e0..8932237 100644 --- a/src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.Capabilities.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.Capabilities.cs @@ -23,6 +23,7 @@ using NativeHandle = Interop.RecorderHandle; namespace Tizen.Multimedia { + /// 4 public partial class VideoRecorder { private static IEnumerable _frontResolutions; @@ -64,6 +65,7 @@ namespace Tizen.Multimedia /// The camera device to retrieve the supported resolutions. /// A required feature is not supported. /// is invalid. + /// 4 public static IEnumerable GetSupportedVideoResolutions(CameraDevice device) { ValidationUtil.ValidateEnum(typeof(CameraDevice), device, nameof(device)); @@ -88,6 +90,7 @@ namespace Tizen.Multimedia /// /// http://tizen.org/feature/camera /// A required feature is not supported. + /// 4 public static IEnumerable GetSupportedVideoCodecs() => Capabilities.Value.SupportedVideoCodecs ?? throw new NotSupportedException("Video recording is not supported."); diff --git a/src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.cs b/src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.cs index cb396b0..ffe646b 100755 --- a/src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.cs @@ -87,6 +87,7 @@ namespace Tizen.Multimedia /// /// /// + /// 4 public VideoRecorder(Camera camera, RecorderVideoCodec videoCodec, RecorderFileFormat fileFormat) : this(camera, videoCodec, RecorderAudioCodec.None, fileFormat) { @@ -136,6 +137,7 @@ namespace Tizen.Multimedia /// /// /// + /// 4 public VideoRecorder(Camera camera, RecorderVideoCodec videoCodec, RecorderAudioCodec audioCodec, RecorderFileFormat fileFormat) : base(CreateHandle(camera)) { @@ -162,6 +164,7 @@ namespace Tizen.Multimedia /// /// /// + /// 4 public void SetFormatAndCodec(RecorderVideoCodec videoCodec, RecorderFileFormat fileFormat) { SetFormatAndCodec(videoCodec, RecorderAudioCodec.None, fileFormat); @@ -196,6 +199,7 @@ namespace Tizen.Multimedia /// /// /// + /// 4 public void SetFormatAndCodec(RecorderVideoCodec videoCodec, RecorderAudioCodec audioCodec, RecorderFileFormat fileFormat) { ThrowIfCodecAndFormatNotValid(videoCodec, audioCodec, fileFormat); @@ -212,6 +216,7 @@ namespace Tizen.Multimedia /// /// Gets the audio codec for encoding an audio stream. /// + /// 4 public RecorderVideoCodec VideoCodec { get => _videoCodec; @@ -240,6 +245,7 @@ namespace Tizen.Multimedia /// The is less than or equal to 0. /// The recorder is not in the valid state. /// The recorder already has been disposed of. + /// 4 public double VideoMotionRate { get @@ -270,6 +276,7 @@ namespace Tizen.Multimedia /// A that specifies the type of orientation. /// is not valid. /// The recorder already has been disposed of. + /// 4 public Rotation VideoOrientationTag { get @@ -299,6 +306,7 @@ namespace Tizen.Multimedia /// The recorder is not in the valid state. /// The recorder already has been disposed of. /// + /// 4 public Size VideoResolution { get @@ -339,6 +347,7 @@ namespace Tizen.Multimedia /// is less than or equal to zero. /// The recorder is not in the valid state. /// The recorder already has been disposed of. + /// 4 public int VideoBitRate { get diff --git a/src/Tizen.Multimedia.Remoting/MediaController/MediaControlMetadata.cs b/src/Tizen.Multimedia.Remoting/MediaController/MediaControlMetadata.cs index 8ec676d..813d343 100644 --- a/src/Tizen.Multimedia.Remoting/MediaController/MediaControlMetadata.cs +++ b/src/Tizen.Multimedia.Remoting/MediaController/MediaControlMetadata.cs @@ -23,11 +23,13 @@ namespace Tizen.Multimedia.Remoting /// /// Represents metadata for media control. /// + /// 4 public class MediaControlMetadata { /// /// Initializes a new instance of the class. /// + /// 4 public MediaControlMetadata() { } @@ -52,56 +54,67 @@ namespace Tizen.Multimedia.Remoting /// /// Gets or sets the title. /// + /// 4 public string Title { get; set; } /// /// Gets or sets the artist. /// + /// 4 public string Artist { get; set; } /// /// Gets or sets the album. /// + /// 4 public string Album { get; set; } /// /// Gets or sets the author. /// + /// 4 public string Author { get; set; } /// /// Gets or sets the genre. /// + /// 4 public string Genre { get; set; } /// /// Gets or sets the duration. /// + /// 4 public string Duration { get; set; } /// /// Gets or sets the date. /// + /// 4 public string Date { get; set; } /// /// Gets or sets the copyright. /// + /// 4 public string Copyright { get; set; } /// /// Gets or sets the description. /// + /// 4 public string Description { get; set; } /// /// Gets or sets the track number. /// + /// 4 public string TrackNumber { get; set; } /// /// Gets or sets the path of the album art. /// + /// 4 public string AlbumArtPath { get; set; } } } \ No newline at end of file diff --git a/src/Tizen.Multimedia.Remoting/MediaController/MediaControlPlaybackCommand.cs b/src/Tizen.Multimedia.Remoting/MediaController/MediaControlPlaybackCommand.cs index 664eb19..f092ca8 100644 --- a/src/Tizen.Multimedia.Remoting/MediaController/MediaControlPlaybackCommand.cs +++ b/src/Tizen.Multimedia.Remoting/MediaController/MediaControlPlaybackCommand.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia.Remoting /// /// Specifies playback commands. /// + /// 4 public enum MediaControlPlaybackCommand { /// diff --git a/src/Tizen.Multimedia.Remoting/MediaController/MediaControlPlaybackState.cs b/src/Tizen.Multimedia.Remoting/MediaController/MediaControlPlaybackState.cs index e1f3fc1..3c4a973 100644 --- a/src/Tizen.Multimedia.Remoting/MediaController/MediaControlPlaybackState.cs +++ b/src/Tizen.Multimedia.Remoting/MediaController/MediaControlPlaybackState.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia.Remoting /// /// Specifies playback states. /// + /// 4 public enum MediaControlPlaybackState { /// diff --git a/src/Tizen.Multimedia.Remoting/MediaController/MediaControlServer.cs b/src/Tizen.Multimedia.Remoting/MediaController/MediaControlServer.cs index 6e944d3..2f8ffa6 100644 --- a/src/Tizen.Multimedia.Remoting/MediaController/MediaControlServer.cs +++ b/src/Tizen.Multimedia.Remoting/MediaController/MediaControlServer.cs @@ -24,6 +24,7 @@ namespace Tizen.Multimedia.Remoting /// /// /// + /// 4 public static class MediaControlServer { private static IntPtr _handle = IntPtr.Zero; @@ -35,6 +36,7 @@ namespace Tizen.Multimedia.Remoting /// true if the server has started; otherwise, false. /// /// + /// 4 public static bool IsRunning { get @@ -122,6 +124,7 @@ namespace Tizen.Multimedia.Remoting /// An internal error occurs. /// Caller does not have required privilege. /// + /// 4 public static void Start() { Initialize(); @@ -139,6 +142,7 @@ namespace Tizen.Multimedia.Remoting /// An internal error occurs. /// /// + /// 4 public static void Stop() { EnsureInitializedIfRunning(); @@ -161,6 +165,7 @@ namespace Tizen.Multimedia.Remoting /// -or-
/// An internal error occurs. /// + /// 4 public static void SetPlaybackState(MediaControlPlaybackState state, long position) { ValidationUtil.ValidateEnum(typeof(MediaControlPlaybackState), state, nameof(state)); @@ -192,6 +197,7 @@ namespace Tizen.Multimedia.Remoting /// -or-
/// An internal error occurs. /// + /// 4 public static void SetMetadata(MediaControlMetadata metadata) { if (metadata == null) @@ -223,6 +229,7 @@ namespace Tizen.Multimedia.Remoting /// -or-
/// An internal error occurs. /// + /// 4 public static void SetShuffleModeEnabled(bool enabled) { Native.UpdateShuffleMode(Handle, enabled ? MediaControllerShuffleMode.On : MediaControllerShuffleMode.Off). @@ -239,6 +246,7 @@ namespace Tizen.Multimedia.Remoting /// An internal error occurs. /// /// is invalid. + /// 4 public static void SetRepeatMode(MediaControlRepeatMode mode) { ValidationUtil.ValidateEnum(typeof(MediaControlRepeatMode), mode, nameof(mode)); @@ -249,6 +257,7 @@ namespace Tizen.Multimedia.Remoting /// /// Occurs when a client sends playback command. /// + /// 4 public static event EventHandler PlaybackCommandReceived; private static Native.PlaybackStateCommandReceivedCallback _playbackCommandCallback; diff --git a/src/Tizen.Multimedia.Remoting/MediaController/MediaControlServerStartedEventArgs.cs b/src/Tizen.Multimedia.Remoting/MediaController/MediaControlServerStartedEventArgs.cs index 5749d51..2a3fcb5 100644 --- a/src/Tizen.Multimedia.Remoting/MediaController/MediaControlServerStartedEventArgs.cs +++ b/src/Tizen.Multimedia.Remoting/MediaController/MediaControlServerStartedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia.Remoting /// /// Provides data for the event. /// + /// 4 public class MediaControlServerStartedEventArgs : EventArgs { /// @@ -28,6 +29,7 @@ namespace Tizen.Multimedia.Remoting /// /// A of the server. /// is null. + /// 4 public MediaControlServerStartedEventArgs(MediaController mediaController) { if (mediaController == null) @@ -42,6 +44,7 @@ namespace Tizen.Multimedia.Remoting /// Gets the controller of the server added. ///
/// A . + /// 4 public MediaController Controller { get; } } } \ No newline at end of file diff --git a/src/Tizen.Multimedia.Remoting/MediaController/MediaControlServerStoppedEventArgs.cs b/src/Tizen.Multimedia.Remoting/MediaController/MediaControlServerStoppedEventArgs.cs index bb0636d..ca24154 100644 --- a/src/Tizen.Multimedia.Remoting/MediaController/MediaControlServerStoppedEventArgs.cs +++ b/src/Tizen.Multimedia.Remoting/MediaController/MediaControlServerStoppedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia.Remoting /// /// Provides data for the event. /// + /// 4 public class MediaControlServerStoppedEventArgs : EventArgs { /// @@ -28,6 +29,7 @@ namespace Tizen.Multimedia.Remoting /// /// The application id of the server stopped. /// is null. + /// 4 public MediaControlServerStoppedEventArgs(string serverAppId) { if (serverAppId == null) @@ -42,6 +44,7 @@ namespace Tizen.Multimedia.Remoting /// Gets the application id of the server. ///
/// A string represents the application id. + /// 4 public string ServerAppId { get; } } } \ No newline at end of file diff --git a/src/Tizen.Multimedia.Remoting/MediaController/MediaController.cs b/src/Tizen.Multimedia.Remoting/MediaController/MediaController.cs index 4a691e5..54b2379 100644 --- a/src/Tizen.Multimedia.Remoting/MediaController/MediaController.cs +++ b/src/Tizen.Multimedia.Remoting/MediaController/MediaController.cs @@ -23,6 +23,7 @@ namespace Tizen.Multimedia.Remoting /// /// Provides a means to to send commands to and handle events from media control server. /// + /// 4 public class MediaController { internal MediaController(MediaControllerManager manager, string serverAppId) @@ -40,12 +41,14 @@ namespace Tizen.Multimedia.Remoting /// Gets the application id of the server. ///
/// The server application id. + /// 4 public string ServerAppId { get; } /// /// Gets a value indicating whether the sever has been stopped. /// /// true if the server has been stopped; otherwise, false. + /// 4 public bool IsStopped { get; @@ -63,6 +66,7 @@ namespace Tizen.Multimedia.Remoting /// /// Occurs when the server is stopped. /// + /// 4 public event EventHandler ServerStopped; internal void RaiseStoppedEvent() @@ -74,6 +78,7 @@ namespace Tizen.Multimedia.Remoting /// /// Occurs when the playback state is updated. /// + /// 4 public event EventHandler PlaybackStateUpdated; private PlaybackStateUpdatedEventArgs CreatePlaybackUpdatedEventArgs(IntPtr playbackHandle) @@ -113,6 +118,7 @@ namespace Tizen.Multimedia.Remoting /// /// Occurs when the metadata is updated. /// + /// 4 public event EventHandler MetadataUpdated; private MetadataUpdatedEventArgs CreateMetadataUpdatedEventArgs(IntPtr metadataHandle) @@ -148,6 +154,7 @@ namespace Tizen.Multimedia.Remoting /// /// Occurs when the shuffle mode is updated. /// + /// 4 public event EventHandler ShuffleModeUpdated; internal void RaiseShuffleModeUpdatedEvent(MediaControllerShuffleMode mode) @@ -158,6 +165,7 @@ namespace Tizen.Multimedia.Remoting /// /// Occurs when the repeat mode is updated. /// + /// 4 public event EventHandler RepeatModeUpdated; internal void RaiseRepeatModeUpdatedEvent(MediaControlRepeatMode mode) @@ -176,6 +184,7 @@ namespace Tizen.Multimedia.Remoting /// /// The has already been disposed of. /// + /// 4 public MediaControlPlaybackState GetPlaybackState() { ThrowIfStopped(); @@ -210,6 +219,7 @@ namespace Tizen.Multimedia.Remoting /// /// The has already been disposed of. /// + /// 4 public long GetPlaybackPosition() { ThrowIfStopped(); @@ -244,6 +254,7 @@ namespace Tizen.Multimedia.Remoting /// /// The has already been disposed of. /// + /// 4 public MediaControlMetadata GetMetadata() { ThrowIfStopped(); @@ -277,6 +288,7 @@ namespace Tizen.Multimedia.Remoting /// /// The has already been disposed of. /// + /// 4 public bool IsShuffleModeEnabled() { ThrowIfStopped(); @@ -298,6 +310,7 @@ namespace Tizen.Multimedia.Remoting /// /// The has already been disposed of. /// + /// 4 public MediaControlRepeatMode GetRepeatMode() { ThrowIfStopped(); @@ -319,6 +332,7 @@ namespace Tizen.Multimedia.Remoting /// is not valid. /// The has already been disposed of. /// + /// 4 public void SendPlaybackCommand(MediaControlPlaybackCommand command) { ThrowIfStopped(); diff --git a/src/Tizen.Multimedia.Remoting/MediaController/MediaControllerManager.Events.cs b/src/Tizen.Multimedia.Remoting/MediaController/MediaControllerManager.Events.cs index 4cdd504..670443e 100644 --- a/src/Tizen.Multimedia.Remoting/MediaController/MediaControllerManager.Events.cs +++ b/src/Tizen.Multimedia.Remoting/MediaController/MediaControllerManager.Events.cs @@ -30,11 +30,13 @@ namespace Tizen.Multimedia.Remoting /// /// Occurs when a server is started. /// + /// 4 public event EventHandler ServerStarted; /// /// Occurs when a server is stopped. /// + /// 4 public event EventHandler ServerStopped; private void InitializeEvents() diff --git a/src/Tizen.Multimedia.Remoting/MediaController/MediaControllerManager.cs b/src/Tizen.Multimedia.Remoting/MediaController/MediaControllerManager.cs index 78a0e06..5e8a81a 100644 --- a/src/Tizen.Multimedia.Remoting/MediaController/MediaControllerManager.cs +++ b/src/Tizen.Multimedia.Remoting/MediaController/MediaControllerManager.cs @@ -26,6 +26,7 @@ namespace Tizen.Multimedia.Remoting /// /// Provides a means to retrieve active controllers and observe controllers added and removed. /// + /// 4 public partial class MediaControllerManager : IDisposable { private NativeHandle _handle; @@ -53,6 +54,7 @@ namespace Tizen.Multimedia.Remoting /// http://tizen.org/privilege/mediacontroller.client /// An internal error occurs. /// The caller does not have required privilege. + /// 4 public MediaControllerManager() { Native.Create(out _handle).ThrowIfError("Failed to create media controller client."); @@ -67,6 +69,7 @@ namespace Tizen.Multimedia.Remoting /// /// Releases all resources used by the . /// + /// 4 public void Dispose() { Dispose(true); @@ -76,6 +79,7 @@ namespace Tizen.Multimedia.Remoting /// Releases the unmanaged resources used by the . ///
/// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// 4 protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -94,6 +98,7 @@ namespace Tizen.Multimedia.Remoting /// Gets the active controllers. ///
/// An array of . + /// 4 public MediaController[] GetActiveControllers() { if (_disposed) diff --git a/src/Tizen.Multimedia.Remoting/MediaController/MediaControllerRepeatMode.cs b/src/Tizen.Multimedia.Remoting/MediaController/MediaControllerRepeatMode.cs index 1ac0dc8..d5dfb29 100644 --- a/src/Tizen.Multimedia.Remoting/MediaController/MediaControllerRepeatMode.cs +++ b/src/Tizen.Multimedia.Remoting/MediaController/MediaControllerRepeatMode.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia.Remoting /// /// Specifies the repeat mode. /// + /// 4 public enum MediaControlRepeatMode { /// diff --git a/src/Tizen.Multimedia.Remoting/MediaController/MetadataUpdatedEventArgs.cs b/src/Tizen.Multimedia.Remoting/MediaController/MetadataUpdatedEventArgs.cs index 98cbfed..59c3682 100755 --- a/src/Tizen.Multimedia.Remoting/MediaController/MetadataUpdatedEventArgs.cs +++ b/src/Tizen.Multimedia.Remoting/MediaController/MetadataUpdatedEventArgs.cs @@ -21,12 +21,14 @@ namespace Tizen.Multimedia.Remoting /// /// Provides data for the event. /// + /// 4 public class MetadataUpdatedEventArgs : EventArgs { /// /// Initializes a new instance of the class. /// /// The updated . + /// 4 public MetadataUpdatedEventArgs(MediaControlMetadata metadata) { Metadata = metadata; @@ -36,6 +38,7 @@ namespace Tizen.Multimedia.Remoting /// Gets the metadata. /// /// The updated . + /// 4 public MediaControlMetadata Metadata { get; } } } \ No newline at end of file diff --git a/src/Tizen.Multimedia.Remoting/MediaController/PlaybackCommandReceivedEventArgs.cs b/src/Tizen.Multimedia.Remoting/MediaController/PlaybackCommandReceivedEventArgs.cs index 7d7c3e1..d5c2dc6 100644 --- a/src/Tizen.Multimedia.Remoting/MediaController/PlaybackCommandReceivedEventArgs.cs +++ b/src/Tizen.Multimedia.Remoting/MediaController/PlaybackCommandReceivedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia.Remoting /// /// Provides data for the event. /// + /// 4 public class PlaybackCommandReceivedEventArgs : EventArgs { /// @@ -30,6 +31,7 @@ namespace Tizen.Multimedia.Remoting /// The playback command. /// is null. /// is invalid. + /// 4 public PlaybackCommandReceivedEventArgs(string clientAppId, MediaControlPlaybackCommand command) { if (clientAppId == null) @@ -47,12 +49,14 @@ namespace Tizen.Multimedia.Remoting /// Gets the application id of the client that sent command. /// /// The client application id. + /// 4 public string ClientAppId { get; } /// /// Gets the command. /// /// The . + /// 4 public MediaControlPlaybackCommand Command { get; } } } \ No newline at end of file diff --git a/src/Tizen.Multimedia.Remoting/MediaController/PlaybackStateUpdatedEventArgs.cs b/src/Tizen.Multimedia.Remoting/MediaController/PlaybackStateUpdatedEventArgs.cs index d4ad662..8e4ea07 100644 --- a/src/Tizen.Multimedia.Remoting/MediaController/PlaybackStateUpdatedEventArgs.cs +++ b/src/Tizen.Multimedia.Remoting/MediaController/PlaybackStateUpdatedEventArgs.cs @@ -23,6 +23,7 @@ namespace Tizen.Multimedia.Remoting /// /// Provides data for the event. /// + /// 4 public class PlaybackStateUpdatedEventArgs : EventArgs { /// @@ -32,6 +33,7 @@ namespace Tizen.Multimedia.Remoting /// The playback position in milliseconds. /// is invalid. /// is less than zero. + /// 4 public PlaybackStateUpdatedEventArgs(MediaControlPlaybackState state, long position) { ValidationUtil.ValidateEnum(typeof(MediaControlPlaybackState), state, nameof(state)); @@ -48,11 +50,13 @@ namespace Tizen.Multimedia.Remoting /// /// Gets the playback state. /// + /// 4 public MediaControlPlaybackState State { get; } /// /// Gets the playback position in milliseconds. /// + /// 4 public long Position { get; } } } \ No newline at end of file diff --git a/src/Tizen.Multimedia.Remoting/MediaController/RepeatModeUpdatedEventArgs.cs b/src/Tizen.Multimedia.Remoting/MediaController/RepeatModeUpdatedEventArgs.cs index b9bb852..765454d 100755 --- a/src/Tizen.Multimedia.Remoting/MediaController/RepeatModeUpdatedEventArgs.cs +++ b/src/Tizen.Multimedia.Remoting/MediaController/RepeatModeUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia.Remoting /// /// Provides data for the event. /// + /// 4 public class RepeatModeUpdatedEventArgs : EventArgs { /// @@ -28,6 +29,7 @@ namespace Tizen.Multimedia.Remoting /// /// A value indicating the updated repeat mode. /// is invalid. + /// 4 public RepeatModeUpdatedEventArgs(MediaControlRepeatMode mode) { ValidationUtil.ValidateEnum(typeof(MediaControlRepeatMode), mode, nameof(mode)); @@ -39,6 +41,7 @@ namespace Tizen.Multimedia.Remoting /// Gets the updated repeat mode. /// /// The . + /// 4 public MediaControlRepeatMode RepeatMode { get; } } } \ No newline at end of file diff --git a/src/Tizen.Multimedia.Remoting/MediaController/ShuffleModeUpdatedEventArgs.cs b/src/Tizen.Multimedia.Remoting/MediaController/ShuffleModeUpdatedEventArgs.cs index 7905803..f886918 100755 --- a/src/Tizen.Multimedia.Remoting/MediaController/ShuffleModeUpdatedEventArgs.cs +++ b/src/Tizen.Multimedia.Remoting/MediaController/ShuffleModeUpdatedEventArgs.cs @@ -21,12 +21,14 @@ namespace Tizen.Multimedia.Remoting /// /// Provides data for the event. /// + /// 4 public class ShuffleModeUpdatedEventArgs : EventArgs { /// /// Initializes a new instance of the class. /// /// A value indicating whether the shuffle mode is enabled. + /// 4 public ShuffleModeUpdatedEventArgs(bool enabled) { Enabled = enabled; @@ -36,6 +38,7 @@ namespace Tizen.Multimedia.Remoting /// Gets a value indicating whether the shuffle mode is enabled. ///
/// true if the shuffle mode is enabled; otherwise, false. + /// 4 public bool Enabled { get; } } } \ No newline at end of file diff --git a/src/Tizen.Multimedia.Remoting/ScreenMirroring/EventArgs.cs b/src/Tizen.Multimedia.Remoting/ScreenMirroring/EventArgs.cs index e1d8bf3..ea931b5 100644 --- a/src/Tizen.Multimedia.Remoting/ScreenMirroring/EventArgs.cs +++ b/src/Tizen.Multimedia.Remoting/ScreenMirroring/EventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia.Remoting /// /// Provides data for the event. /// + /// 4 public class ScreenMirroringStateChangedEventArgs : EventArgs { internal ScreenMirroringStateChangedEventArgs(ScreenMirroringState state) @@ -31,12 +32,14 @@ namespace Tizen.Multimedia.Remoting /// /// Gets the current state of the screen mirroring. /// + /// 4 public ScreenMirroringState State { get; } } /// /// Provides data for the event. /// + /// 4 public class ScreenMirroringErrorOccurredEventArgs : EventArgs { internal ScreenMirroringErrorOccurredEventArgs(ScreenMirroringError error) @@ -47,6 +50,7 @@ namespace Tizen.Multimedia.Remoting /// /// Gets the error that occurred. /// + /// 4 public ScreenMirroringError Error { get; } } } \ No newline at end of file diff --git a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroring.cs b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroring.cs index 19643d0..5b3c96a 100644 --- a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroring.cs +++ b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroring.cs @@ -27,6 +27,7 @@ namespace Tizen.Multimedia.Remoting /// Provides the ability to connect to and disconnect from a screen mirroring source, /// start, pause, and resume the screen mirroring as a sink. ///
+ /// 4 public class ScreenMirroring : IDisposable, IDisplayable { private const string Feature = "http://tizen.org/feature/network.wifi.direct.display"; @@ -58,6 +59,7 @@ namespace Tizen.Multimedia.Remoting ///
/// http://tizen.org/feature/network.wifi.direct.display /// The feature is not supported. + /// 4 public ScreenMirroring() { if (IsSupported() == false) @@ -86,11 +88,13 @@ namespace Tizen.Multimedia.Remoting /// /// Occurs when the state is changed. /// + /// 4 public event EventHandler StateChanged; /// /// Occurs when an error occurs. /// + /// 4 public event EventHandler ErrorOccurred; #region Display support @@ -136,11 +140,13 @@ namespace Tizen.Multimedia.Remoting /// /// Gets the negotiated audio info. /// + /// 4 public ScreenMirroringAudioInfo AudioInfo { get; } /// /// Gets the negotiated video info. /// + /// 4 public ScreenMirroringVideoInfo VideoInfo { get; } private bool IsConnected @@ -181,6 +187,7 @@ namespace Tizen.Multimedia.Remoting /// An internal error occurs. /// /// The has already been disposed. + /// 4 public void Prepare(Display display) { PrepareCore(display, (ScreenMirroringResolutions)0); @@ -206,6 +213,7 @@ namespace Tizen.Multimedia.Remoting /// An internal error occurs. /// /// The has already been disposed. + /// 4 public void Prepare(Display display, ScreenMirroringResolutions resolutions) { ValidationUtil.ValidateFlagsEnum(resolutions, (ScreenMirroringResolutions)((1 << 7) - 1), nameof(resolutions)); @@ -251,6 +259,7 @@ namespace Tizen.Multimedia.Remoting /// is a zero-length string, contains only white space. /// The has already been disposed. /// Caller does not have required permission. + /// 4 public Task ConnectAsync(string sourceIp) { if (sourceIp == null) @@ -294,6 +303,7 @@ namespace Tizen.Multimedia.Remoting /// /// The has already been disposed. /// Caller does not have required permission. + /// 4 public Task StartAsync() { ValidateState(ScreenMirroringState.Connected); @@ -325,6 +335,7 @@ namespace Tizen.Multimedia.Remoting /// /// The has already been disposed. /// Caller does not have required permission. + /// 4 public Task PauseAsync() { ValidateState(ScreenMirroringState.Playing); @@ -356,6 +367,7 @@ namespace Tizen.Multimedia.Remoting /// /// The has already been disposed. /// Caller does not have required permission. + /// 4 public Task ResumeAsync() { ValidateState(ScreenMirroringState.Paused); @@ -386,6 +398,7 @@ namespace Tizen.Multimedia.Remoting /// /// The has already been disposed. /// Caller does not have required permission. + /// 4 public void Disconnect() { ValidateState(ScreenMirroringState.Connected, ScreenMirroringState.Playing, @@ -407,6 +420,7 @@ namespace Tizen.Multimedia.Remoting /// An internal error occurs. /// /// The has already been disposed. + /// 4 public void Unprepare() { ValidateState(ScreenMirroringState.Prepared, ScreenMirroringState.Disconnected); @@ -434,6 +448,7 @@ namespace Tizen.Multimedia.Remoting /// so the garbage collector can reclaim the memory that the /// was occupying. /// + /// 4 public void Dispose() { Dispose(true); @@ -446,6 +461,7 @@ namespace Tizen.Multimedia.Remoting /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. /// + /// 4 protected virtual void Dispose(bool disposing) { if (!_disposed) diff --git a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringAudioInfo.cs b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringAudioInfo.cs index 407ccf7..ded4520 100644 --- a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringAudioInfo.cs +++ b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringAudioInfo.cs @@ -24,6 +24,7 @@ namespace Tizen.Multimedia.Remoting /// Provides a means to retrieve the audio information which is negotiated with the source device. /// /// + /// 4 public class ScreenMirroringAudioInfo { private readonly ScreenMirroring _owner; @@ -42,6 +43,7 @@ namespace Tizen.Multimedia.Remoting /// An internal error occurs. /// /// The has already been disposed. + /// 4 public ScreenMirroringAudioCodec Codec { get @@ -64,6 +66,7 @@ namespace Tizen.Multimedia.Remoting /// An internal error occurs. /// /// The has already been disposed. + /// 4 public int Channels { get @@ -86,6 +89,7 @@ namespace Tizen.Multimedia.Remoting /// An internal error occurs. /// /// The has already been disposed. + /// 4 public int SampleRate { get @@ -108,6 +112,7 @@ namespace Tizen.Multimedia.Remoting /// An internal error occurs. /// /// The has already been disposed. + /// 4 public int BitWidth { get diff --git a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringEnums.cs b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringEnums.cs index 0bed78d..e4c5aa8 100644 --- a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringEnums.cs +++ b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringEnums.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia.Remoting /// Specifies the audio codecs for . /// /// + /// 4 public enum ScreenMirroringAudioCodec { /// @@ -46,6 +47,7 @@ namespace Tizen.Multimedia.Remoting /// Specifies the video codecs for . /// /// + /// 4 public enum ScreenMirroringVideoCodec { /// @@ -61,6 +63,7 @@ namespace Tizen.Multimedia.Remoting /// /// Specifies the available combinations of resolutions and fps for . /// + /// 4 [Flags] public enum ScreenMirroringResolutions { @@ -97,6 +100,7 @@ namespace Tizen.Multimedia.Remoting /// /// Specifies the states of . /// + /// 4 public enum ScreenMirroringState { /// @@ -138,6 +142,7 @@ namespace Tizen.Multimedia.Remoting /// /// Specifies the errors for . /// + /// 4 public enum ScreenMirroringError { /// diff --git a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringVideoInfo.cs b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringVideoInfo.cs index 8acd950..3e3f779 100644 --- a/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringVideoInfo.cs +++ b/src/Tizen.Multimedia.Remoting/ScreenMirroring/ScreenMirroringVideoInfo.cs @@ -23,6 +23,7 @@ namespace Tizen.Multimedia.Remoting /// /// Provides a means to retrieve the video information which is negotiated with the source device. /// + /// 4 public class ScreenMirroringVideoInfo { private readonly ScreenMirroring _owner; @@ -41,6 +42,7 @@ namespace Tizen.Multimedia.Remoting /// An internal error occurs. /// /// The has already been disposed. + /// 4 public ScreenMirroringVideoCodec Codec { get @@ -63,6 +65,7 @@ namespace Tizen.Multimedia.Remoting /// An internal error occurs. /// /// The has already been disposed. + /// 4 public Size Resolution { get @@ -86,6 +89,7 @@ namespace Tizen.Multimedia.Remoting /// An internal error occurs. /// /// The has already been disposed. + /// 4 public int FrameRate { get diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.Capabilities.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.Capabilities.cs index 4ba2137..308caa4 100644 --- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.Capabilities.cs +++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.Capabilities.cs @@ -93,6 +93,7 @@ namespace Tizen.Multimedia /// Gets the file formats that the current device supports. /// /// An IEnumerable of representing the supported file formats. + /// 4 public IEnumerable GetSupportedFileFormats() => _fileFormats; private IEnumerable _audioCodecs; @@ -101,6 +102,7 @@ namespace Tizen.Multimedia /// Gets the audio codecs that the current device supports. /// /// An IEnumerable of representing the supported audio codecs. + /// 4 public IEnumerable GetSupportedAudioCodecs() => _audioCodecs; private IEnumerable _videoCodecs; @@ -109,6 +111,7 @@ namespace Tizen.Multimedia /// Gets the video codecs that the current device supports. /// /// An IEnumerable of representing the supported video codecs. + /// 4 public IEnumerable GetSupportedVideoCodecs() => _videoCodecs; private IEnumerable _videoResolutions; @@ -117,6 +120,7 @@ namespace Tizen.Multimedia /// Gets the video resolutions that the current device supports. /// /// An IEnumerable of representing the supported resolutions. + /// 4 public IEnumerable GetSupportedVideoResolutions() => _videoResolutions; internal void ValidateFileFormat(RecorderFileFormat format) diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.Events.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.Events.cs index 647e3ab..57d9c14 100644 --- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.Events.cs +++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.Events.cs @@ -20,32 +20,38 @@ using Native = Interop.StreamRecorder; namespace Tizen.Multimedia { + /// 3 public partial class StreamRecorder { /// /// Occurs when state is changed. /// + /// 4 public event EventHandler StateChanged; /// /// Occurs when a buffer had consumed completely. /// + /// 3 public event EventHandler BufferConsumed; /// /// Occurs when recording status is changed. /// + /// 3 public event EventHandler RecordingStatusChanged; /// /// Occurs when recording limit is reached. /// + /// 3 public event EventHandler RecordingLimitReached; /// /// Occurs when an error occurred during a recorder operation. /// + /// 4 public event EventHandler ErrorOccurred; private Native.RecordingLimitReachedCallback _recordingLimitReachedCallback; diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.cs index f922f1e..fd62136 100644 --- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.cs +++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.cs @@ -39,6 +39,7 @@ namespace Tizen.Multimedia /// Initialize a new instance of the class. /// /// The feature is not supported. + /// 3 public StreamRecorder() { try @@ -76,6 +77,7 @@ namespace Tizen.Multimedia /// Gets the current state of the stream recorder. /// /// The has already been disposed. + /// 3 public RecorderState State { get @@ -115,6 +117,7 @@ namespace Tizen.Multimedia /// /// /// + /// 4 public void Prepare(StreamRecorderOptions options) { if (options == null) @@ -150,6 +153,7 @@ namespace Tizen.Multimedia /// The recorder is not in the valid state. /// The has already been disposed. /// + /// 3 public void Unprepare() { if (State == RecorderState.Idle) @@ -178,6 +182,7 @@ namespace Tizen.Multimedia /// /// /// + /// 3 public void Start() { if (State == RecorderState.Recording) @@ -205,6 +210,7 @@ namespace Tizen.Multimedia /// /// /// + /// 3 public void Pause() { if (State == RecorderState.Paused) @@ -237,6 +243,7 @@ namespace Tizen.Multimedia /// The has already been disposed. /// /// + /// 3 public void Commit() { ValidateState(RecorderState.Paused, RecorderState.Recording); @@ -256,6 +263,7 @@ namespace Tizen.Multimedia /// The has already been disposed. /// /// + /// 3 public void Cancel() { ValidateState(RecorderState.Paused, RecorderState.Recording); @@ -293,6 +301,7 @@ namespace Tizen.Multimedia /// /// /// + /// 3 public void PushBuffer(MediaPacket packet) { if (packet == null) @@ -338,6 +347,7 @@ namespace Tizen.Multimedia /// /// Release any unmanaged resources used by this object. /// + /// 3 public void Dispose() { Dispose(true); @@ -349,6 +359,7 @@ namespace Tizen.Multimedia /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. /// + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposed) diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderAudioOptions.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderAudioOptions.cs index f7fea50..daf7286 100644 --- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderAudioOptions.cs +++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderAudioOptions.cs @@ -25,6 +25,7 @@ namespace Tizen.Multimedia /// /// /// + /// 4 public class StreamRecorderAudioOptions { private const int DefaultSampleRate = 0; @@ -39,6 +40,7 @@ namespace Tizen.Multimedia /// , and will be set as default. /// /// is not valid. + /// 4 public StreamRecorderAudioOptions(RecorderAudioCodec codec) : this(codec, DefaultSampleRate, DefaultBitRate, DefaultChannels) { @@ -60,6 +62,7 @@ namespace Tizen.Multimedia /// -or-
/// is less than or equal to zero. /// + /// 4 public StreamRecorderAudioOptions(RecorderAudioCodec codec, int sampleRate, int bitRate, int channels) { Codec = codec; @@ -76,6 +79,7 @@ namespace Tizen.Multimedia /// The codec for audio stream recording. /// is not valid. /// + /// 4 public RecorderAudioCodec Codec { get => _codec; @@ -100,6 +104,7 @@ namespace Tizen.Multimedia /// If the value is zero, the sample rate will be decided based on input buffers. /// The sample rate value for stream recorder. The default is zero. /// is less than zero. + /// 4 public int SampleRate { get => _sampleRate; @@ -122,6 +127,7 @@ namespace Tizen.Multimedia /// /// The bit rate value for audio stream recording. The default is 128000. /// is less than or equal to zero. + /// 4 public int BitRate { get => _bitRate; @@ -144,6 +150,7 @@ namespace Tizen.Multimedia /// /// The number of audio channels for audio stream recording. The default is 2. /// is less than or equal to zero. + /// 4 public int Channels { get => _channels; diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderBufferConsumedEventArgs.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderBufferConsumedEventArgs.cs index f11c51c..96795d3 100644 --- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderBufferConsumedEventArgs.cs +++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderBufferConsumedEventArgs.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 4 public class StreamRecorderBufferConsumedEventArgs : EventArgs { internal StreamRecorderBufferConsumedEventArgs(MediaPacket packet) @@ -32,6 +33,7 @@ namespace Tizen.Multimedia /// /// Gets the packet that has consumed. /// + /// 4 public MediaPacket Packet { get; } } } diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderEnums.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderEnums.cs index 041d0f0..6c246c9 100644 --- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderEnums.cs +++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderEnums.cs @@ -23,6 +23,7 @@ namespace Tizen.Multimedia /// /// Specifies errors for / /// + /// 4 public enum StreamRecorderError { /// @@ -38,6 +39,7 @@ namespace Tizen.Multimedia /// /// Specifies the video source formats for . /// + /// 4 public enum StreamRecorderVideoFormat { /// diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderErrorOccurredEventArgs.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderErrorOccurredEventArgs.cs index 228dda7..52b744b 100644 --- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderErrorOccurredEventArgs.cs +++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderErrorOccurredEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 4 public class StreamRecorderErrorOccurredEventArgs : EventArgs { internal StreamRecorderErrorOccurredEventArgs(StreamRecorderError error, RecorderState state) @@ -32,11 +33,13 @@ namespace Tizen.Multimedia /// /// Gets the error code. /// + /// 4 public StreamRecorderError Error { get; } /// /// Gets the state of the recorder. /// + /// 4 public RecorderState State { get; } } diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderOptions.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderOptions.cs index 1c5c1f2..30ec282 100644 --- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderOptions.cs +++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderOptions.cs @@ -27,6 +27,7 @@ namespace Tizen.Multimedia /// /// /// + /// 4 public class StreamRecorderOptions { /// @@ -41,6 +42,7 @@ namespace Tizen.Multimedia /// -or-
/// is not valid. /// + /// 4 public StreamRecorderOptions(string savePath, RecorderFileFormat fileFormat) { SavePath = savePath; @@ -57,6 +59,7 @@ namespace Tizen.Multimedia /// /// is null. /// is an empty string. + /// 4 public string SavePath { get => _savePath; @@ -83,6 +86,7 @@ namespace Tizen.Multimedia ///
/// is not valid. /// + /// 4 public RecorderFileFormat FileFormat { get => _fileFormat; @@ -109,6 +113,7 @@ namespace Tizen.Multimedia /// is less than zero. /// /// + /// 4 public int TimeLimit { get => _timeLimit; @@ -139,6 +144,7 @@ namespace Tizen.Multimedia /// is less than zero. /// /// + /// 4 public int SizeLimit { get => _sizeLimit; @@ -161,6 +167,7 @@ namespace Tizen.Multimedia /// or must be set for recording. /// /// + /// 4 public StreamRecorderAudioOptions Audio { get; set; } /// @@ -170,6 +177,7 @@ namespace Tizen.Multimedia /// or must be set for recording. /// /// + /// 4 public StreamRecorderVideoOptions Video { get; set; } private StreamRecorderSourceType GetSourceType() diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderStateChangedEventArgs.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderStateChangedEventArgs.cs index 2a91d1a..6c18aaa 100644 --- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderStateChangedEventArgs.cs +++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderStateChangedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 4 public class StreamRecorderStateChangedEventArgs : EventArgs { internal StreamRecorderStateChangedEventArgs(RecorderState previous, RecorderState current) @@ -32,11 +33,13 @@ namespace Tizen.Multimedia /// /// Gets the previous state of the stream recorder. /// + /// 4 public RecorderState Previous { get; } /// /// Gets the current state of the stream recorder. /// + /// 4 public RecorderState Current { get; } } } diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs index 40c13ef..dcd2b3b 100644 --- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs +++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs @@ -25,6 +25,7 @@ namespace Tizen.Multimedia /// /// /// + /// 4 public class StreamRecorderVideoOptions { private const int DefaultBitRate = 0; @@ -50,6 +51,7 @@ namespace Tizen.Multimedia /// -or-
/// is less than or equal to zero. /// + /// 4 public StreamRecorderVideoOptions(RecorderVideoCodec codec, Size resolution, StreamRecorderVideoFormat sourceFormat, int frameRate) : this(codec, resolution, sourceFormat, frameRate, DefaultBitRate) @@ -77,6 +79,7 @@ namespace Tizen.Multimedia /// -or-
/// is less than zero. /// + /// 4 public StreamRecorderVideoOptions(RecorderVideoCodec codec, Size resolution, StreamRecorderVideoFormat sourceFormat, int frameRate, int bitRate) { @@ -95,6 +98,7 @@ namespace Tizen.Multimedia /// The codec for video stream recording. /// is not valid. /// + /// 4 public RecorderVideoCodec Codec { get => _codec; @@ -116,6 +120,7 @@ namespace Tizen.Multimedia /// Width or height of is less than or equal to zero. /// /// + /// 4 public Size Resolution { get => _resolution; @@ -138,6 +143,7 @@ namespace Tizen.Multimedia ///
/// The frame rate value for video stream recording. /// is less than or equal to zero. + /// 4 public int FrameRate { get => _frameRate; @@ -159,6 +165,7 @@ namespace Tizen.Multimedia ///
/// The source format of buffers for video stream recording. /// is not valid. + /// 4 public StreamRecorderVideoFormat SourceFormat { get => _sourceFormat; @@ -177,6 +184,7 @@ namespace Tizen.Multimedia ///
/// The bit rate value for video stream recording. The default is 0. /// is less than zero. + /// 4 public int BitRate { get => _bitRate; diff --git a/src/Tizen.Multimedia.Util/ImageUtil/BitmapFrame.cs b/src/Tizen.Multimedia.Util/ImageUtil/BitmapFrame.cs index 0a48598..487f1a6 100644 --- a/src/Tizen.Multimedia.Util/ImageUtil/BitmapFrame.cs +++ b/src/Tizen.Multimedia.Util/ImageUtil/BitmapFrame.cs @@ -23,6 +23,7 @@ namespace Tizen.Multimedia.Util /// /// Represents the image data returned by a decoder class. /// + /// 4 public class BitmapFrame { internal BitmapFrame(IntPtr nativeBuffer, int width, int height, int size) @@ -40,11 +41,13 @@ namespace Tizen.Multimedia.Util /// /// Gets the raw image data. /// + /// 4 public byte[] Buffer { get; } /// /// Gets the size of the image. /// + /// 4 public Size Size { get; } } } diff --git a/src/Tizen.Multimedia.Util/ImageUtil/GifFrame.cs b/src/Tizen.Multimedia.Util/ImageUtil/GifFrame.cs index 25f8f28..c5c3731 100644 --- a/src/Tizen.Multimedia.Util/ImageUtil/GifFrame.cs +++ b/src/Tizen.Multimedia.Util/ImageUtil/GifFrame.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia.Util /// /// Represents the gif image data used to encode a gif image with . /// + /// 4 public class GifFrame { @@ -31,6 +32,7 @@ namespace Tizen.Multimedia.Util /// The delay for this image in milliseconds. /// is null. /// The length of is zero. + /// 4 public GifFrame(byte[] buffer, uint delay) { if (buffer == null) @@ -50,12 +52,14 @@ namespace Tizen.Multimedia.Util /// /// Gets the raw image data. /// + /// 4 public byte[] Buffer { get; } /// /// Gets or sets the delay for this image. /// /// Time delay in milliseconds. + /// 4 public uint Delay { get; set; } } } diff --git a/src/Tizen.Multimedia.Util/ImageUtil/ImageDecoder.cs b/src/Tizen.Multimedia.Util/ImageUtil/ImageDecoder.cs index aeb2ab0..43b69ad 100644 --- a/src/Tizen.Multimedia.Util/ImageUtil/ImageDecoder.cs +++ b/src/Tizen.Multimedia.Util/ImageUtil/ImageDecoder.cs @@ -29,6 +29,7 @@ namespace Tizen.Multimedia.Util /// /// This is a base class for image decoders. /// + /// 4 public abstract class ImageDecoder : IDisposable { private ImageDecoderHandle _handle; @@ -47,6 +48,7 @@ namespace Tizen.Multimedia.Util /// /// Gets the image format of this decoder. /// + /// 4 public ImageFormat InputFormat { get; } private ImageDecoderHandle Handle @@ -68,6 +70,7 @@ namespace Tizen.Multimedia.Util /// is invalid. /// is not supported by the decoder. /// + /// 4 public void SetColorSpace(ColorSpace colorSpace) { ValidationUtil.ValidateEnum(typeof(ColorSpace), colorSpace, nameof(ColorSpace)); @@ -101,6 +104,7 @@ namespace Tizen.Multimedia.Util /// The caller does not have required permission to access the path. /// The format of is not . /// The has already been disposed of. + /// 4 public async Task> DecodeAsync(string inputFilePath) { if (inputFilePath == null) @@ -141,6 +145,7 @@ namespace Tizen.Multimedia.Util /// is an empty array. /// The format of is not . /// The has already been disposed of. + /// 4 public Task> DecodeAsync(byte[] inputBuffer) { if (inputBuffer == null) @@ -246,6 +251,7 @@ namespace Tizen.Multimedia.Util /// Releases the unmanaged resources used by the ImageDecoder. /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// 4 protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -261,6 +267,7 @@ namespace Tizen.Multimedia.Util /// /// Releases all resources used by the ImageDecoder. /// + /// 4 public void Dispose() { Dispose(true); @@ -271,6 +278,7 @@ namespace Tizen.Multimedia.Util /// /// Provides the ability to decode Bitmap (BMP) encoded images. /// + /// 4 public class BmpDecoder : ImageDecoder { private static readonly byte[] _header = { (byte)'B', (byte)'M' }; @@ -279,6 +287,7 @@ namespace Tizen.Multimedia.Util /// Initializes a new instance of the class. /// /// will be the . + /// 4 public BmpDecoder() : base(ImageFormat.Bmp) { } @@ -289,6 +298,7 @@ namespace Tizen.Multimedia.Util /// /// Provides the ability to decode the Portable Network Graphics (PNG) encoded images. /// + /// 4 public class PngDecoder : ImageDecoder { private static readonly byte[] _header = { 0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a }; @@ -297,6 +307,7 @@ namespace Tizen.Multimedia.Util /// Initializes a new instance of the class. /// /// will be the . + /// 4 public PngDecoder() : base(ImageFormat.Png) { } @@ -307,6 +318,7 @@ namespace Tizen.Multimedia.Util /// /// Provides the ability to decode the Joint Photographic Experts Group (JPEG) encoded images. /// + /// 4 public class JpegDecoder : ImageDecoder { private static readonly byte[] _header = { 0xFF, 0xD8 }; @@ -314,6 +326,7 @@ namespace Tizen.Multimedia.Util /// /// A read-only field that represents the default value of . /// + /// 4 public static readonly JpegDownscale DefaultJpegDownscale = JpegDownscale.None; private JpegDownscale _jpegDownscale = DefaultJpegDownscale; @@ -322,6 +335,7 @@ namespace Tizen.Multimedia.Util /// Initializes a new instance of the class. /// /// will be the . + /// 4 public JpegDecoder() : base(ImageFormat.Jpeg) { } @@ -330,6 +344,7 @@ namespace Tizen.Multimedia.Util /// Gets or sets the downscale at which the jpeg image should be decoded. /// /// is invalid. + /// 4 public JpegDownscale Downscale { get @@ -357,6 +372,7 @@ namespace Tizen.Multimedia.Util /// /// Provides the ability to decode the Graphics Interchange Format (GIF) encoded images. /// + /// 4 public class GifDecoder : ImageDecoder { private static readonly byte[] _header = { (byte)'G', (byte)'I', (byte)'F' }; @@ -365,6 +381,7 @@ namespace Tizen.Multimedia.Util /// Initializes a new instance of the class. /// /// will be the . + /// 4 public GifDecoder() : base(ImageFormat.Gif) { } diff --git a/src/Tizen.Multimedia.Util/ImageUtil/ImageEncoder.cs b/src/Tizen.Multimedia.Util/ImageUtil/ImageEncoder.cs index 55364c9..1270739 100644 --- a/src/Tizen.Multimedia.Util/ImageUtil/ImageEncoder.cs +++ b/src/Tizen.Multimedia.Util/ImageUtil/ImageEncoder.cs @@ -29,6 +29,7 @@ namespace Tizen.Multimedia.Util /// /// This is a base class for image encoders. /// + /// 4 public abstract class ImageEncoder : IDisposable { private ImageEncoderHandle _handle; @@ -60,6 +61,7 @@ namespace Tizen.Multimedia.Util /// /// Gets the image format of this encoder. /// + /// 4 public ImageFormat OutputFormat { get; } /// @@ -71,6 +73,7 @@ namespace Tizen.Multimedia.Util /// -or-
/// The height of is less than or equal to zero. /// + /// 4 public void SetResolution(Size resolution) { if (resolution.Width <= 0) @@ -97,6 +100,7 @@ namespace Tizen.Multimedia.Util /// is invalid. /// is not supported by the encoder. /// + /// 4 public void SetColorSpace(ColorSpace colorSpace) { ValidationUtil.ValidateEnum(typeof(ColorSpace), colorSpace, nameof(colorSpace)); @@ -184,6 +188,7 @@ namespace Tizen.Multimedia.Util /// The resolution is not set. /// The has already been disposed of. /// + /// 4 public Task EncodeAsync(byte[] inputBuffer, Stream outStream) { if (inputBuffer == null) @@ -222,6 +227,7 @@ namespace Tizen.Multimedia.Util /// Releases the unmanaged resources used by the ImageEncoder. ///
/// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// 4 protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -237,6 +243,7 @@ namespace Tizen.Multimedia.Util /// /// Releases all resources used by the ImageEncoder. /// + /// 4 public void Dispose() { Dispose(true); @@ -247,12 +254,14 @@ namespace Tizen.Multimedia.Util /// /// Provides the ability to encode the Bitmap (BMP) format images. /// + /// 4 public class BmpEncoder : ImageEncoder { /// /// Initializes a new instance of the class. /// /// will be the . + /// 4 public BmpEncoder() : base(ImageFormat.Bmp) { } @@ -265,11 +274,13 @@ namespace Tizen.Multimedia.Util /// /// Provides the ability to encode the Portable Network Graphics (PNG) format images. /// + /// 4 public class PngEncoder : ImageEncoder { /// /// A read-only field that represents the default value of . /// + /// 4 public static readonly PngCompression DefaultCompression = PngCompression.Level6; private PngCompression? _compression; @@ -278,6 +289,7 @@ namespace Tizen.Multimedia.Util /// Initializes a new instance of the class. /// /// will be the . + /// 4 public PngEncoder() : base(ImageFormat.Png) { @@ -289,6 +301,7 @@ namespace Tizen.Multimedia.Util /// will be the . /// The compression level of the encoder. /// is invalid. + /// 4 public PngEncoder(PngCompression compression) : base(ImageFormat.Png) { @@ -300,6 +313,7 @@ namespace Tizen.Multimedia.Util /// /// The compression level. The default is . /// is invalid. + /// 4 public PngCompression Compression { get { return _compression ?? DefaultCompression; } @@ -324,11 +338,13 @@ namespace Tizen.Multimedia.Util /// /// Provides the ability to encode the Joint Photographic Experts Group (JPEG) format images. /// + /// 4 public class JpegEncoder : ImageEncoder { /// /// A read-only field that represents the default value of . /// + /// 4 public static readonly int DefaultQuality = 75; private int? _quality; @@ -337,6 +353,7 @@ namespace Tizen.Multimedia.Util /// Initializes a new instance of the class. /// /// will be the . + /// 4 public JpegEncoder() : base(ImageFormat.Jpeg) { } @@ -352,6 +369,7 @@ namespace Tizen.Multimedia.Util /// -or-
/// is greater than 100. /// + /// 4 public JpegEncoder(int quality) : base(ImageFormat.Jpeg) { @@ -370,6 +388,7 @@ namespace Tizen.Multimedia.Util /// -or-
/// is greater than 100. /// + /// 4 public int Quality { get { return _quality ?? DefaultQuality; } @@ -397,12 +416,14 @@ namespace Tizen.Multimedia.Util /// /// Provides the ability to encode the Graphics Interchange Format (GIF) format images. /// + /// 4 public class GifEncoder : ImageEncoder { /// /// Initializes a new instance of the class. /// /// will be the . + /// 4 public GifEncoder() : base(ImageFormat.Gif) { } @@ -430,6 +451,7 @@ namespace Tizen.Multimedia.Util /// The resolution is not set. /// The has already been disposed of. /// + /// 4 public Task EncodeAsync(IEnumerable frames, Stream outStream) { if (frames == null) diff --git a/src/Tizen.Multimedia.Util/ImageUtil/ImageFormat.cs b/src/Tizen.Multimedia.Util/ImageUtil/ImageFormat.cs index b600b82..2fc1d55 100644 --- a/src/Tizen.Multimedia.Util/ImageUtil/ImageFormat.cs +++ b/src/Tizen.Multimedia.Util/ImageUtil/ImageFormat.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia.Util /// /// Specifies image formats for , and . /// + /// 4 public enum ImageFormat { /// diff --git a/src/Tizen.Multimedia.Util/ImageUtil/ImageTransform.cs b/src/Tizen.Multimedia.Util/ImageUtil/ImageTransform.cs index 889dfc9..65cac7b 100644 --- a/src/Tizen.Multimedia.Util/ImageUtil/ImageTransform.cs +++ b/src/Tizen.Multimedia.Util/ImageUtil/ImageTransform.cs @@ -28,6 +28,7 @@ namespace Tizen.Multimedia.Util /// /// A base class for image transformations. /// + /// 4 public abstract class ImageTransform { internal ImageTransform() @@ -88,6 +89,7 @@ namespace Tizen.Multimedia.Util /// /// Represents a collection of objects that can be individually accessed by index. /// + /// 4 public class ImageTransformCollection : IEnumerable, IList { private List _list = new List(); @@ -95,6 +97,7 @@ namespace Tizen.Multimedia.Util /// /// Initializes a new instance of the ImageTransformCollection class. /// + /// 4 public ImageTransformCollection() { } @@ -109,6 +112,7 @@ namespace Tizen.Multimedia.Util /// -or-
/// index is equal to or greater than . /// + /// 4 public ImageTransform this[int index] { get { return _list[index]; } @@ -118,6 +122,7 @@ namespace Tizen.Multimedia.Util /// /// Gets the number of items contained in the TransformCollection. /// + /// 4 public int Count => _list.Count; bool ICollection.IsReadOnly => false; @@ -129,6 +134,7 @@ namespace Tizen.Multimedia.Util /// /// accepts null as a valid value for reference types and allows duplicate elements. /// + /// 4 public void Add(ImageTransform item) { if (item == null) @@ -141,6 +147,7 @@ namespace Tizen.Multimedia.Util /// /// Removes all items. /// + /// 4 public void Clear() => _list.Clear(); /// @@ -148,6 +155,7 @@ namespace Tizen.Multimedia.Util /// /// The to locate in the collection. /// true if the is found in the collection; otherwise, false. + /// 4 public bool Contains(ImageTransform item) => _list.Contains(item); /// @@ -160,6 +168,7 @@ namespace Tizen.Multimedia.Util /// /// The number of elements in the source collection is greater than the available space from arrayIndex to the end of the destination array. /// + /// 4 public void CopyTo(ImageTransform[] array, int arrayIndex) => _list.CopyTo(array, arrayIndex); /// @@ -167,6 +176,7 @@ namespace Tizen.Multimedia.Util /// /// The to locate in the collection. /// The index of value if found in the ; otherwise, -1. + /// 4 public int IndexOf(ImageTransform item) => _list.IndexOf(item); /// @@ -180,6 +190,7 @@ namespace Tizen.Multimedia.Util /// -or-
/// index is greater than . /// + /// 4 public void Insert(int index, ImageTransform item) { if (item == null) @@ -194,6 +205,7 @@ namespace Tizen.Multimedia.Util ///
/// The to remove. /// true if was removed from the collection; otherwise, false. + /// 4 public bool Remove(ImageTransform item) => _list.Remove(item); /// @@ -205,12 +217,14 @@ namespace Tizen.Multimedia.Util /// -or-
/// index is equal to or greater than . /// + /// 4 public void RemoveAt(int index) => _list.RemoveAt(index); /// /// Returns an enumerator that can iterate through the collection. /// /// An enumerator that can be used to iterate through the collection. + /// 4 public IEnumerator GetEnumerator() => _list.GetEnumerator(); IEnumerator IEnumerable.GetEnumerator() => _list.GetEnumerator(); @@ -220,16 +234,19 @@ namespace Tizen.Multimedia.Util /// /// Represents a that is a composite of the transforms. /// + /// 4 public class ImageTransformGroup : ImageTransform { /// /// Gets or sets the . /// + /// 4 public ImageTransformCollection Children { get; set; } /// /// Initializes a new instance of the ImageTransformGroup class. /// + /// 4 public ImageTransformGroup() { Children = new ImageTransformCollection(); @@ -272,6 +289,7 @@ namespace Tizen.Multimedia.Util /// Rotates an image. ///
/// + /// 4 public class RotateTransform : ImageTransform { private Rotation _rotation; @@ -282,6 +300,7 @@ namespace Tizen.Multimedia.Util /// The value how to rotate an image. /// is invalid. /// is . + /// 4 public RotateTransform(Rotation rotation) { Rotation = rotation; @@ -293,6 +312,7 @@ namespace Tizen.Multimedia.Util ///
/// is invalid. /// is . + /// 4 public Rotation Rotation { get { return _rotation; } @@ -333,6 +353,7 @@ namespace Tizen.Multimedia.Util /// Flips an image. ///
/// + /// 4 public class FlipTransform : ImageTransform { private Flips _flip; @@ -343,6 +364,7 @@ namespace Tizen.Multimedia.Util /// The value how to flip an image. /// is invalid. /// is . + /// 4 public FlipTransform(Flips flip) { Flip = flip; @@ -353,6 +375,7 @@ namespace Tizen.Multimedia.Util /// /// is invalid. /// is . + /// 4 public Flips Flip { get { return _flip; } @@ -408,6 +431,7 @@ namespace Tizen.Multimedia.Util /// Changes the colorspace of an image. /// /// + /// 4 public class ColorSpaceTransform : ImageTransform { private ImageColorSpace _imageColorSpace; @@ -419,6 +443,7 @@ namespace Tizen.Multimedia.Util /// is invalid. /// is not supported. /// + /// 4 public ColorSpaceTransform(ColorSpace colorSpace) { ColorSpace = colorSpace; @@ -430,6 +455,7 @@ namespace Tizen.Multimedia.Util /// is invalid. /// is not supported. /// + /// 4 public ColorSpace ColorSpace { get { return _imageColorSpace.ToCommonColorSpace(); } @@ -449,6 +475,7 @@ namespace Tizen.Multimedia.Util /// /// Gets the supported colorspaces for . /// + /// 4 public static IEnumerable SupportedColorSpaces { get @@ -464,6 +491,7 @@ namespace Tizen.Multimedia.Util /// /// Crops an image. /// + /// 4 public class CropTransform : ImageTransform { private Rectangle _region; @@ -481,6 +509,7 @@ namespace Tizen.Multimedia.Util /// -or-
/// The height of is less than or equal to zero. /// + /// 4 public CropTransform(Rectangle region) { Region = region; @@ -498,6 +527,7 @@ namespace Tizen.Multimedia.Util /// -or-
/// The height of is less than or equal to zero. /// + /// 4 public Rectangle Region { get { return _region; } @@ -541,6 +571,7 @@ namespace Tizen.Multimedia.Util /// /// Resizes an image. /// + /// 4 public class ResizeTransform : ImageTransform { private Size _size; @@ -554,6 +585,7 @@ namespace Tizen.Multimedia.Util /// -or-
/// The height of is less than or equal to zero. /// + /// 4 public ResizeTransform(Size size) { Size = size; @@ -567,6 +599,7 @@ namespace Tizen.Multimedia.Util /// -or-
/// The height of is less than or equal to zero. /// + /// 4 public Size Size { get { return _size; } diff --git a/src/Tizen.Multimedia.Util/ImageUtil/ImageTransformer.cs b/src/Tizen.Multimedia.Util/ImageUtil/ImageTransformer.cs index 13d345d..aa22ae7 100644 --- a/src/Tizen.Multimedia.Util/ImageUtil/ImageTransformer.cs +++ b/src/Tizen.Multimedia.Util/ImageUtil/ImageTransformer.cs @@ -22,11 +22,13 @@ namespace Tizen.Multimedia.Util /// /// Provides the ability to transform an image. /// + /// 4 public class ImageTransformer : IDisposable { /// /// Initializes a new instance of the class. /// + /// 4 public ImageTransformer() { } @@ -44,6 +46,7 @@ namespace Tizen.Multimedia.Util /// /// The has already been disposed of. /// Failed to apply . + /// 4 public Task TransformAsync(MediaPacket source, ImageTransform item) { if (_disposed) @@ -71,6 +74,7 @@ namespace Tizen.Multimedia.Util /// Releases the unmanaged resources used by the ImageTransformer. /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// 4 protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -82,6 +86,7 @@ namespace Tizen.Multimedia.Util /// /// Releases all resources used by the ImageTransformer. /// + /// 4 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Multimedia.Util/ImageUtil/ImageUtil.cs b/src/Tizen.Multimedia.Util/ImageUtil/ImageUtil.cs index 9d35b91..1c30321 100644 --- a/src/Tizen.Multimedia.Util/ImageUtil/ImageUtil.cs +++ b/src/Tizen.Multimedia.Util/ImageUtil/ImageUtil.cs @@ -24,6 +24,7 @@ namespace Tizen.Multimedia.Util /// /// Provides utilities for images. /// + /// 4 public static class ImageUtil { /// @@ -32,6 +33,7 @@ namespace Tizen.Multimedia.Util /// An IEnumerable of representing the supported color-spaces. /// The . /// is invalid. + /// 4 public static IEnumerable GetSupportedColorSpaces(ImageFormat format) { ValidationUtil.ValidateEnum(typeof(ImageFormat), format, nameof(format)); @@ -57,6 +59,7 @@ namespace Tizen.Multimedia.Util /// height of is less than or equal to zero. /// /// is invalid. + /// 4 public static int CalculateBufferSize(Size resolution, ColorSpace colorSpace) { if (resolution.Width <= 0) @@ -95,6 +98,7 @@ namespace Tizen.Multimedia.Util /// -or-
/// height of is less than or equal to zero. /// + /// 4 public static Color GetColor(byte[] buffer, Size size) { if (buffer == null) diff --git a/src/Tizen.Multimedia.Util/ImageUtil/JpegDownscale.cs b/src/Tizen.Multimedia.Util/ImageUtil/JpegDownscale.cs index de4a94a..dd24eb9 100644 --- a/src/Tizen.Multimedia.Util/ImageUtil/JpegDownscale.cs +++ b/src/Tizen.Multimedia.Util/ImageUtil/JpegDownscale.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia.Util /// /// Specifies the JPEG Downscale options for decoding. /// + /// 4 public enum JpegDownscale { /// diff --git a/src/Tizen.Multimedia.Util/ImageUtil/PngCompression.cs b/src/Tizen.Multimedia.Util/ImageUtil/PngCompression.cs index 8398cfa..d162ea9 100644 --- a/src/Tizen.Multimedia.Util/ImageUtil/PngCompression.cs +++ b/src/Tizen.Multimedia.Util/ImageUtil/PngCompression.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia.Util /// /// Specifies the PNG compression levels. /// + /// 4 public enum PngCompression { /// diff --git a/src/Tizen.Multimedia.Util/ThumbnailExtractor/ThumbnailExtractionResult.cs b/src/Tizen.Multimedia.Util/ThumbnailExtractor/ThumbnailExtractionResult.cs index de0a1c4..0e6b4b2 100755 --- a/src/Tizen.Multimedia.Util/ThumbnailExtractor/ThumbnailExtractionResult.cs +++ b/src/Tizen.Multimedia.Util/ThumbnailExtractor/ThumbnailExtractionResult.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia.Util /// /// Represents the result of the thumbnail extraction. /// + /// 4 public class ThumbnailExtractionResult { internal ThumbnailExtractionResult(byte[] thumbnailData, int width, int height) @@ -30,13 +31,13 @@ namespace Tizen.Multimedia.Util /// /// The thumbnail data. /// - /// 3 + /// 4 public byte[] RawData { get; } /// /// The size of the thumbnail. /// - /// 3 + /// 4 public Size Size { get; } } } diff --git a/src/Tizen.Multimedia.Util/ThumbnailExtractor/ThumbnailExtractor.cs b/src/Tizen.Multimedia.Util/ThumbnailExtractor/ThumbnailExtractor.cs index 2005cb5..8833510 100755 --- a/src/Tizen.Multimedia.Util/ThumbnailExtractor/ThumbnailExtractor.cs +++ b/src/Tizen.Multimedia.Util/ThumbnailExtractor/ThumbnailExtractor.cs @@ -27,6 +27,7 @@ namespace Tizen.Multimedia.Util /// /// Provides the ability to extract the thumbnail from media files. /// + /// 4 public static class ThumbnailExtractor { private static Handle CreateHandle() @@ -39,7 +40,7 @@ namespace Tizen.Multimedia.Util /// /// Extracts the thumbnail for the given media with the specified path. /// - /// 3 + /// 4 /// A task that represents the asynchronous extracting operation. /// The size of the thumbnail will be the default size (320x240). /// The path of the media file to extract the thumbnail. @@ -65,6 +66,7 @@ namespace Tizen.Multimedia.Util /// An internal error occurs. /// The caller does not have required privilege for accessing the . /// The specified file is not supported. + /// 4 public static Task ExtractAsync(string path, CancellationToken cancellationToken) { return RunExtractAsync(path, null, cancellationToken); @@ -73,7 +75,7 @@ namespace Tizen.Multimedia.Util /// /// Extracts the thumbnail for the given media with the specified path and size. /// - /// 3 + /// 4 /// A task that represents the asynchronous extracting operation. /// /// If the width is not a multiple of 8, it can be changed by the inner process.
@@ -97,7 +99,7 @@ namespace Tizen.Multimedia.Util /// /// Extracts the thumbnail for the given media with the specified path and size. /// - /// 3 + /// 4 /// A task that represents the asynchronous extracting operation. /// /// If the width is not a multiple of 8, it can be changed by the inner process.
diff --git a/src/Tizen.Multimedia.Vision/MediaVision/Barcode.cs b/src/Tizen.Multimedia.Vision/MediaVision/Barcode.cs index a8d9ce8..de0667c 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/Barcode.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/Barcode.cs @@ -19,13 +19,13 @@ namespace Tizen.Multimedia.Vision /// /// Represents a detected barcode. /// - /// 3 + /// 4 public class Barcode { /// /// Initializes a new instance of the class. /// - /// 3 + /// 4 public Barcode(Quadrangle region, string message, BarcodeType type) { Region = region; @@ -36,25 +36,26 @@ namespace Tizen.Multimedia.Vision /// /// The quadrangle location of the detected barcode. /// - /// 3 + /// 4 public Quadrangle Region { get; } /// /// The decoded message of the barcode. /// - /// 3 + /// 4 public string Message { get; } /// /// The type of the detected barcode. /// - /// 3 + /// 4 public BarcodeType Type { get; } /// /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 4 public override string ToString() => $"Region={Region}, Message={Message}, Type={Type.ToString()}"; } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionConfiguration.cs index 633c983..3868c21 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionConfiguration.cs @@ -22,7 +22,7 @@ namespace Tizen.Multimedia.Vision /// Represents a configuration of . ///
/// - /// 3 + /// 4 public class BarcodeDetectionConfiguration : EngineConfiguration { private const string KeyAttrTarget = "MV_BARCODE_DETECT_ATTR_TARGET"; @@ -31,7 +31,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. ///
/// The feature is not supported. - /// 3 + /// 4 public BarcodeDetectionConfiguration() : base("barcode_detection") { } @@ -41,7 +41,7 @@ namespace Tizen.Multimedia.Vision ///
/// is not valid. /// The already has been disposed of. - /// 3 + /// 4 public BarcodeDetectionTarget Target { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionTarget.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionTarget.cs index 0da7396..de3fad0 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionTarget.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionTarget.cs @@ -19,7 +19,7 @@ namespace Tizen.Multimedia.Vision /// /// Specifies the target of . /// - /// 3 + /// 4 public enum BarcodeDetectionTarget { /// diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetector.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetector.cs index bdb7a1f..55b7c04 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetector.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetector.cs @@ -25,7 +25,7 @@ namespace Tizen.Multimedia.Vision /// /// Provides the ability to detect barcodes on image sources. /// - /// 3 + /// 4 public static class BarcodeDetector { /// @@ -39,7 +39,7 @@ namespace Tizen.Multimedia.Vision /// already has been disposed of. /// A task that represents the asynchronous detect operation. /// - /// 3 + /// 4 public static async Task> DetectAsync(MediaVisionSource source, Rectangle roi) { @@ -62,7 +62,7 @@ namespace Tizen.Multimedia.Vision /// already has been disposed of. /// /// - /// 3 + /// 4 public static async Task> DetectAsync(MediaVisionSource source, Rectangle roi, BarcodeDetectionConfiguration config) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerationConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerationConfiguration.cs index edfbc50..dea0603 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerationConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerationConfiguration.cs @@ -23,7 +23,7 @@ namespace Tizen.Multimedia.Vision /// Represents a configuration of instances. /// /// - /// 3 + /// 4 public class BarcodeGenerationConfiguration : EngineConfiguration { private const string KeyTextAttr = "MV_BARCODE_GENERATE_ATTR_TEXT"; @@ -34,7 +34,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 4 public BarcodeGenerationConfiguration() : base("barcode_generation") { } @@ -44,7 +44,7 @@ namespace Tizen.Multimedia.Vision /// /// is not valid. /// The already has been disposed of. - /// 3 + /// 4 public Visibility TextVisibility { get @@ -67,7 +67,7 @@ namespace Tizen.Multimedia.Vision /// The alpha value of the color will be ignored. /// /// The already has been disposed of. - /// 3 + /// 4 public Color ForegroundColor { get @@ -90,7 +90,7 @@ namespace Tizen.Multimedia.Vision /// The alpha value of the color will be ignored. /// /// The already has been disposed of. - /// 3 + /// 4 public Color BackgroundColor { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs index 8979b25..6533de5 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs @@ -25,7 +25,7 @@ namespace Tizen.Multimedia.Vision /// and code versions are supported for QRCodes. /// /// - /// 3 + /// 4 public static class BarcodeGenerator { private const int NoneErrorCorrection = (int)ErrorCorrectionLevel.High + 1; @@ -74,7 +74,7 @@ namespace Tizen.Multimedia.Vision /// /// The feature is not supported. /// - /// 3 + /// 4 public static MediaVisionSource GenerateSource(string message, QrConfiguration qrConfig) { return GenerateSource(message, qrConfig, null); @@ -108,7 +108,7 @@ namespace Tizen.Multimedia.Vision /// /// already has been disposed of. /// - /// 3 + /// 4 public static MediaVisionSource GenerateSource(string message, QrConfiguration qrConfig, BarcodeGenerationConfiguration config) { @@ -146,7 +146,7 @@ namespace Tizen.Multimedia.Vision /// contains illegal characters. /// /// The feature is not supported. - /// 3 + /// 4 public static MediaVisionSource GenerateSource(string message, BarcodeType type) { return GenerateSource(message, type, null); @@ -171,7 +171,7 @@ namespace Tizen.Multimedia.Vision /// /// The feature is not supported. /// already has been disposed of. - /// 3 + /// 4 public static MediaVisionSource GenerateSource(string message, BarcodeType type, BarcodeGenerationConfiguration config) { @@ -230,7 +230,7 @@ namespace Tizen.Multimedia.Vision /// No permission to write a file. /// The feature is not supported. /// - /// 3 + /// 4 public static void GenerateImage(string message, QrConfiguration qrConfig, BarcodeImageConfiguration imageConfig) { @@ -268,7 +268,7 @@ namespace Tizen.Multimedia.Vision /// is the . /// /// already has been disposed of. - /// 3 + /// 4 public static void GenerateImage(string message, QrConfiguration qrConfig, BarcodeImageConfiguration imageConfig, BarcodeGenerationConfiguration config) { @@ -312,7 +312,7 @@ namespace Tizen.Multimedia.Vision /// /// No permission to write a file. /// The feature is not supported. - /// 3 + /// 4 public static void GenerateImage(string message, BarcodeType type, BarcodeImageConfiguration imageConfig) { GenerateImage(message, type, imageConfig, null); @@ -343,7 +343,7 @@ namespace Tizen.Multimedia.Vision /// No permission to write a file. /// The feature is not supported. /// already has been disposed of. - /// 3 + /// 4 public static void GenerateImage(string message, BarcodeType type, BarcodeImageConfiguration imageConfig, BarcodeGenerationConfiguration config) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageConfiguration.cs index 0785f83..e82f109 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageConfiguration.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents a configuration for the image to be generated by . /// - /// 3 + /// 4 public class BarcodeImageConfiguration { /// @@ -46,7 +46,7 @@ namespace Tizen.Multimedia.Vision /// var imageConfig = new BarcodeImageConfiguration(new Size(500, 400), "/opt/usr/test-barcode-generate-new", BarcodeImageFormat.JPG); /// /// - /// 3 + /// 4 public BarcodeImageConfiguration(Size size, string path, BarcodeImageFormat imageFormat) { if (size.Width <= 0) @@ -96,7 +96,7 @@ namespace Tizen.Multimedia.Vision /// var imageConfig = new BarcodeImageConfiguration(500, 400, "/opt/usr/test-barcode-generate-new", BarcodeImageFormat.JPG); /// /// - /// 3 + /// 4 public BarcodeImageConfiguration(int width, int height, string path, BarcodeImageFormat imageFormat) : this(new Size(width, height), path, imageFormat) { @@ -105,19 +105,19 @@ namespace Tizen.Multimedia.Vision /// /// Gets the size of the image. /// - /// 3 + /// 4 public Size Size { get; } /// /// Gets the width of the image. /// - /// 3 + /// 4 public int Width => Size.Width; /// /// Gets the height of the image. /// - /// 3 + /// 4 public int Height => Size.Height; /// @@ -127,13 +127,13 @@ namespace Tizen.Multimedia.Vision /// The mediastorage privilege (http://tizen.org/privilege/mediastorage) is needed if the image path is relevant to media storage.
/// The externalstorage privilege (http://tizen.org/privilege/externalstorage) is needed if the image path is relevant to external storage. /// - /// 3 + /// 4 public string Path { get; } /// /// Gets the format of the output image. /// - /// 3 + /// 4 public BarcodeImageFormat Format { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageFormat.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageFormat.cs index de3ff8b..39b57a1 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageFormat.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageFormat.cs @@ -20,7 +20,7 @@ namespace Tizen.Multimedia.Vision /// Specifies the supported image formats for ///
/// - /// 3 + /// 4 public enum BarcodeImageFormat { /// diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeType.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeType.cs index bcf3930..a1daec1 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeType.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeType.cs @@ -24,7 +24,7 @@ namespace Tizen.Multimedia.Vision /// /// /// - /// 3 + /// 4 public enum BarcodeType { /// diff --git a/src/Tizen.Multimedia.Vision/MediaVision/EngineConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/EngineConfiguration.cs index cb8c57f..964f00f 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/EngineConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/EngineConfiguration.cs @@ -24,7 +24,7 @@ namespace Tizen.Multimedia.Vision /// /// A base class for configuration classes. /// - /// 3 + /// 4 public abstract class EngineConfiguration : IDisposable { private IntPtr _handle = IntPtr.Zero; @@ -150,6 +150,7 @@ namespace Tizen.Multimedia.Vision /// /// Releases all resources used by the object. /// + /// 4 public void Dispose() { Dispose(true); @@ -162,6 +163,7 @@ namespace Tizen.Multimedia.Vision /// /// true to release both managed and unmanaged resources, otherwise false to release only unmanaged resources. /// + /// 4 protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ErrorCorrectionLevel.cs b/src/Tizen.Multimedia.Vision/MediaVision/ErrorCorrectionLevel.cs index 5c285be..06b6ff6 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/ErrorCorrectionLevel.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ErrorCorrectionLevel.cs @@ -19,7 +19,7 @@ namespace Tizen.Multimedia.Vision /// /// Specifies the supported QR code error correction levels. /// - /// 3 + /// 4 public enum ErrorCorrectionLevel { /// diff --git a/src/Tizen.Multimedia.Vision/MediaVision/EyeCondition.cs b/src/Tizen.Multimedia.Vision/MediaVision/EyeCondition.cs index 03b7d3b..556dc00 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/EyeCondition.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/EyeCondition.cs @@ -19,7 +19,7 @@ namespace Tizen.Multimedia.Vision /// /// Specifies the eyes state types. /// - /// 3 + /// 4 public enum EyeCondition { /// diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceDetectionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceDetectionConfiguration.cs index e8634a4..6a841ab 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceDetectionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceDetectionConfiguration.cs @@ -22,7 +22,7 @@ namespace Tizen.Multimedia.Vision /// Represents a configuration of instances. /// /// http://tizen.org/feature/vision.face_recognition - /// 3 + /// 4 public class FaceDetectionConfiguration : EngineConfiguration { private const string KeyModelFilePath = "MV_FACE_DETECTION_MODEL_FILE_PATH"; @@ -37,7 +37,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 4 public FaceDetectionConfiguration() : base("face_recognition") { } @@ -46,7 +46,7 @@ namespace Tizen.Multimedia.Vision /// Gets or sets the face detection haarcascade xml file for face detection. /// /// is null. - /// 3 + /// 4 public string ModelFilePath { get @@ -71,7 +71,7 @@ namespace Tizen.Multimedia.Vision /// Default value is null (all detected faces will be applied), which can be changed to specify the minimum face height. /// /// is less than zero. - /// 3 + /// 4 public int? MinHeight { get @@ -99,7 +99,7 @@ namespace Tizen.Multimedia.Vision /// Default value is null (all detected faces will be applied), which can be changed to specify the minimum face width. /// /// is less than zero. - /// 3 + /// 4 public int? MinWidth { get @@ -139,7 +139,7 @@ namespace Tizen.Multimedia.Vision /// -or-
/// The y position of is less than zero. /// - /// 3 + /// 4 public Rectangle? Roi { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceDetector.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceDetector.cs index 1e0991c..71c4d8c 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceDetector.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceDetector.cs @@ -23,7 +23,7 @@ namespace Tizen.Multimedia.Vision /// /// Provides the ability to detect faces on image sources. /// - /// 3 + /// 4 public static class FaceDetector { @@ -40,7 +40,7 @@ namespace Tizen.Multimedia.Vision /// The format of is not supported. /// /// http://tizen.org/feature/vision.face_recognition - /// 3 + /// 4 public static async Task DetectAsync(MediaVisionSource source) { return await DetectAsync(source, null); @@ -56,7 +56,7 @@ namespace Tizen.Multimedia.Vision /// is null. /// The feature is not supported. /// http://tizen.org/feature/vision.face_recognition - /// 3 + /// 4 public static async Task DetectAsync(MediaVisionSource source, FaceDetectionConfiguration config) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionConfiguration.cs index 69cd91d..c599357 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionConfiguration.cs @@ -22,7 +22,7 @@ namespace Tizen.Multimedia.Vision /// Represents a configuration of instances. ///
/// http://tizen.org/feature/vision.face_recognition - /// 3 + /// 4 public class FaceRecognitionConfiguration : EngineConfiguration { private const string KeyModelType = "MV_FACE_RECOGNITION_MODEL_TYPE"; @@ -31,7 +31,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. ///
/// The feature is not supported. - /// 3 + /// 4 public FaceRecognitionConfiguration() : base("face_recognition") { } @@ -41,7 +41,7 @@ namespace Tizen.Multimedia.Vision /// Default value is . /// /// is not valid. - /// 3 + /// 4 public FaceRecognitionModelType ModelType { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModel.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModel.cs index 20a97d7..8d0f730 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModel.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModel.cs @@ -25,7 +25,7 @@ namespace Tizen.Multimedia.Vision /// Represents the face recognition model interface. /// /// http://tizen.org/feature/vision.face_recognition - /// 3 + /// 4 public class FaceRecognitionModel : IDisposable { private IntPtr _handle = IntPtr.Zero; @@ -35,7 +35,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 4 public FaceRecognitionModel() { InteropModel.Create(out _handle).Validate("Failed to create FaceRecognitionModel"); @@ -57,7 +57,7 @@ namespace Tizen.Multimedia.Vision /// /// No permission to access the specified file. /// - /// 3 + /// 4 public FaceRecognitionModel(string modelPath) { if (modelPath == null) @@ -81,7 +81,7 @@ namespace Tizen.Multimedia.Vision /// Gets labels that had been learned by the model. /// /// The has already been disposed of. - /// 3 + /// 4 public int[] Labels { get @@ -115,7 +115,7 @@ namespace Tizen.Multimedia.Vision /// No permission to write to the specified path. /// The has already been disposed of. /// The directory for does not exist. - /// 3 + /// 4 public void Save(string path) { if (path == null) @@ -158,7 +158,7 @@ namespace Tizen.Multimedia.Vision /// has already been dispose of. /// /// - /// 3 + /// 4 public void Add(MediaVisionSource source, int label) { if (source == null) @@ -184,7 +184,7 @@ namespace Tizen.Multimedia.Vision /// has already been dispose of. /// /// - /// 3 + /// 4 public void Add(MediaVisionSource source, int label, Rectangle area) { if (source == null) @@ -203,7 +203,7 @@ namespace Tizen.Multimedia.Vision /// true if the examples are successfully removed; otherwise, false if there is no example labeled with the specified label. /// /// - /// 3 + /// 4 public bool Remove(int label) { var ret = InteropModel.Remove(Handle, ref label); @@ -221,7 +221,7 @@ namespace Tizen.Multimedia.Vision /// Removes all face examples. /// /// The has already been disposed of. - /// 3 + /// 4 public void Reset() { InteropModel.Reset(Handle).Validate("Failed to reset image example"); @@ -241,7 +241,7 @@ namespace Tizen.Multimedia.Vision /// No examples added. /// /// - /// 3 + /// 4 public void Learn() { Learn(null); @@ -265,7 +265,7 @@ namespace Tizen.Multimedia.Vision /// No examples added. /// /// - /// 3 + /// 4 public void Learn(FaceRecognitionConfiguration config) { InteropModel.Learn(EngineConfiguration.GetHandle(config), Handle). @@ -275,6 +275,7 @@ namespace Tizen.Multimedia.Vision /// /// Releases all the resources used by the object. /// + /// 4 public void Dispose() { Dispose(true); @@ -287,6 +288,7 @@ namespace Tizen.Multimedia.Vision /// /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources. /// + /// 4 protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModelType.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModelType.cs index 2416b5d..2625ef0 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModelType.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModelType.cs @@ -19,7 +19,7 @@ namespace Tizen.Multimedia.Vision /// /// Specifies the face recognition model learning algorithms. /// - /// 3 + /// 4 public enum FaceRecognitionModelType { /// diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionResult.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionResult.cs index ef960c1..283d6d1 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionResult.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionResult.cs @@ -19,7 +19,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents the result of operations. /// - /// 3 + /// 4 public class FaceRecognitionResult { internal FaceRecognitionResult(bool recognized, double confidence, int label, Rectangle? area) @@ -33,19 +33,19 @@ namespace Tizen.Multimedia.Vision /// /// Gets the value indicating the recognition is successful. /// - /// 3 + /// 4 public bool Success { get; } /// /// Gets the label of the recognized face. /// - /// 3 + /// 4 public int Label { get; } /// /// Gets the location of the recognized face. /// - /// 3 + /// 4 public Rectangle? Area { get; } /// @@ -54,7 +54,7 @@ namespace Tizen.Multimedia.Vision /// threshold for this value can be high (0.85-0.95). If model was learned for small amount of examples, /// then threshold can be reduced (0.5-0.85). /// - /// 3 + /// 4 public double Confidence { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognizer.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognizer.cs index defe2c7..8ec7764 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognizer.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognizer.cs @@ -24,7 +24,7 @@ namespace Tizen.Multimedia.Vision /// /// Provides the ability to recognize faces, face expressions, and eye condition on image sources. /// - /// 3 + /// 4 public static class FaceRecognizer { @@ -43,7 +43,7 @@ namespace Tizen.Multimedia.Vision /// has already been disposed of. /// is untrained model. /// http://tizen.org/feature/vision.face_recognition - /// 3 + /// 4 public static async Task RecognizeAsync(MediaVisionSource source, FaceRecognitionModel recognitionModel) { @@ -66,7 +66,7 @@ namespace Tizen.Multimedia.Vision /// has already been disposed of. /// is untrained model. /// http://tizen.org/feature/vision.face_recognition - /// 3 + /// 4 public static async Task RecognizeAsync(MediaVisionSource source, FaceRecognitionModel recognitionModel, Rectangle bound) { @@ -93,7 +93,7 @@ namespace Tizen.Multimedia.Vision /// /// is untrained model. /// http://tizen.org/feature/vision.face_recognition - /// 3 + /// 4 public static async Task RecognizeAsync(MediaVisionSource source, FaceRecognitionModel recognitionModel, FaceRecognitionConfiguration config) { @@ -122,7 +122,7 @@ namespace Tizen.Multimedia.Vision /// /// is untrained model. /// http://tizen.org/feature/vision.face_recognition - /// 3 + /// 4 public static async Task RecognizeAsync(MediaVisionSource source, FaceRecognitionModel recognitionModel, Rectangle bound, FaceRecognitionConfiguration config) { @@ -215,7 +215,7 @@ namespace Tizen.Multimedia.Vision /// has already been disposed of. /// The feature is not supported. /// http://tizen.org/feature/vision.face_recognition - /// 3 + /// 4 public static async Task RecognizeEyeConditionAsync(MediaVisionSource source, Rectangle bound) { @@ -237,7 +237,7 @@ namespace Tizen.Multimedia.Vision /// /// The feature is not supported. /// http://tizen.org/feature/vision.face_recognition - /// 3 + /// 4 public static async Task RecognizeEyeConditionAsync(MediaVisionSource source, Rectangle bound, FaceRecognitionConfiguration config) { @@ -277,7 +277,7 @@ namespace Tizen.Multimedia.Vision /// has already been disposed of. /// The feature is not supported. /// http://tizen.org/feature/vision.face_recognition - /// 3 + /// 4 public static async Task RecognizeFacialExpressionAsync(MediaVisionSource source, Rectangle bound) { @@ -299,7 +299,7 @@ namespace Tizen.Multimedia.Vision /// /// The feature is not supported. /// http://tizen.org/feature/vision.face_recognition - /// 3 + /// 4 public static async Task RecognizeFacialExpressionAsync(MediaVisionSource source, Rectangle bound, FaceRecognitionConfiguration config) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceTracker.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceTracker.cs index 22b529f..bc64764 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceTracker.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceTracker.cs @@ -24,7 +24,7 @@ namespace Tizen.Multimedia.Vision /// /// Provides the ability to track faces on image sources. /// - /// 3 + /// 4 public static class FaceTracker { @@ -50,7 +50,7 @@ namespace Tizen.Multimedia.Vision /// The feature is not supported. /// is not prepared. /// http://tizen.org/feature/vision.face_recognition - /// 3 + /// 4 public static async Task TrackAsync(MediaVisionSource source, FaceTrackingModel trackingModel, bool doLearn) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs index 09e3148..6f52d1e 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs @@ -24,7 +24,7 @@ namespace Tizen.Multimedia.Vision /// Represents the face tracking model. /// /// http://tizen.org/feature/vision.face_recognition - /// 3 + /// 4 public class FaceTrackingModel : IDisposable { private IntPtr _handle = IntPtr.Zero; @@ -34,7 +34,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 4 public FaceTrackingModel() { InteropModel.Create(out _handle).Validate("Failed to create FaceTrackingModel."); @@ -56,7 +56,7 @@ namespace Tizen.Multimedia.Vision /// /// No permission to access the specified file. /// - /// 3 + /// 4 public FaceTrackingModel(string modelPath) { if (modelPath == null) @@ -108,7 +108,7 @@ namespace Tizen.Multimedia.Vision /// -or-
/// has already bean disposed of. /// - /// 3 + /// 4 public void Prepare(MediaVisionSource source, Quadrangle region) { if (source == null) @@ -127,7 +127,7 @@ namespace Tizen.Multimedia.Vision /// No permission to write to the specified path. /// The has already been disposed of. /// The directory for does not exist. - /// 3 + /// 4 public void Save(string path) { if (path == null) @@ -148,6 +148,7 @@ namespace Tizen.Multimedia.Vision /// /// Releases all the resources used by the object. /// + /// 4 public void Dispose() { Dispose(true); @@ -160,6 +161,7 @@ namespace Tizen.Multimedia.Vision /// /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources. /// + /// 4 protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingResult.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingResult.cs index 1d6c260..99545c1 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingResult.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingResult.cs @@ -19,7 +19,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents the result of face tracking operation. /// - /// 3 + /// 4 public class FaceTrackingResult { internal FaceTrackingResult(bool success, double confidence, Quadrangle region) @@ -32,20 +32,20 @@ namespace Tizen.Multimedia.Vision /// /// Gets the value indicating the tracking is successful. /// - /// 3 + /// 4 public bool Success { get; } /// /// Gets the region which determines the new position of the tracked face on the source. /// - /// 3 + /// 4 public Quadrangle Region { get; } /// /// The confidence of the tracking model that a new location of the face was determined correctly /// (value from 0.0 to 1.0). If no location was determined during the last track iteration, then the value is 0.0. /// - /// 3 + /// 4 public double Confidence { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FacialExpression.cs b/src/Tizen.Multimedia.Vision/MediaVision/FacialExpression.cs index 81dc272..8a722c6 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/FacialExpression.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FacialExpression.cs @@ -19,7 +19,7 @@ namespace Tizen.Multimedia.Vision /// /// Specifies the expression types for faces. /// - /// 3 + /// 4 public enum FacialExpression { /// diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageFillConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageFillConfiguration.cs index c4c888c..6a52f42 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageFillConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageFillConfiguration.cs @@ -22,7 +22,7 @@ namespace Tizen.Multimedia.Vision /// Represents a configuration of fill operations of instances. /// /// http://tizen.org/feature/vision.image_recognition - /// 3 + /// 4 public class ImageFillConfiguration : EngineConfiguration { private const string KeyScaleFactor = "MV_IMAGE_RECOGNITION_OBJECT_SCALE_FACTOR"; @@ -31,20 +31,20 @@ namespace Tizen.Multimedia.Vision /// /// A read-only field that represents the default value of . /// - /// 3 + /// 4 public static readonly double DefaultScaleFactor = 1.2; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 4 public static readonly int DefaultMaxKeypoints = 1000; /// /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 4 public ImageFillConfiguration() : base("image_recognition") { } @@ -55,7 +55,7 @@ namespace Tizen.Multimedia.Vision /// The default value is 1.2. /// /// The already has been disposed of. - /// 3 + /// 4 public double ObjectScaleFactor { get @@ -75,7 +75,7 @@ namespace Tizen.Multimedia.Vision /// The default value is 1000. /// /// The already has been disposed of. - /// 3 + /// 4 public int ObjectMaxKeyPoints { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs index 7187aea..61de3cc 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs @@ -24,7 +24,7 @@ namespace Tizen.Multimedia.Vision /// Represents an image object. /// /// http://tizen.org/feature/vision.image_recognition - /// 3 + /// 4 public class ImageObject : IDisposable { private IntPtr _handle = IntPtr.Zero; @@ -34,7 +34,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 4 public ImageObject() { InteropImage.Create(out _handle).Validate("Failed to create image object"); @@ -56,7 +56,7 @@ namespace Tizen.Multimedia.Vision /// /// No permission to access the specified file. /// - /// 3 + /// 4 public ImageObject(string path) { if (path == null) @@ -91,7 +91,7 @@ namespace Tizen.Multimedia.Vision /// /// /// - /// 3 + /// 4 public double RecognitionRate { get @@ -110,7 +110,7 @@ namespace Tizen.Multimedia.Vision /// /// The has already been disposed of. /// - /// 3 + /// 4 public int? GetLabel() { var ret = InteropImage.GetLabel(Handle, out var label); @@ -129,7 +129,7 @@ namespace Tizen.Multimedia.Vision /// /// The label which will be assigned to the image object. /// - /// 3 + /// 4 public void SetLabel(int label) { InteropImage.SetLabel(Handle, label).Validate("Failed to set label"); @@ -146,7 +146,7 @@ namespace Tizen.Multimedia.Vision /// -or-
/// has already been disposed of. /// - /// 3 + /// 4 public void Fill(MediaVisionSource source) { InvokeFill(source, null, null); @@ -166,7 +166,7 @@ namespace Tizen.Multimedia.Vision /// -or-
/// has already been disposed of. /// - /// 3 + /// 4 public void Fill(MediaVisionSource source, ImageFillConfiguration config) { InvokeFill(source, config, null); @@ -185,7 +185,7 @@ namespace Tizen.Multimedia.Vision /// -or-
/// has already been disposed of. /// - /// 3 + /// 4 public void Fill(MediaVisionSource source, Rectangle rect) { InvokeFill(source, null, rect); @@ -207,7 +207,7 @@ namespace Tizen.Multimedia.Vision /// -or-
/// has already been disposed of. /// - /// 3 + /// 4 public void Fill(MediaVisionSource source, ImageFillConfiguration config, Rectangle rect) { InvokeFill(source, config, rect); @@ -244,7 +244,7 @@ namespace Tizen.Multimedia.Vision /// No permission to write to the specified path. /// The has already been disposed of. /// The directory for does not exist. - /// 3 + /// 4 public void Save(string path) { if (path == null) @@ -268,6 +268,7 @@ namespace Tizen.Multimedia.Vision /// /// Releases all the resources used by the object. /// + /// 4 public void Dispose() { Dispose(true); @@ -280,6 +281,7 @@ namespace Tizen.Multimedia.Vision /// /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources. /// + /// 4 protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionConfiguration.cs index 60ec4d4..aeaa3a6 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionConfiguration.cs @@ -22,7 +22,7 @@ namespace Tizen.Multimedia.Vision /// Represents a configuration of . /// /// http://tizen.org/feature/vision.image_recognition - /// 3 + /// 4 public class ImageRecognitionConfiguration : EngineConfiguration { private const string KeySceneScaleFactor = "MV_IMAGE_RECOGNITION_SCENE_SCALE_FACTOR"; @@ -35,38 +35,38 @@ namespace Tizen.Multimedia.Vision /// /// A read-only field that represents the default value of . /// - /// 3 + /// 4 public static readonly double DefaultSceneScaleFactor = 1.2; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 4 public static readonly int DefaultSceneMaxKeypoints = 5000; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 4 public static readonly int DefaultMinKeyPointMatches = 30; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 4 public static readonly double DefaultRequiredMatchPart = 0.05; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 4 public static readonly double DefaultTolerantPartMatchError = 0.1; /// /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 4 public ImageRecognitionConfiguration() : base("image_recognition") { } @@ -79,7 +79,7 @@ namespace Tizen.Multimedia.Vision /// The default is 1.2. /// /// The already has been disposed of. - /// 3 + /// 4 public double SceneScaleFactor { get @@ -102,7 +102,7 @@ namespace Tizen.Multimedia.Vision /// /// The already has been disposed of. /// is less than zero. - /// 3 + /// 4 public int SceneMaxKeyPoints { get @@ -129,7 +129,7 @@ namespace Tizen.Multimedia.Vision /// /// The already has been disposed of. /// is less than zero. - /// 3 + /// 4 public int MinKeyPointMatches { get @@ -163,7 +163,7 @@ namespace Tizen.Multimedia.Vision /// -or-
/// is greater than one. /// - /// 3 + /// 4 public double RequiredMatchingPart { get @@ -194,7 +194,7 @@ namespace Tizen.Multimedia.Vision /// -or-
/// is greater than one. /// - /// 3 + /// 4 public double TolerantPartMatchError { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionResult.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionResult.cs index 537407c..34667ca 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionResult.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionResult.cs @@ -19,7 +19,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents a result of RecognizeAsync operations of . /// - /// 3 + /// 4 public class ImageRecognitionResult { @@ -33,13 +33,13 @@ namespace Tizen.Multimedia.Vision /// The region of recognized image object on the source image. /// /// The region of recognized image object if successful, otherwise null. - /// 3 + /// 4 public Quadrangle Region { get; } /// /// Gets the value indicating the recognition is successful. /// - /// 3 + /// 4 public bool Success { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognizer.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognizer.cs index a7ecd51..c2bc20b 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognizer.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognizer.cs @@ -24,7 +24,7 @@ namespace Tizen.Multimedia.Vision /// /// Provides the ability to recognize images on image sources. /// - /// 3 + /// 4 public static class ImageRecognizer { /// @@ -44,7 +44,7 @@ namespace Tizen.Multimedia.Vision /// The feature is not supported. /// has already been disposed of. /// http://tizen.org/feature/vision.image_recognition - /// 3 + /// 4 public static async Task> RecognizeAsync( MediaVisionSource source, ImageObject[] imageObjects) { @@ -73,7 +73,7 @@ namespace Tizen.Multimedia.Vision /// has already been disposed of. /// /// http://tizen.org/feature/vision.image_recognition - /// 3 + /// 4 public static async Task> RecognizeAsync(MediaVisionSource source, ImageObject[] imageObjects, ImageRecognitionConfiguration config) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageTracker.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageTracker.cs index ef3dae6..c888a52 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageTracker.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageTracker.cs @@ -24,7 +24,7 @@ namespace Tizen.Multimedia.Vision /// /// Provides the ability to track images on image sources. /// - /// 3 + /// 4 public static class ImageTracker { /// @@ -47,7 +47,7 @@ namespace Tizen.Multimedia.Vision /// has no target. /// /// http://tizen.org/feature/vision.image_recognition - /// 3 + /// 4 public static async Task TrackAsync(MediaVisionSource source, ImageTrackingModel trackingModel) { @@ -77,7 +77,7 @@ namespace Tizen.Multimedia.Vision /// has no target. /// /// http://tizen.org/feature/vision.image_recognition - /// 3 + /// 4 public static async Task TrackAsync(MediaVisionSource source, ImageTrackingModel trackingModel, ImageTrackingConfiguration config) { diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingConfiguration.cs index 3d0d3d6..abb7f47 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingConfiguration.cs @@ -22,7 +22,7 @@ namespace Tizen.Multimedia.Vision /// Represents a configuration of . /// /// http://tizen.org/feature/vision.image_recognition - /// 3 + /// 4 public class ImageTrackingConfiguration : ImageRecognitionConfiguration { private const string KeyHistoryAmount = "MV_IMAGE_TRACKING_HISTORY_AMOUNT"; @@ -35,44 +35,44 @@ namespace Tizen.Multimedia.Vision /// /// A read-only field that represents the default value of . /// - /// 3 + /// 4 public static readonly int DefaultHistoryAmount = 3; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 4 public static readonly double DefaultExpectedOffset = 0; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 4 public static readonly bool DefaultStabilizationEnabled = true; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 4 public static readonly double DefaultStabilizationTolerantShift = 0.00006; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 4 public static readonly double DefaultStabilizationSpeed = 0.3; /// /// A read-only field that represents the default value of . /// - /// 3 + /// 4 public static readonly double DefaultStabilizationAcceleration = 0.1; /// /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 4 public ImageTrackingConfiguration() { } @@ -86,7 +86,7 @@ namespace Tizen.Multimedia.Vision /// /// The already has been disposed of. /// is less than zero. - /// 3 + /// 4 public int HistoryAmount { get @@ -112,7 +112,7 @@ namespace Tizen.Multimedia.Vision /// The default is 0. /// /// The already has been disposed of. - /// 3 + /// 4 public double ExpectedOffset { get @@ -139,7 +139,7 @@ namespace Tizen.Multimedia.Vision /// -or-
/// is greater than one. /// - /// 3 + /// 4 public double StabilizationAcceleration { get @@ -165,7 +165,7 @@ namespace Tizen.Multimedia.Vision /// The default is 0.3. /// /// The already has been disposed of. - /// 3 + /// 4 public double StabilizationSpeed { get @@ -190,7 +190,7 @@ namespace Tizen.Multimedia.Vision /// The default is 0.00006. /// /// The already has been disposed of. - /// 3 + /// 4 public double StabilizationTolerantShift { get @@ -211,7 +211,7 @@ namespace Tizen.Multimedia.Vision /// The default is true. /// /// The already has been disposed of. - /// 3 + /// 4 public bool IsStabilizationEnabled { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs index f68770a..db2ae93 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs @@ -24,7 +24,7 @@ namespace Tizen.Multimedia.Vision /// Represents the image tracking model interface. ///
/// http://tizen.org/feature/vision.image_recognition - /// 3 + /// 4 public class ImageTrackingModel : IDisposable { private IntPtr _handle = IntPtr.Zero; @@ -34,7 +34,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The feature is not supported. - /// 3 + /// 4 public ImageTrackingModel() { InteropModel.Create(out _handle).Validate("Failed to create FaceTrackingModel"); @@ -56,7 +56,7 @@ namespace Tizen.Multimedia.Vision /// /// No permission to access the specified file. /// - /// 3 + /// 4 public ImageTrackingModel(string modelPath) { if (modelPath == null) @@ -85,7 +85,7 @@ namespace Tizen.Multimedia.Vision /// -or-
/// has already been disposed of. /// - /// 3 + /// 4 public void SetTarget(ImageObject imageObject) { if (imageObject == null) @@ -104,7 +104,7 @@ namespace Tizen.Multimedia.Vision /// Tracking algorithm will try to find image by itself. /// /// The has already been disposed of. - /// 3 + /// 4 public void Refresh() { InteropModel.Refresh(Handle, IntPtr.Zero).Validate("Failed to refresh state"); @@ -118,7 +118,7 @@ namespace Tizen.Multimedia.Vision /// No permission to write to the specified path. /// The has already been disposed of. /// The directory for does not exist. - /// 3 + /// 4 public void Save(string path) { if (path == null) @@ -139,6 +139,7 @@ namespace Tizen.Multimedia.Vision /// /// Releases all resources used by the object. /// + /// 4 public void Dispose() { Dispose(true); @@ -151,6 +152,7 @@ namespace Tizen.Multimedia.Vision /// /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources. /// + /// 4 protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs b/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs index 9712bb6..a8f8c2f 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs @@ -29,7 +29,7 @@ namespace Tizen.Multimedia.Vision /// http://tizen.org/feature/vision.barcode_generation /// http://tizen.org/feature/vision.face_recognition /// http://tizen.org/feature/vision.image_recognition - /// 3 + /// 4 public class MediaVisionSource : IBufferOwner, IDisposable { private IntPtr _handle = IntPtr.Zero; @@ -75,7 +75,7 @@ namespace Tizen.Multimedia.Vision /// None of the related features are not supported. /// is null. /// has already been disposed of. - /// 3 + /// 4 public MediaVisionSource(MediaPacket mediaPacket) : this(handle => FillMediaPacket(handle, mediaPacket)) { @@ -119,7 +119,7 @@ namespace Tizen.Multimedia.Vision /// -or-
/// is invalid. /// - /// 3 + /// 4 public MediaVisionSource(byte[] buffer, uint width, uint height, ColorSpace colorSpace) : this(handle => FillBuffer(handle, buffer, width, height, colorSpace)) { @@ -139,7 +139,7 @@ namespace Tizen.Multimedia.Vision /// Gets the buffer of the media source. /// /// The has already been disposed of. - /// 3 + /// 4 public IMediaBuffer Buffer { get @@ -162,6 +162,7 @@ namespace Tizen.Multimedia.Vision /// Gets MediaVision's supported ColorSpace state. /// true if supported, otherwise false. /// + /// 4 public static bool IsSupportedColorSpace(ColorSpace colorSpace) { return SupportedColorSpaces.Contains(colorSpace); @@ -171,7 +172,7 @@ namespace Tizen.Multimedia.Vision /// Gets the height of the media source. /// /// The has already been disposed of. - /// 3 + /// 4 public uint Height { get @@ -187,7 +188,7 @@ namespace Tizen.Multimedia.Vision /// Gets the width of the media source. /// /// The has already been disposed of. - /// 3 + /// 4 public uint Width { get @@ -203,7 +204,7 @@ namespace Tizen.Multimedia.Vision /// Gets of the media source. /// /// The has already been disposed of. - /// 3 + /// 4 public ColorSpace Colorspace { get @@ -219,6 +220,7 @@ namespace Tizen.Multimedia.Vision /// /// Gets the supported colorspaces for . /// + /// 4 public static IEnumerable SupportedColorSpaces { get @@ -233,6 +235,7 @@ namespace Tizen.Multimedia.Vision /// /// Releases all resources used by the current instance. /// + /// 4 public void Dispose() { Dispose(true); @@ -245,6 +248,7 @@ namespace Tizen.Multimedia.Vision /// /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources. /// + /// 4 protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectedEventArgs.cs b/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectedEventArgs.cs index a5dba43..0cb70fc 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectedEventArgs.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectedEventArgs.cs @@ -22,13 +22,13 @@ namespace Tizen.Multimedia.Vision /// /// Provides data for the event. /// - /// 3 + /// 4 public class MovementDetectedEventArgs : EventArgs { /// /// Initializes a new instance of the class. /// - /// 3 + /// 4 public MovementDetectedEventArgs(IEnumerable areas) { Areas = areas; @@ -37,7 +37,7 @@ namespace Tizen.Multimedia.Vision /// /// Gets a set of rectangular regions where movement was detected. /// - /// 3 + /// 4 public IEnumerable Areas { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectionConfiguration.cs index c3db89e..833a59e 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectionConfiguration.cs @@ -23,7 +23,7 @@ namespace Tizen.Multimedia.Vision /// /// http://tizen.org/feature/vision.face_recognition /// http://tizen.org/feature/vision.image_recognition - /// 3 + /// 4 public class MovementDetectionConfiguration : SurveillanceEngineConfiguration { private const string KeyThreshold = "MV_SURVEILLANCE_MOVEMENT_DETECTION_THRESHOLD"; @@ -31,14 +31,14 @@ namespace Tizen.Multimedia.Vision /// /// A read-only field that represents the default value of . /// - /// 3 + /// 4 public static readonly int DefaultThreshold = 10; /// /// Initializes a new instance of the class. /// /// The required features are not supported. - /// 3 + /// 4 public MovementDetectionConfiguration() { } @@ -60,7 +60,7 @@ namespace Tizen.Multimedia.Vision /// -or-
/// is greater than 255. /// - /// 3 + /// 4 public int Threshold { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/MovementDetector.cs b/src/Tizen.Multimedia.Vision/MediaVision/MovementDetector.cs index 27daf49..cd80b00 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/MovementDetector.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/MovementDetector.cs @@ -25,7 +25,7 @@ namespace Tizen.Multimedia.Vision /// http://tizen.org/feature/vision.face_recognition /// http://tizen.org/feature/vision.image_recognition /// - /// 3 + /// 4 public class MovementDetector : SurveillanceEngine { private const string KeyNumberOfRegions = "NUMBER_OF_MOVEMENT_REGIONS"; @@ -37,7 +37,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The required features are not supported. - /// 3 + /// 4 public MovementDetector() : base(MovementDetectedEventType) { } @@ -46,7 +46,7 @@ namespace Tizen.Multimedia.Vision /// Occurs when the movement detected. /// /// The event handler will be executed on an internal thread. - /// 3 + /// 4 public event EventHandler Detected; internal override void OnEventDetected(IntPtr trigger, IntPtr source, int streamId, @@ -92,7 +92,7 @@ namespace Tizen.Multimedia.Vision /// is null. /// The has already been disposed of. /// - /// 3 + /// 4 public void AddSource(SurveillanceSource source) { AddSource(source, null); @@ -110,7 +110,7 @@ namespace Tizen.Multimedia.Vision /// has already been disposed of. /// /// - /// 3 + /// 4 public void AddSource(SurveillanceSource source, MovementDetectionConfiguration config) { InvokeAddSource(source, config); diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetectedEventArgs.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetectedEventArgs.cs index 3e0f94d..70d4a09 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetectedEventArgs.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetectedEventArgs.cs @@ -22,13 +22,13 @@ namespace Tizen.Multimedia.Vision /// /// Provides data for the event. /// - /// 3 + /// 4 public class PersonAppearanceDetectedEventArgs : EventArgs { /// /// Initializes a new instance of the class. /// - /// 3 + /// 4 public PersonAppearanceDetectedEventArgs(IEnumerable appeared, IEnumerable disappeared, IEnumerable tracked) { @@ -40,19 +40,19 @@ namespace Tizen.Multimedia.Vision /// /// Gets a set of rectangular regions where appearances of the persons were detected. /// - /// 3 + /// 4 public IEnumerable AppearanceAreas { get; } /// /// Gets a set of rectangular regions where disappearances of the persons were detected. /// - /// 3 + /// 4 public IEnumerable DisappearanceAreas { get; } /// /// Gets a set of rectangular regions where persons were tracked. /// - /// 3 + /// 4 public IEnumerable TrackedAreas { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetectionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetectionConfiguration.cs index f6e75cf..4a71377 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetectionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetectionConfiguration.cs @@ -23,7 +23,7 @@ namespace Tizen.Multimedia.Vision /// /// http://tizen.org/feature/vision.face_recognition /// http://tizen.org/feature/vision.image_recognition - /// 3 + /// 4 public class PersonAppearanceDetectionConfiguration : SurveillanceEngineConfiguration { private const string KeySkipFramesCount = "MV_SURVEILLANCE_SKIP_FRAMES_COUNT"; @@ -31,14 +31,14 @@ namespace Tizen.Multimedia.Vision /// /// A read-only field that represents the default value of . /// - /// 3 + /// 4 public static readonly int DefaultSkipFramesCount = 0; /// /// Initializes a new instance of the class. /// /// The required features are not supported. - /// 3 + /// 4 public PersonAppearanceDetectionConfiguration() { } @@ -56,7 +56,7 @@ namespace Tizen.Multimedia.Vision /// The already has been disposed of. /// is less than zero. /// - /// 3 + /// 4 public int SkipFramesCount { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetector.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetector.cs index c985543..ad2e42a 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetector.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetector.cs @@ -25,7 +25,7 @@ namespace Tizen.Multimedia.Vision /// http://tizen.org/feature/vision.face_recognition /// http://tizen.org/feature/vision.image_recognition /// - /// 3 + /// 4 public class PersonAppearanceDetector : SurveillanceEngine { private const string KeyAppearedNumber = "NUMBER_OF_APPEARED_PERSONS"; @@ -41,7 +41,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The required features are not supported. - /// 3 + /// 4 public PersonAppearanceDetector() : base(PersonAppearanceEventType) { } @@ -50,7 +50,7 @@ namespace Tizen.Multimedia.Vision /// Occurs when the any appearance changes detected. /// /// The event handler will be executed on an internal thread. - /// 3 + /// 4 public event EventHandler Detected; internal override void OnEventDetected(IntPtr trigger, IntPtr source, int streamId, @@ -97,7 +97,7 @@ namespace Tizen.Multimedia.Vision /// is null. /// The has already been disposed of. /// - /// 3 + /// 4 public void AddSource(SurveillanceSource source) { AddSource(source, null); @@ -115,7 +115,7 @@ namespace Tizen.Multimedia.Vision /// has already been disposed of. /// /// - /// 3 + /// 4 public void AddSource(SurveillanceSource source, PersonAppearanceDetectionConfiguration config) { InvokeAddSource(source, config); diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionConfiguration.cs index 4a28603..792320d 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionConfiguration.cs @@ -23,7 +23,7 @@ namespace Tizen.Multimedia.Vision /// /// http://tizen.org/feature/vision.face_recognition /// http://tizen.org/feature/vision.image_recognition - /// 3 + /// 4 public class PersonRecognitionConfiguration : SurveillanceEngineConfiguration { private const string KeyFaceRecognitionModelFilePath = "MV_SURVEILLANCE_FACE_RECOGNITION_MODEL_FILE_PATH"; @@ -34,7 +34,7 @@ namespace Tizen.Multimedia.Vision /// Path to the face recognition model. /// is null. /// The required features are not supported. - /// 3 + /// 4 public PersonRecognitionConfiguration(string modelPath) { FaceRecognitionModelPath = modelPath; @@ -45,7 +45,7 @@ namespace Tizen.Multimedia.Vision /// /// is null. /// The already has been disposed of. - /// 3 + /// 4 public string FaceRecognitionModelPath { get diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionInfo.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionInfo.cs index 1162532..eb622bb 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionInfo.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionInfo.cs @@ -19,13 +19,13 @@ namespace Tizen.Multimedia.Vision /// /// Represents a result of instances. /// - /// 3 + /// 4 public class PersonRecognitionInfo { /// /// Initializes a new instance of the class. /// - /// 3 + /// 4 public PersonRecognitionInfo(Rectangle area, int label, double confidence) { Area = area; @@ -36,19 +36,19 @@ namespace Tizen.Multimedia.Vision /// /// Gets the rectangular location where person face was recognized. /// - /// 3 + /// 4 public Rectangle Area { get; } /// /// Gets the label that correspond to the recognized person. /// - /// 3 + /// 4 public int Label { get; } /// /// Gets the confidence value that correspond to the recognized person. /// - /// 3 + /// 4 public double Confidence { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizedEventArgs.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizedEventArgs.cs index 4b8b7b8..e28e981 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizedEventArgs.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizedEventArgs.cs @@ -22,13 +22,13 @@ namespace Tizen.Multimedia.Vision /// /// Provides data for the event. /// - /// 3 + /// 4 public class PersonRecognizedEventArgs : EventArgs { /// /// Initializes a new instance of the class. /// - /// 3 + /// 4 public PersonRecognizedEventArgs(IEnumerable recognitionInfo) { Recognitions = recognitionInfo; @@ -37,7 +37,7 @@ namespace Tizen.Multimedia.Vision /// /// Gets a set of information that correspond to the recognized persons. /// - /// 3 + /// 4 public IEnumerable Recognitions { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizer.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizer.cs index 136aa6d..e64edbe 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizer.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizer.cs @@ -25,7 +25,7 @@ namespace Tizen.Multimedia.Vision /// http://tizen.org/feature/vision.face_recognition /// http://tizen.org/feature/vision.image_recognition /// - /// 3 + /// 4 public class PersonRecognizer : SurveillanceEngine { private const string KeyCount = "NUMBER_OF_PERSONS"; @@ -39,7 +39,7 @@ namespace Tizen.Multimedia.Vision /// Initializes a new instance of the class. /// /// The required features are not supported. - /// 3 + /// 4 public PersonRecognizer() : base(PersonRecognizedEventType) { } @@ -49,7 +49,7 @@ namespace Tizen.Multimedia.Vision /// /// The event handler will be executed on an internal thread. /// - /// 3 + /// 4 public event EventHandler Recognized; internal override void OnEventDetected(IntPtr trigger, IntPtr source, int streamId, @@ -117,7 +117,7 @@ namespace Tizen.Multimedia.Vision /// /// The model file is not supported format or file. /// - /// 3 + /// 4 public void AddSource(SurveillanceSource source, PersonRecognitionConfiguration config) { if (config == null) diff --git a/src/Tizen.Multimedia.Vision/MediaVision/QrConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/QrConfiguration.cs index 19b005d..cd070a7 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/QrConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/QrConfiguration.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents a QR configuration of . /// - /// 3 + /// 4 public class QrConfiguration { /// @@ -45,7 +45,7 @@ namespace Tizen.Multimedia.Vision /// var qrConfig = new QrConfiguration(QrMode.Numeric, ErrorCorrectionLevel.Medium, 30); /// /// - /// 3 + /// 4 public QrConfiguration(QrMode qrMode, ErrorCorrectionLevel ecc, int version) { if (version < 1 || version > 40) @@ -64,19 +64,19 @@ namespace Tizen.Multimedia.Vision /// /// Gets the encoding mode for the message. /// - /// 3 + /// 4 public QrMode Mode { get; } /// /// Gets the error correction level. /// - /// 3 + /// 4 public ErrorCorrectionLevel ErrorCorrectionLevel { get; } /// /// Gets the QR code version. /// - /// 3 + /// 4 public int Version { get; } } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/QrMode.cs b/src/Tizen.Multimedia.Vision/MediaVision/QrMode.cs index 2054cb0..6432215 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/QrMode.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/QrMode.cs @@ -19,7 +19,7 @@ namespace Tizen.Multimedia.Vision /// /// Specifies the supported QR code encoding modes. /// - /// 3 + /// 4 public enum QrMode { /// diff --git a/src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs b/src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs index c7c3f6a..2ff292b 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Vision /// /// Represents a region with 4 s. /// - /// 3 + /// 4 public class Quadrangle { @@ -31,7 +31,7 @@ namespace Tizen.Multimedia.Vision /// must have 4 elements. /// Four points that define the object bounding quadrangle. /// The length of is not 4. - /// 3 + /// 4 public Quadrangle(Point[] points) { if (points.Length != 4) @@ -45,13 +45,14 @@ namespace Tizen.Multimedia.Vision /// /// Gets four points that define the object bounding quadrangle. /// - /// 3 + /// 4 public Point[] Points { get; } /// /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 4 public override string ToString() => $"[{{{Points[0].ToString()}}}, {{{Points[1].ToString()}}}, {{{Points[2].ToString()}}}, {{{Points[3].ToString()}}}]"; } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceConfiguration.cs index 52af409..1fadd6d 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceConfiguration.cs @@ -21,7 +21,7 @@ namespace Tizen.Multimedia.Vision /// /// http://tizen.org/feature/vision.face_recognition /// http://tizen.org/feature/vision.image_recognition - /// 3 + /// 4 public class SurveillanceEngineConfiguration : EngineConfiguration { internal SurveillanceEngineConfiguration() : base("face_recognition", "image_recognition") diff --git a/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs b/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs index 7d0f2be..cab419b 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs @@ -29,7 +29,7 @@ namespace Tizen.Multimedia.Vision /// /// /// - /// 3 + /// 4 public abstract class SurveillanceEngine : IDisposable { private IntPtr _handle = IntPtr.Zero; @@ -68,7 +68,7 @@ namespace Tizen.Multimedia.Vision /// Sets and gets the ROI (Region Of Interest). /// /// The has already been disposed of. - /// 3 + /// 4 public Point[] Roi { get @@ -124,7 +124,7 @@ namespace Tizen.Multimedia.Vision /// is null. /// The has already been disposed of. /// has not been added. - /// 3 + /// 4 public void RemoveSource(SurveillanceSource source) { if (source == null) @@ -137,6 +137,7 @@ namespace Tizen.Multimedia.Vision /// /// Releases all the resources used by the object. /// + /// 4 public void Dispose() { Dispose(true); @@ -149,6 +150,7 @@ namespace Tizen.Multimedia.Vision /// /// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources. /// + /// 4 protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceSource.cs b/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceSource.cs index 8c2eba1..7a1eb50 100755 --- a/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceSource.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceSource.cs @@ -25,7 +25,7 @@ namespace Tizen.Multimedia.Vision /// /// /// - /// 3 + /// 4 public class SurveillanceSource { private static int _nextStreamId = int.MinValue; @@ -46,7 +46,7 @@ namespace Tizen.Multimedia.Vision /// /// Initializes a new instance of the class. /// - /// 3 + /// 4 public SurveillanceSource() { StreamId = GetNextStreamId(); @@ -64,7 +64,7 @@ namespace Tizen.Multimedia.Vision /// /// /// - /// 3 + /// 4 public void Push(MediaVisionSource source) { if (source == null) diff --git a/src/Tizen.Multimedia/AudioManager/AudioDevice.cs b/src/Tizen.Multimedia/AudioManager/AudioDevice.cs index c5fa445..cd7bcc2 100755 --- a/src/Tizen.Multimedia/AudioManager/AudioDevice.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioDevice.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia /// /// Provides the ability to query the information of sound devices. /// + /// 3 public class AudioDevice { private readonly int _id; @@ -49,30 +50,35 @@ namespace Tizen.Multimedia /// Gets the ID of the device. /// /// The id of the device. + /// 3 public int Id => _id; /// /// Gets the name of the device. /// /// The name of the device. + /// 3 public string Name { get; } /// /// Gets the type of the device. /// /// The of the device. + /// 3 public AudioDeviceType Type => _type; /// /// Gets the IO direction of the device. /// /// The IO direction of the device. + /// 3 public AudioDeviceIoDirection IoDirection => _ioDirection; /// /// Gets the state of the device. /// /// The of the device. + /// 3 public AudioDeviceState State { get @@ -88,6 +94,7 @@ namespace Tizen.Multimedia /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 4 public override string ToString() => $"Id={Id}, Name={Name}, Type={Type}, IoDirection={IoDirection}, State={State}"; @@ -96,6 +103,7 @@ namespace Tizen.Multimedia /// /// A to compare. /// true if the two devices are equal; otherwise, false. + /// 4 public override bool Equals(object obj) { var rhs = obj as AudioDevice; @@ -112,6 +120,7 @@ namespace Tizen.Multimedia /// Gets the hash code for this instance of . /// /// The hash code for this instance of . + /// 4 public override int GetHashCode() { return Id.GetHashCode(); diff --git a/src/Tizen.Multimedia/AudioManager/AudioDeviceConnectionChangedEventArgs.cs b/src/Tizen.Multimedia/AudioManager/AudioDeviceConnectionChangedEventArgs.cs index d23266c..a35b013 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioDeviceConnectionChangedEventArgs.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioDeviceConnectionChangedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class AudioDeviceConnectionChangedEventArgs : EventArgs { internal AudioDeviceConnectionChangedEventArgs(AudioDevice device, bool isConnected) @@ -33,12 +34,14 @@ namespace Tizen.Multimedia /// Gets the device. /// /// The . + /// 3 public AudioDevice Device { get; } /// /// Gets the connection state of the device. /// /// true if the device is connected; otherwise, false. + /// 3 public bool IsConnected { get; } } } diff --git a/src/Tizen.Multimedia/AudioManager/AudioDeviceStateChangedEventArgs.cs b/src/Tizen.Multimedia/AudioManager/AudioDeviceStateChangedEventArgs.cs index ba9e33a..84093ce 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioDeviceStateChangedEventArgs.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioDeviceStateChangedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class AudioDeviceStateChangedEventArgs : EventArgs { internal AudioDeviceStateChangedEventArgs(AudioDevice device, AudioDeviceState changedState) @@ -33,12 +34,14 @@ namespace Tizen.Multimedia /// Gets the device. /// /// The . + /// 3 public AudioDevice Device { get; } /// /// Gets the state of the device. /// /// The of the device. + /// 4 public AudioDeviceState State { get; } } } diff --git a/src/Tizen.Multimedia/AudioManager/AudioManager.cs b/src/Tizen.Multimedia/AudioManager/AudioManager.cs index b6be3d5..ca3745c 100755 --- a/src/Tizen.Multimedia/AudioManager/AudioManager.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioManager.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia /// /// Provides the ability to control volume levels and monitor audio devices. /// + /// 3 public static class AudioManager { static AudioManager() @@ -33,12 +34,14 @@ namespace Tizen.Multimedia /// Gets the volume controller. /// /// The . + /// 3 public static AudioVolume VolumeController { get; } /// /// Gets the all devices currently connected. /// /// An IEnumerable<AudioDevice> that contains connected devices. + /// 4 public static IEnumerable GetConnectedDevices() { IntPtr deviceListHandle = IntPtr.Zero; @@ -87,6 +90,7 @@ namespace Tizen.Multimedia /// /// Occurs when the state of a connection of an audio device changes. /// + /// 3 public static event EventHandler DeviceConnectionChanged { add @@ -148,6 +152,7 @@ namespace Tizen.Multimedia /// /// Occurs when the state of an audio device changes. /// + /// 3 public static event EventHandler DeviceStateChanged { add diff --git a/src/Tizen.Multimedia/AudioManager/AudioManagerEnums.cs b/src/Tizen.Multimedia/AudioManager/AudioManagerEnums.cs index 74d90b1..70d6183 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioManagerEnums.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioManagerEnums.cs @@ -65,6 +65,7 @@ namespace Tizen.Multimedia /// /// Specifies the audio device types. /// + /// 3 public enum AudioDeviceType { /// @@ -108,6 +109,7 @@ namespace Tizen.Multimedia /// /// Specifies the audio device directions. /// + /// 3 public enum AudioDeviceIoDirection { /// @@ -127,6 +129,7 @@ namespace Tizen.Multimedia /// /// Specifies the audio device states. /// + /// 3 public enum AudioDeviceState { /// @@ -142,6 +145,7 @@ namespace Tizen.Multimedia /// /// Specifies the audio volume types. /// + /// 3 public enum AudioVolumeType { /// @@ -186,6 +190,7 @@ namespace Tizen.Multimedia /// /// Specifies the audio stream types. /// + /// 3 public enum AudioStreamType { /// @@ -233,6 +238,7 @@ namespace Tizen.Multimedia /// /// Specifies the change reasons of the audio stream focus state. /// + /// 3 public enum AudioStreamFocusChangedReason { /// @@ -287,6 +293,7 @@ namespace Tizen.Multimedia /// This enumeration has a attribute that allows a bitwise combination of its member values. /// /// + /// 3 [Flags] public enum AudioStreamFocusOptions { @@ -303,6 +310,7 @@ namespace Tizen.Multimedia /// /// Specifies the audio stream focus states. /// + /// 3 public enum AudioStreamFocusState { /// @@ -321,6 +329,7 @@ namespace Tizen.Multimedia /// This enumeration has a attribute that allows a bitwise combination of its member values. /// /// + /// 4 [Flags] public enum AudioStreamBehaviors { diff --git a/src/Tizen.Multimedia/AudioManager/AudioPolicyException.cs b/src/Tizen.Multimedia/AudioManager/AudioPolicyException.cs index b0d4890..c0113f8 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioPolicyException.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioPolicyException.cs @@ -21,11 +21,13 @@ namespace Tizen.Multimedia /// /// The exception that is thrown when noncompliance with the sound system policy happens. /// + /// 4 public class AudioPolicyException : InvalidOperationException { /// /// Initializes a new instance of the class. /// + /// 4 public AudioPolicyException() { } @@ -34,6 +36,7 @@ namespace Tizen.Multimedia /// Initializes a new instance of the class with a specified error message. /// /// The error message that explains the reason for the exception. + /// 4 public AudioPolicyException(string message) : base(message) { } @@ -43,6 +46,7 @@ namespace Tizen.Multimedia /// /// The error message that explains the reason for the exception. /// The exception that is the cause of the current exception.. + /// 4 public AudioPolicyException(string message, Exception innerException) : base(message, innerException) { } diff --git a/src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs b/src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs index 89e7560..fb05936 100755 --- a/src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioStreamPolicy.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia /// /// Provides the ability to control the sound stream. /// + /// 3 public class AudioStreamPolicy : IDisposable { private AudioStreamPolicyHandle _handle; @@ -38,6 +39,7 @@ namespace Tizen.Multimedia /// /// The type of the sound stream for which the policy needs to be created. /// is invalid. + /// 3 public AudioStreamPolicy(AudioStreamType streamType) { ValidationUtil.ValidateEnum(typeof(AudioStreamType), streamType, nameof(streamType)); @@ -62,6 +64,7 @@ namespace Tizen.Multimedia /// /// The event is raised in the internal thread. /// + /// 4 public event EventHandler FocusStateChanged; /// @@ -73,6 +76,7 @@ namespace Tizen.Multimedia /// /// The of the policy instance. /// The has already been disposed of. + /// 3 public AudioVolumeType VolumeType { get @@ -103,6 +107,7 @@ namespace Tizen.Multimedia /// /// The state of focus for playback. /// The has already been disposed of. + /// 3 public AudioStreamFocusState PlaybackFocusState => GetFocusState(true); /// @@ -110,6 +115,7 @@ namespace Tizen.Multimedia /// /// The state of focus for recording. /// The has already been disposed of. + /// 3 public AudioStreamFocusState RecordingFocusState => GetFocusState(false); /// @@ -124,6 +130,7 @@ namespace Tizen.Multimedia /// disable the focus reacquisition. /// /// The has already been disposed of. + /// 3 public bool FocusReacquisitionEnabled { get @@ -167,6 +174,7 @@ namespace Tizen.Multimedia /// The focus has already been acquired. /// Called in raised by releasing focus. /// The has already been disposed of. + /// 3 public void AcquireFocus(AudioStreamFocusOptions options, AudioStreamBehaviors behaviors, string extraInfo) { if (options == 0) @@ -202,6 +210,7 @@ namespace Tizen.Multimedia /// /// The focus has not been acquired. /// The has already been disposed of. + /// 3 public void ReleaseFocus(AudioStreamFocusOptions options, AudioStreamBehaviors behaviors, string extraInfo) { if (options == 0) @@ -232,6 +241,7 @@ namespace Tizen.Multimedia /// /// /// The has already been disposed of. + /// 3 public void ApplyStreamRouting() { Interop.AudioStreamPolicy.ApplyStreamRouting(Handle).Validate("Failed to apply stream routing"); @@ -254,6 +264,7 @@ namespace Tizen.Multimedia /// The has already been disposed of. /// /// + /// 3 public void AddDeviceForStreamRouting(AudioDevice device) { if (device == null) @@ -282,6 +293,7 @@ namespace Tizen.Multimedia /// is null. /// The has already been disposed of. /// + /// 3 public void RemoveDeviceForStreamRouting(AudioDevice device) { if (device == null) @@ -296,6 +308,7 @@ namespace Tizen.Multimedia /// /// Releases all resources used by the . /// + /// 3 public void Dispose() { Dispose(true); @@ -305,6 +318,7 @@ namespace Tizen.Multimedia /// Releases the unmanaged resources used by the . /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// 3 protected virtual void Dispose(bool disposing) { if (!_disposed) @@ -327,6 +341,7 @@ namespace Tizen.Multimedia /// /// Occurs when the focus state for stream types is changed regardless of the process. /// + /// 3 public static event EventHandler StreamFocusStateChanged { add diff --git a/src/Tizen.Multimedia/AudioManager/AudioStreamPolicyFocusStateChangedEventArgs.cs b/src/Tizen.Multimedia/AudioManager/AudioStreamPolicyFocusStateChangedEventArgs.cs index e5a8b99..02a1eea 100644 --- a/src/Tizen.Multimedia/AudioManager/AudioStreamPolicyFocusStateChangedEventArgs.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioStreamPolicyFocusStateChangedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 4 public class AudioStreamPolicyFocusStateChangedEventArgs : EventArgs { internal AudioStreamPolicyFocusStateChangedEventArgs(AudioStreamFocusOptions options, @@ -38,24 +39,28 @@ namespace Tizen.Multimedia /// Gets the focus options. /// /// The focus options. + /// 4 public AudioStreamFocusOptions FocusOptions { get; } /// /// Gets the focus state. /// /// The focus state. + /// 4 public AudioStreamFocusState FocusState { get; } /// /// Gets the reason for state change of the focus. /// /// The reason for state change of the focus. + /// 4 public AudioStreamFocusChangedReason Reason { get; } /// /// Gets the requested behaviors that should be followed. /// /// The requested behaviors that should be followed. + /// 4 public AudioStreamBehaviors Behaviors { get; } /// @@ -67,6 +72,7 @@ namespace Tizen.Multimedia /// /// /// + /// 4 public string ExtraInfo { get; } } } diff --git a/src/Tizen.Multimedia/AudioManager/AudioVolume.cs b/src/Tizen.Multimedia/AudioManager/AudioVolume.cs index d50df66..7667176 100755 --- a/src/Tizen.Multimedia/AudioManager/AudioVolume.cs +++ b/src/Tizen.Multimedia/AudioManager/AudioVolume.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia /// Provides the ability to control the volume levels. /// /// + /// 3 public class AudioVolume { private const string Tag = "Tizen.Multimedia.AudioVolume"; @@ -41,6 +42,7 @@ namespace Tizen.Multimedia /// /// Occurs when the volume level is changed. /// + /// 3 public event EventHandler Changed { add @@ -76,6 +78,7 @@ namespace Tizen.Multimedia /// Gets the volume type of the sound being currently played. /// /// The volume type of the sound being currently played. + /// 3 public AudioVolumeType CurrentPlaybackType { get @@ -95,12 +98,14 @@ namespace Tizen.Multimedia /// Gets the . /// /// The . + /// 3 public VolumeLevel Level { get; } /// /// Gets the . /// /// The . + /// 3 public MaxVolumeLevel MaxLevel { get; } private void RegisterVolumeChangedEvent() diff --git a/src/Tizen.Multimedia/AudioManager/MaxVolumeLevel.cs b/src/Tizen.Multimedia/AudioManager/MaxVolumeLevel.cs index 7a8cc90..ea15e7b 100644 --- a/src/Tizen.Multimedia/AudioManager/MaxVolumeLevel.cs +++ b/src/Tizen.Multimedia/AudioManager/MaxVolumeLevel.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides a means to get max volume levels. /// + /// 3 public class MaxVolumeLevel { internal MaxVolumeLevel() @@ -34,6 +35,7 @@ namespace Tizen.Multimedia /// The maximum volume level. /// is invalid. /// is . + /// 3 public int this[AudioVolumeType type] { get diff --git a/src/Tizen.Multimedia/AudioManager/StreamFocusStateChangedEventArgs.cs b/src/Tizen.Multimedia/AudioManager/StreamFocusStateChangedEventArgs.cs index fc00e92..4ccb730 100755 --- a/src/Tizen.Multimedia/AudioManager/StreamFocusStateChangedEventArgs.cs +++ b/src/Tizen.Multimedia/AudioManager/StreamFocusStateChangedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class StreamFocusStateChangedEventArgs : EventArgs { internal StreamFocusStateChangedEventArgs(AudioStreamFocusOptions options, @@ -36,18 +37,21 @@ namespace Tizen.Multimedia /// Gets the focus options. /// /// The focus options. + /// 4 public AudioStreamFocusOptions FocusOptions { get; } /// /// Gets the changed focus state. /// /// The focus state. + /// 4 public AudioStreamFocusState FocusState { get; } /// /// Gets the reason for state change of the focus. /// /// The reason for state change of the focus. + /// 4 public AudioStreamFocusChangedReason Reason { get; } /// @@ -59,6 +63,7 @@ namespace Tizen.Multimedia /// /// /// + /// 4 public string ExtraInfo { get; } } } diff --git a/src/Tizen.Multimedia/AudioManager/VolumeChangedEventArgs.cs b/src/Tizen.Multimedia/AudioManager/VolumeChangedEventArgs.cs index aa4b901..df3a4fc 100755 --- a/src/Tizen.Multimedia/AudioManager/VolumeChangedEventArgs.cs +++ b/src/Tizen.Multimedia/AudioManager/VolumeChangedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides data for the event. /// + /// 3 public class VolumeChangedEventArgs : EventArgs { internal VolumeChangedEventArgs(AudioVolumeType type, uint level) @@ -33,12 +34,14 @@ namespace Tizen.Multimedia /// Gets the sound type that volume is changed. /// /// The sound type that volume is changed. + /// 3 public AudioVolumeType Type { get; } /// /// Gets the new volume level. /// /// The new volume level. + /// 3 public int Level { get; } } } diff --git a/src/Tizen.Multimedia/AudioManager/VolumeLevel.cs b/src/Tizen.Multimedia/AudioManager/VolumeLevel.cs index 6225d82..6ce27d3 100644 --- a/src/Tizen.Multimedia/AudioManager/VolumeLevel.cs +++ b/src/Tizen.Multimedia/AudioManager/VolumeLevel.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides a means to control volume levels. /// + /// 3 public class VolumeLevel { internal VolumeLevel() @@ -43,6 +44,7 @@ namespace Tizen.Multimedia /// is greater than . /// /// The caller does not have required privilege to set volume. + /// 3 public int this[AudioVolumeType type] { get diff --git a/src/Tizen.Multimedia/Common/CodecNotSupportedException.cs b/src/Tizen.Multimedia/Common/CodecNotSupportedException.cs index f5757fd..9684be1 100644 --- a/src/Tizen.Multimedia/Common/CodecNotSupportedException.cs +++ b/src/Tizen.Multimedia/Common/CodecNotSupportedException.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Specifies whether a codec is an audio codec or a video codec. /// + /// 3 public enum CodecKind { /// @@ -38,12 +39,14 @@ namespace Tizen.Multimedia /// The exception that is thrown when the codec for an input file or a data stream is not supported /// or the input is malformed. /// + /// 3 public class CodecNotSupportedException : InvalidOperationException { /// /// Initializes a new instance of the class /// with indicating which codec is not supported. /// + /// 3 public CodecNotSupportedException(CodecKind kind) { CodecKind = kind; @@ -53,6 +56,7 @@ namespace Tizen.Multimedia /// Initializes a new instance of the class with /// indicating which codec is not supported and a specified error message. /// + /// 3 public CodecNotSupportedException(CodecKind kind, string message) : base(message) { CodecKind = kind; @@ -61,6 +65,7 @@ namespace Tizen.Multimedia /// /// Gets the of the exception. /// + /// 3 public CodecKind CodecKind { get; } } } diff --git a/src/Tizen.Multimedia/Common/ColorSpace.cs b/src/Tizen.Multimedia/Common/ColorSpace.cs index 1d0f598..502b8a0 100644 --- a/src/Tizen.Multimedia/Common/ColorSpace.cs +++ b/src/Tizen.Multimedia/Common/ColorSpace.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia /// /// Specifies color spaces for Tizen.Multimedia. /// + /// 3 public enum ColorSpace { /// diff --git a/src/Tizen.Multimedia/Common/Display.cs b/src/Tizen.Multimedia/Common/Display.cs index 6cf2769..dc1b0a3 100644 --- a/src/Tizen.Multimedia/Common/Display.cs +++ b/src/Tizen.Multimedia/Common/Display.cs @@ -90,6 +90,7 @@ namespace Tizen.Multimedia /// /// /// + /// 3 public class Display { private readonly IDisplaySetter _setter; @@ -100,6 +101,7 @@ namespace Tizen.Multimedia /// A to display. /// http://tizen.org/feature/multimedia.raw_video /// The required feature is not supported. + /// 3 public Display(MediaView mediaView) { ValidationUtil.ValidateFeatureSupported(Features.RawVideo); @@ -116,6 +118,7 @@ namespace Tizen.Multimedia /// Initializes a new instance of the class with a class. /// /// A to display. + /// 3 public Display(Window window) { if (window == null) @@ -134,6 +137,7 @@ namespace Tizen.Multimedia /// The must be /// for the to be rendered correctly. /// + /// 3 public Display(NUI.Window window) { if (window == null) diff --git a/src/Tizen.Multimedia/Common/FileFormatException.cs b/src/Tizen.Multimedia/Common/FileFormatException.cs index 94e9b16..b0b5689 100644 --- a/src/Tizen.Multimedia/Common/FileFormatException.cs +++ b/src/Tizen.Multimedia/Common/FileFormatException.cs @@ -22,11 +22,13 @@ namespace Tizen.Multimedia /// The exception that is thrown when an input file or a data stream that is supposed to conform /// to a certain file format specification, is malformed. /// + /// 3 public class FileFormatException : FormatException { /// /// Initializes a new instance of the class. /// + /// 3 public FileFormatException() { } @@ -34,6 +36,7 @@ namespace Tizen.Multimedia /// /// Initializes a new instance of the class with a specified error message. /// + /// 3 public FileFormatException(string message) : base(message) { } diff --git a/src/Tizen.Multimedia/Common/Flips.cs b/src/Tizen.Multimedia/Common/Flips.cs index 977be45..fa81d43 100644 --- a/src/Tizen.Multimedia/Common/Flips.cs +++ b/src/Tizen.Multimedia/Common/Flips.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Specifies the flip operation. /// + /// 4 [Flags] public enum Flips { diff --git a/src/Tizen.Multimedia/Common/IMediaBuffer.cs b/src/Tizen.Multimedia/Common/IMediaBuffer.cs index 1d5204b..e3d331f 100644 --- a/src/Tizen.Multimedia/Common/IMediaBuffer.cs +++ b/src/Tizen.Multimedia/Common/IMediaBuffer.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Provides functionality to read and write the media buffer. /// + /// 3 public interface IMediaBuffer { /// @@ -34,6 +35,7 @@ namespace Tizen.Multimedia /// /// The object that owns the current buffer has already been disposed of. /// The buffer is not available, i.e. not writable state. + /// 4 byte this[int index] { get; @@ -43,12 +45,14 @@ namespace Tizen.Multimedia /// /// Gets the size of the buffer, in bytes. /// + /// 4 int Length { get; } /// /// Gets the value indicating whether the is read-only. /// /// true if the is read-only; otherwise, false. + /// 4 bool IsReadOnly { get; } /// @@ -60,6 +64,7 @@ namespace Tizen.Multimedia /// is null. /// or is not valid. /// The object that owns the current buffer has already been disposed of. + /// 4 void CopyTo(byte[] dest, int startIndex, int length); /// @@ -73,6 +78,7 @@ namespace Tizen.Multimedia /// , , /// or is not valid. /// The object that owns the current buffer has already been disposed of. + /// 4 void CopyTo(byte[] dest, int startIndex, int length, int offset); /// @@ -85,6 +91,7 @@ namespace Tizen.Multimedia /// or is not valid. /// The object that owns the current buffer has already been disposed of. /// The buffer is not available. i.e. not writable state. + /// 3 void CopyFrom(byte[] source, int startIndex, int length); /// @@ -99,6 +106,7 @@ namespace Tizen.Multimedia /// or is not valid. /// The object that owns the current buffer has already been disposed of. /// The buffer is not available. i.e. not writable state. + /// 3 void CopyFrom(byte[] source, int startIndex, int length, int offset); } } diff --git a/src/Tizen.Multimedia/Common/Point.cs b/src/Tizen.Multimedia/Common/Point.cs index 4cca360..ee5f878 100644 --- a/src/Tizen.Multimedia/Common/Point.cs +++ b/src/Tizen.Multimedia/Common/Point.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Represents a point in the 2D space. /// + /// 3 public struct Point { @@ -29,6 +30,7 @@ namespace Tizen.Multimedia /// /// X-axis coordinate of the point in the 2D space. /// Y-axis coordinate of the point in the 2D space. + /// 3 public Point(int x, int y) { X = x; @@ -38,6 +40,7 @@ namespace Tizen.Multimedia /// /// Gets or sets the X-axis coordinate of the point in the 2D space. /// + /// 3 public int X { get; @@ -47,6 +50,7 @@ namespace Tizen.Multimedia /// /// Gets or sets the Y-axis coordinate of the point in the 2D space. /// + /// 3 public int Y { get; @@ -57,12 +61,14 @@ namespace Tizen.Multimedia /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() => $"X={X.ToString()}, Y={Y.ToString()}"; /// /// Gets the hash code for this instance of . /// /// The hash code for this instance of . + /// 3 public override int GetHashCode() { return new { X, Y }.GetHashCode(); @@ -73,6 +79,7 @@ namespace Tizen.Multimedia /// /// A to compare. /// true if the points are equal; otherwise, false. + /// 3 public override bool Equals(object obj) { return obj is Point && this == (Point)obj; @@ -84,6 +91,7 @@ namespace Tizen.Multimedia /// A to compare. /// A to compare. /// true if the two instances of are equal; otherwise false. + /// 3 public static bool operator ==(Point point1, Point point2) { return point1.X == point2.X && point1.Y == point2.Y; @@ -95,6 +103,7 @@ namespace Tizen.Multimedia /// A to compare. /// A to compare. /// true if the two instances of are not equal; otherwise false. + /// 3 public static bool operator !=(Point point1, Point point2) { return !(point1 == point2); diff --git a/src/Tizen.Multimedia/Common/Range.cs b/src/Tizen.Multimedia/Common/Range.cs index bcfc720..519033a 100644 --- a/src/Tizen.Multimedia/Common/Range.cs +++ b/src/Tizen.Multimedia/Common/Range.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Represents a range(min, max) value. /// + /// 3 public struct Range { /// @@ -29,6 +30,7 @@ namespace Tizen.Multimedia /// Minimum value of the range. /// Maximum value of the range. /// is less than . + /// 3 public Range(int min, int max) { if (min > max) @@ -42,6 +44,7 @@ namespace Tizen.Multimedia /// /// Gets or sets the minimum value of the range. /// + /// 3 public int Min { get; @@ -51,6 +54,7 @@ namespace Tizen.Multimedia /// /// Gets or sets the maximum value of the range. /// + /// 3 public int Max { get; @@ -60,6 +64,7 @@ namespace Tizen.Multimedia /// /// Gets the length of the range. /// + /// 3 public int Length => Max - Min; /// @@ -67,6 +72,7 @@ namespace Tizen.Multimedia /// /// The value to check. /// true if the value is within the range; otherwise false. + /// 3 public bool IsInside(int value) { return Min <= value && value <= Max; @@ -76,12 +82,14 @@ namespace Tizen.Multimedia /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() => $"Min={Min.ToString()}, Max={Max.ToString()}"; /// /// Gets the hash code for this instance of . /// /// The hash code for this instance of . + /// 3 public override int GetHashCode() { return new { Min, Max }.GetHashCode(); @@ -92,6 +100,7 @@ namespace Tizen.Multimedia /// /// A to compare. /// true if the two ranges are equal; otherwise, false. + /// 3 public override bool Equals(object obj) { return obj is Range && this == (Range)obj; @@ -103,6 +112,7 @@ namespace Tizen.Multimedia /// A to compare. /// A to compare. /// true if the two instances of are equal; otherwise false. + /// 3 public static bool operator ==(Range range1, Range range2) { return range1.Min == range2.Min && range1.Max == range2.Max; @@ -114,6 +124,7 @@ namespace Tizen.Multimedia /// A to compare. /// A to compare. /// true if the two instances of are not equal; otherwise false. + /// 3 public static bool operator !=(Range range1, Range range2) { return !(range1 == range2); diff --git a/src/Tizen.Multimedia/Common/Rectangle.cs b/src/Tizen.Multimedia/Common/Rectangle.cs index d7f537d..bf9cf5e 100644 --- a/src/Tizen.Multimedia/Common/Rectangle.cs +++ b/src/Tizen.Multimedia/Common/Rectangle.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia /// Represents the location of the object bounded by a rectangle defined by /// coordinates of top left corner, width and height. /// + /// 3 public struct Rectangle { private Point _location; @@ -34,6 +35,7 @@ namespace Tizen.Multimedia /// The y-coordinate of the upper-left corner of the rectangle. /// The Width of the rectangle. /// The Height of the rectangle. + /// 3 public Rectangle(int x, int y, int width, int height) : this(new Point(x, y), new Size(width, height)) { @@ -44,6 +46,7 @@ namespace Tizen.Multimedia /// /// A that represents the upper-left corner of the rectangular region. /// A that represents the width and height of the rectangular region. + /// 3 public Rectangle(Point location, Size size) { _location = location; @@ -53,6 +56,7 @@ namespace Tizen.Multimedia /// /// Gets or sets the coordinates of the upper-left corner of the rectangle. /// + /// 3 public Point Location { get { return _location; } @@ -62,6 +66,7 @@ namespace Tizen.Multimedia /// /// Gets or sets the x-coordinate of the upper-left corner of the rectangle. /// + /// 3 public int X { get { return _location.X; } @@ -71,6 +76,7 @@ namespace Tizen.Multimedia /// /// Gets or sets the y-coordinate of the upper-left corner of the rectangle. /// + /// 3 public int Y { get { return _location.Y; } @@ -80,6 +86,7 @@ namespace Tizen.Multimedia /// /// Gets or sets the width of the rectangle. /// + /// 3 public int Width { get { return _size.Width; } @@ -89,6 +96,7 @@ namespace Tizen.Multimedia /// /// Gets or sets the height of the rectangle. /// + /// 3 public int Height { get { return _size.Height; } @@ -98,26 +106,31 @@ namespace Tizen.Multimedia /// /// Gets the x-coordinate of the left edge of the rectangle. /// + /// 3 public int Left => X; /// /// Gets the y-coordinate of the top edge of the rectangle. /// + /// 3 public int Top => Y; /// /// Gets the x-coordinate of the right edge of the rectangle. /// + /// 3 public int Right => X + Width; /// /// Gets the y-coordinate of the bottom edge of the rectangle. /// + /// 3 public int Bottom => Y + Height; /// /// Gets or sets the size of the rectangle. /// + /// 3 public Size Size { get { return _size; } @@ -128,12 +141,14 @@ namespace Tizen.Multimedia /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() => $"{_location.ToString()}, {_size.ToString()}"; /// /// Gets the hash code for this instance of . /// /// The hash code for this instance of . + /// 3 public override int GetHashCode() { return new { Location, Size }.GetHashCode(); @@ -144,6 +159,7 @@ namespace Tizen.Multimedia /// /// A to compare. /// true if the rectangles are equal; otherwise, false. + /// 3 public override bool Equals(object obj) { return obj is Rectangle && this == (Rectangle)obj; @@ -155,6 +171,7 @@ namespace Tizen.Multimedia /// A to compare. /// A to compare. /// true if the two instances of are equal; otherwise false. + /// 3 public static bool operator ==(Rectangle rect1, Rectangle rect2) { return rect1.Location == rect2.Location && rect1.Size == rect2.Size; @@ -166,6 +183,7 @@ namespace Tizen.Multimedia /// A to compare. /// A to compare. /// true if the two instances of are not equal; otherwise false. + /// 3 public static bool operator !=(Rectangle rect1, Rectangle rect2) { return !(rect1 == rect2); diff --git a/src/Tizen.Multimedia/Common/Rotation.cs b/src/Tizen.Multimedia/Common/Rotation.cs index 78241b3..d690633 100644 --- a/src/Tizen.Multimedia/Common/Rotation.cs +++ b/src/Tizen.Multimedia/Common/Rotation.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia /// /// Specifies the directions of rotation. /// + /// 4 public enum Rotation { /// diff --git a/src/Tizen.Multimedia/Common/Size.cs b/src/Tizen.Multimedia/Common/Size.cs index 6545bc2..5e8ae48 100644 --- a/src/Tizen.Multimedia/Common/Size.cs +++ b/src/Tizen.Multimedia/Common/Size.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Represents a size in 2D space. /// + /// 3 public struct Size { /// @@ -28,6 +29,7 @@ namespace Tizen.Multimedia /// /// Width of the size. /// Height of the size. + /// 3 public Size(int width, int height) { Width = width; @@ -37,6 +39,7 @@ namespace Tizen.Multimedia /// /// Gets or sets the width. /// + /// 3 public int Width { get; @@ -46,6 +49,7 @@ namespace Tizen.Multimedia /// /// Gets or sets the height. /// + /// 3 public int Height { get; @@ -56,12 +60,14 @@ namespace Tizen.Multimedia /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() => $"Width={ Width.ToString() }, Height={ Height.ToString() }"; /// /// Gets the hash code for this instance of . /// /// The hash code for this instance of . + /// 3 public override int GetHashCode() { return new { Width, Height }.GetHashCode(); @@ -72,6 +78,7 @@ namespace Tizen.Multimedia /// /// A to compare. /// true if the two sizes are equal; otherwise, false. + /// 3 public override bool Equals(object obj) { return obj is Size && this == (Size)obj; @@ -83,6 +90,7 @@ namespace Tizen.Multimedia /// A to compare. /// A to compare. /// true if the two instances of are equal; otherwise false. + /// 3 public static bool operator ==(Size size1, Size size2) { return size1.Width == size2.Width && size1.Height == size2.Height; @@ -94,6 +102,7 @@ namespace Tizen.Multimedia /// A to compare. /// A to compare. /// true if the two instances of are not equal; otherwise false. + /// 3 public static bool operator !=(Size size1, Size size2) { return !(size1 == size2); diff --git a/src/Tizen.Multimedia/Common/Visibility.cs b/src/Tizen.Multimedia/Common/Visibility.cs index 97e6d07..768d8a1 100644 --- a/src/Tizen.Multimedia/Common/Visibility.cs +++ b/src/Tizen.Multimedia/Common/Visibility.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia /// /// Specifies visibilities. /// + /// 3 public enum Visibility { /// diff --git a/src/Tizen.Multimedia/MediaTool/AudioMediaFormat.cs b/src/Tizen.Multimedia/MediaTool/AudioMediaFormat.cs index e86383a..2abf1ae 100644 --- a/src/Tizen.Multimedia/MediaTool/AudioMediaFormat.cs +++ b/src/Tizen.Multimedia/MediaTool/AudioMediaFormat.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia /// /// Represents an audio media format. This class cannot be inherited. /// + /// 3 public sealed class AudioMediaFormat : MediaFormat { @@ -38,6 +39,7 @@ namespace Tizen.Multimedia /// /// , , , or is less than zero. /// + /// 3 public AudioMediaFormat(MediaFormatAudioMimeType mimeType, int channel, int sampleRate, int bit, int bitRate) : this(mimeType, channel, sampleRate, bit, bitRate, MediaFormatAacType.None) @@ -62,6 +64,7 @@ namespace Tizen.Multimedia /// /// , , , or is less than zero. /// + /// 3 public AudioMediaFormat(MediaFormatAudioMimeType mimeType, int channel, int sampleRate, int bit, int bitRate, MediaFormatAacType aacType) : base(MediaFormatType.Audio) @@ -221,37 +224,44 @@ namespace Tizen.Multimedia /// /// Gets the mime type of the current format. /// + /// 3 public MediaFormatAudioMimeType MimeType { get; } /// /// Gets the channel value of the current format. /// + /// 3 public int Channel { get; } /// /// Gets the sample rate value of the current format. /// + /// 3 public int SampleRate { get; } /// /// Gets the bit value of the current format. /// + /// 3 public int Bit { get; } /// /// Gets the bit rate value of the current format. /// + /// 3 public int BitRate { get; } /// /// Gets the AAC type of the current format. /// + /// 3 public MediaFormatAacType AacType { get; } /// /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() => $@"MimeType={ MimeType.ToString() }, Channel={ Channel.ToString() }, SampleRate= { SampleRate }, Bit={ Bit.ToString() }, BitRate={ BitRate.ToString() }, AacType={ AacType.ToString() }"; @@ -261,6 +271,7 @@ namespace Tizen.Multimedia /// /// A to compare. /// true if the formats are equal; otherwise, false. + /// 3 public override bool Equals(object obj) { var rhs = obj as AudioMediaFormat; @@ -277,6 +288,7 @@ namespace Tizen.Multimedia /// Gets the hash code for this instance of . /// /// The hash code for this instance of . + /// 3 public override int GetHashCode() => new { MimeType, Channel, SampleRate, Bit, BitRate }.GetHashCode(); } diff --git a/src/Tizen.Multimedia/MediaTool/ContainerMediaFormat.cs b/src/Tizen.Multimedia/MediaTool/ContainerMediaFormat.cs index 10946aa..f7e89c8 100644 --- a/src/Tizen.Multimedia/MediaTool/ContainerMediaFormat.cs +++ b/src/Tizen.Multimedia/MediaTool/ContainerMediaFormat.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia /// /// Represents a container media format. This class cannot be inherited. /// + /// 3 public sealed class ContainerMediaFormat : MediaFormat { /// @@ -29,6 +30,7 @@ namespace Tizen.Multimedia /// /// The mime type of the container format. /// is invalid (i.e. undefined value). + /// 3 public ContainerMediaFormat(MediaFormatContainerMimeType mimeType) : base(MediaFormatType.Container) { @@ -63,6 +65,7 @@ namespace Tizen.Multimedia /// /// Gets the mime type of the current format. /// + /// 3 public MediaFormatContainerMimeType MimeType { get; } internal override void AsNativeHandle(IntPtr handle) @@ -78,6 +81,7 @@ namespace Tizen.Multimedia /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() => $"MimeType={ MimeType.ToString() }"; /// @@ -85,6 +89,7 @@ namespace Tizen.Multimedia /// /// A to compare. /// true if the formats are equal; otherwise, false. + /// 3 public override bool Equals(object obj) { var rhs = obj as ContainerMediaFormat; @@ -100,6 +105,7 @@ namespace Tizen.Multimedia /// Gets the hash code for this instance of . /// /// The hash code for this instance of . + /// 3 public override int GetHashCode() => (int)MimeType; } diff --git a/src/Tizen.Multimedia/MediaTool/MediaFormat.cs b/src/Tizen.Multimedia/MediaTool/MediaFormat.cs index d6c51e2..15a383d 100755 --- a/src/Tizen.Multimedia/MediaTool/MediaFormat.cs +++ b/src/Tizen.Multimedia/MediaTool/MediaFormat.cs @@ -23,6 +23,7 @@ namespace Tizen.Multimedia /// /// MediaFormat is a base class for media formats. /// + /// 3 public abstract class MediaFormat { /// @@ -37,6 +38,7 @@ namespace Tizen.Multimedia /// /// Gets the type of the current format. /// + /// 3 public MediaFormatType Type { get; diff --git a/src/Tizen.Multimedia/MediaTool/MediaFormatAacType.cs b/src/Tizen.Multimedia/MediaTool/MediaFormatAacType.cs index 03ed369..4e5fb69 100644 --- a/src/Tizen.Multimedia/MediaTool/MediaFormatAacType.cs +++ b/src/Tizen.Multimedia/MediaTool/MediaFormatAacType.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia /// /// Specifies the AAC types for . /// + /// 3 public enum MediaFormatAacType { /// diff --git a/src/Tizen.Multimedia/MediaTool/MediaFormatMimeType.cs b/src/Tizen.Multimedia/MediaTool/MediaFormatMimeType.cs index 3fbeebf..df5b90a 100755 --- a/src/Tizen.Multimedia/MediaTool/MediaFormatMimeType.cs +++ b/src/Tizen.Multimedia/MediaTool/MediaFormatMimeType.cs @@ -20,6 +20,7 @@ namespace Tizen.Multimedia /// Specifies the media format types. /// /// + /// 3 public enum MediaFormatType { /// @@ -62,6 +63,7 @@ namespace Tizen.Multimedia /// /// Specifies the mime types for audio media formats. /// + /// 3 public enum MediaFormatAudioMimeType { /// @@ -143,6 +145,7 @@ namespace Tizen.Multimedia /// /// Specifies the mime types for video media formats. /// + /// 3 public enum MediaFormatVideoMimeType { /// @@ -285,6 +288,7 @@ namespace Tizen.Multimedia /// /// Specifies the mime types for container media formats. /// + /// 3 public enum MediaFormatContainerMimeType { /// @@ -346,6 +350,7 @@ namespace Tizen.Multimedia /// /// Specifies the text mime types. /// + /// 3 public enum MediaFormatTextMimeType { /// diff --git a/src/Tizen.Multimedia/MediaTool/MediaFormatTextType.cs b/src/Tizen.Multimedia/MediaTool/MediaFormatTextType.cs index a9673fc..72a7023 100755 --- a/src/Tizen.Multimedia/MediaTool/MediaFormatTextType.cs +++ b/src/Tizen.Multimedia/MediaTool/MediaFormatTextType.cs @@ -19,6 +19,7 @@ namespace Tizen.Multimedia /// /// Specifies the text types. /// + /// 3 public enum MediaFormatTextType { /// diff --git a/src/Tizen.Multimedia/MediaTool/MediaPacket.Lock.cs b/src/Tizen.Multimedia/MediaTool/MediaPacket.Lock.cs index e08eb8f..544011d 100644 --- a/src/Tizen.Multimedia/MediaTool/MediaPacket.Lock.cs +++ b/src/Tizen.Multimedia/MediaTool/MediaPacket.Lock.cs @@ -25,6 +25,7 @@ namespace Tizen.Multimedia /// /// Represents a packet for multimedia. /// + /// 3 public abstract partial class MediaPacket : IDisposable { private readonly LockState _lock = new LockState(); diff --git a/src/Tizen.Multimedia/MediaTool/MediaPacket.cs b/src/Tizen.Multimedia/MediaTool/MediaPacket.cs index e4890b8..db06a29 100644 --- a/src/Tizen.Multimedia/MediaTool/MediaPacket.cs +++ b/src/Tizen.Multimedia/MediaTool/MediaPacket.cs @@ -163,6 +163,7 @@ namespace Tizen.Multimedia /// /// Gets the media format of the current packet. /// + /// 3 public MediaFormat Format { get @@ -179,6 +180,7 @@ namespace Tizen.Multimedia /// /// The MediaPacket is not in the writable state, which means it is being used by another module. /// + /// 3 public ulong Pts { get @@ -210,6 +212,7 @@ namespace Tizen.Multimedia /// /// The MediaPacket is not in the writable state, which means it is being used by another module. /// + /// 3 public ulong Dts { get @@ -239,6 +242,7 @@ namespace Tizen.Multimedia /// /// true if the packet is the encoded type; otherwise, false. /// The MediaPacket has already been disposed of. + /// 3 public bool IsEncoded { get @@ -266,6 +270,7 @@ namespace Tizen.Multimedia /// The MediaPacket has already been disposed of. /// /// + /// 3 public IMediaBuffer Buffer { get @@ -292,6 +297,7 @@ namespace Tizen.Multimedia /// -or-
/// The MediaPacket is not in the writable state, which means it is being used by another module. /// + /// 3 public int BufferWrittenLength { get @@ -339,6 +345,7 @@ namespace Tizen.Multimedia /// The MediaPacket has already been disposed of. /// /// + /// 3 public MediaPacketVideoPlane[] VideoPlanes { get @@ -366,6 +373,7 @@ namespace Tizen.Multimedia /// /// The MediaPacket is not in the writable state, which means it is being used by another module. /// + /// 3 public MediaPacketBufferFlags BufferFlags { get @@ -398,6 +406,7 @@ namespace Tizen.Multimedia /// Gets a value indicating whether the packet has been disposed of. ///
/// true if the packet has been disposed of; otherwise, false. + /// 3 public bool IsDisposed => _isDisposed; private bool _isDisposed = false; @@ -409,6 +418,7 @@ namespace Tizen.Multimedia /// /// The MediaPacket can not be disposed, which means it is being used by another module. /// + /// 3 public void Dispose() { if (_isDisposed) @@ -427,6 +437,7 @@ namespace Tizen.Multimedia /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. /// + /// 3 protected virtual void Dispose(bool disposing) { if (_isDisposed) @@ -550,6 +561,7 @@ namespace Tizen.Multimedia ///
/// The media format for the new packet. /// A new MediaPacket object. + /// 3 public static MediaPacket Create(MediaFormat format) { return new SimpleMediaPacket(format); diff --git a/src/Tizen.Multimedia/MediaTool/MediaPacketBufferFlags.cs b/src/Tizen.Multimedia/MediaTool/MediaPacketBufferFlags.cs index 897d4b3..196fd86 100644 --- a/src/Tizen.Multimedia/MediaTool/MediaPacketBufferFlags.cs +++ b/src/Tizen.Multimedia/MediaTool/MediaPacketBufferFlags.cs @@ -24,6 +24,7 @@ namespace Tizen.Multimedia /// This enumeration has a attribute that allows a bitwise combination of its member values. /// ///
+ /// 3 [Flags] public enum MediaPacketBufferFlags { diff --git a/src/Tizen.Multimedia/MediaTool/MediaPacketVideoPlane.cs b/src/Tizen.Multimedia/MediaTool/MediaPacketVideoPlane.cs index 6ab1e9e..9a7c0f6 100644 --- a/src/Tizen.Multimedia/MediaTool/MediaPacketVideoPlane.cs +++ b/src/Tizen.Multimedia/MediaTool/MediaPacketVideoPlane.cs @@ -23,6 +23,7 @@ namespace Tizen.Multimedia /// Represents a video plane for the . /// This class is used if and only if the format of the packet is the raw video. ///
+ /// 3 public class MediaPacketVideoPlane { private readonly MediaPacket _packet; @@ -59,6 +60,7 @@ namespace Tizen.Multimedia /// Gets the buffer of the current video plane. ///
/// The MediaPacket that owns the current buffer has already been disposed of. + /// 3 public IMediaBuffer Buffer { get @@ -72,6 +74,7 @@ namespace Tizen.Multimedia /// Gets the stride width of the current video plane. ///
/// The MediaPacket that owns the current buffer has already been disposed of. + /// 3 public int StrideWidth { get @@ -85,6 +88,7 @@ namespace Tizen.Multimedia /// Gets the stride height of the current video plane. /// /// The MediaPacket that owns the current buffer has already been disposed of. + /// 3 public int StrideHeight { get diff --git a/src/Tizen.Multimedia/MediaTool/TextMediaFormat.cs b/src/Tizen.Multimedia/MediaTool/TextMediaFormat.cs index f8a7f85..19127e8 100644 --- a/src/Tizen.Multimedia/MediaTool/TextMediaFormat.cs +++ b/src/Tizen.Multimedia/MediaTool/TextMediaFormat.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia /// /// Represents a text media format. This class cannot be inherited. /// + /// 3 public sealed class TextMediaFormat : MediaFormat { /// @@ -33,6 +34,7 @@ namespace Tizen.Multimedia /// /// or is invalid (i.e. undefined value). /// + /// 3 public TextMediaFormat(MediaFormatTextMimeType mimeType, MediaFormatTextType textType) : base(MediaFormatType.Text) { @@ -105,17 +107,20 @@ namespace Tizen.Multimedia /// /// Gets the mime type of the current format. /// + /// 3 public MediaFormatTextMimeType MimeType { get; } /// /// Gets the text type of the current format. /// + /// 3 public MediaFormatTextType TextType { get; } /// /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() => $"MimeType={ MimeType.ToString() }, TextType={ TextType.ToString() }"; @@ -124,6 +129,7 @@ namespace Tizen.Multimedia /// /// A to compare. /// true if the formats are equal; otherwise, false. + /// 3 public override bool Equals(object obj) { var rhs = obj as TextMediaFormat; @@ -139,6 +145,7 @@ namespace Tizen.Multimedia /// Gets the hash code for this instance of . /// /// The hash code for this instance of . + /// 3 public override int GetHashCode() => new { MimeType, TextType }.GetHashCode(); } } diff --git a/src/Tizen.Multimedia/MediaTool/VideoMediaFormat.cs b/src/Tizen.Multimedia/MediaTool/VideoMediaFormat.cs index 22b1201..5125e9f 100644 --- a/src/Tizen.Multimedia/MediaTool/VideoMediaFormat.cs +++ b/src/Tizen.Multimedia/MediaTool/VideoMediaFormat.cs @@ -22,6 +22,7 @@ namespace Tizen.Multimedia /// /// Represents a video media format. This class cannot be inherited. /// + /// 3 public sealed class VideoMediaFormat : MediaFormat { private const int DefaultFrameRate = 0; @@ -35,6 +36,7 @@ namespace Tizen.Multimedia /// The height value of the format /// is invalid (i.e. undefined value). /// or is less than zero. + /// 3 public VideoMediaFormat(MediaFormatVideoMimeType mimeType, int width, int height) : this(mimeType, width, height, DefaultFrameRate) { @@ -47,6 +49,7 @@ namespace Tizen.Multimedia /// The size of the format. /// is invalid (i.e. undefined value). /// The width or the height of is less than zero. + /// 3 public VideoMediaFormat(MediaFormatVideoMimeType mimeType, Size size) : this(mimeType, size, DefaultFrameRate) { @@ -64,6 +67,7 @@ namespace Tizen.Multimedia /// /// , , or is less than zero. /// + /// 3 public VideoMediaFormat(MediaFormatVideoMimeType mimeType, int width, int height, int frameRate) : this(mimeType, width, height, frameRate, DefaultBitRate) { @@ -82,6 +86,7 @@ namespace Tizen.Multimedia /// -or-
/// is less than zero. /// + /// 3 public VideoMediaFormat(MediaFormatVideoMimeType mimeType, Size size, int frameRate) : this(mimeType, size, frameRate, DefaultBitRate) @@ -101,6 +106,7 @@ namespace Tizen.Multimedia /// /// , , , or is less than zero. /// + /// 3 public VideoMediaFormat(MediaFormatVideoMimeType mimeType, int width, int height, int frameRate, int bitRate) : this(mimeType, new Size(width, height), frameRate, bitRate) @@ -123,6 +129,7 @@ namespace Tizen.Multimedia /// -or-
/// is less than zero. /// + /// 3 public VideoMediaFormat(MediaFormatVideoMimeType mimeType, Size size, int frameRate, int bitRate) : base(MediaFormatType.Video) @@ -242,27 +249,32 @@ namespace Tizen.Multimedia /// /// Gets the mime type of the current format. /// + /// 3 public MediaFormatVideoMimeType MimeType { get; } /// /// Gets the size of the current format. /// + /// 3 public Size Size { get; } /// /// Gets the frame rate value of the current format. /// + /// 3 public int FrameRate { get; } /// /// Gets the bit rate value of the current format. /// + /// 3 public int BitRate { get; } /// /// Returns a string that represents the current object. /// /// A string that represents the current object. + /// 3 public override string ToString() => $@"MimeType={ MimeType.ToString() }, Size=({ Size.ToString() }), FrameRate= { FrameRate.ToString() }, BitRate={ BitRate.ToString() }"; @@ -272,6 +284,7 @@ namespace Tizen.Multimedia /// /// A to compare. /// true if the formats are equal; otherwise, false. + /// 3 public override bool Equals(object obj) { var rhs = obj as VideoMediaFormat; @@ -288,6 +301,7 @@ namespace Tizen.Multimedia /// Gets the hash code for this instance of . /// /// The hash code for this instance of . + /// 3 public override int GetHashCode() => new { MimeType, Size, FrameRate, BitRate }.GetHashCode(); } diff --git a/src/Tizen.Multimedia/MediaView/MediaView.cs b/src/Tizen.Multimedia/MediaView/MediaView.cs index 2cdd5b0..4131ae3 100755 --- a/src/Tizen.Multimedia/MediaView/MediaView.cs +++ b/src/Tizen.Multimedia/MediaView/MediaView.cs @@ -33,11 +33,13 @@ namespace Tizen.Multimedia /// var display = new Display((Tizen.Multimedia.MediaView)mediaView.NativeView); /// /// + /// 3 public class MediaView : EvasObject { /// /// This constructor is used by the infrastructure and is not intended to be used directly from application code. /// + /// 3 public MediaView(EvasObject parent) : base(parent) { } @@ -45,6 +47,7 @@ namespace Tizen.Multimedia /// /// This method is used by the infrastructure and is not intended to be used directly from application code. /// + /// 3 protected override IntPtr CreateHandle(EvasObject parent) { IntPtr evas = Interop.EvasObject.evas_object_evas_get(parent); diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAdapter.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAdapter.cs index 8566810..e82c7b9 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAdapter.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAdapter.cs @@ -24,6 +24,7 @@ namespace Tizen.Network.Bluetooth /// The BluetoothAdapter class is used to discover neighbouring bluetooth devices. /// /// http://tizen.org/privilege/bluetooth + /// 3 static public class BluetoothAdapter { /// @@ -31,6 +32,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled. + /// 3 static public bool IsBluetoothEnabled { get @@ -54,6 +56,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled. + /// 3 static public string Address { get @@ -77,6 +80,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled. + /// 3 static public string Name { get @@ -111,6 +115,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled. + /// 3 static public VisibilityMode Visibility { get @@ -134,6 +139,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled. + /// 3 static public bool IsDiscoveryInProgress { get @@ -157,6 +163,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled. + /// 3 static public int RemainingTimeAsVisible { get @@ -177,6 +184,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled. + /// 3 static public event EventHandler StateChanged { add @@ -208,6 +216,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled. + /// 3 static public event EventHandler NameChanged { add @@ -239,6 +248,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled. + /// 3 static public event EventHandler VisibilityModeChanged { add @@ -270,6 +280,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled. + /// 3 static public event EventHandler VisibilityDurationChanged { add @@ -301,6 +312,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled. + /// 3 static public event EventHandler DiscoveryStateChanged { add @@ -332,6 +344,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled. + /// 3 static public event EventHandler ScanResultChanged { add @@ -368,6 +381,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled /// or the start discovery fails. + /// 3 static public void StartDiscovery() { if (IsBluetoothEnabled) @@ -386,6 +400,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled or /// the discovery process is not is progress. + /// 3 static public void StopDiscovery() { if (IsDiscoveryInProgress) @@ -404,6 +419,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled /// or reading the Bonded devices list is failed. + /// 3 static public IEnumerable GetBondedDevices() { if (IsBluetoothEnabled) @@ -426,6 +442,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled /// or reading the bonded device information fails. + /// 3 static public BluetoothDevice GetBondedDevice(string address) { if (IsBluetoothEnabled) @@ -445,6 +462,7 @@ namespace Tizen.Network.Bluetooth /// The UUID of Service. /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled. + /// 3 static public bool IsServiceUsed(string serviceUuid) { try @@ -467,6 +485,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled /// or the read OObData procedure is failed. + /// 3 static public BluetoothOobData GetLocalOobData() { if (IsBluetoothEnabled && Globals.IsInitialize) @@ -490,6 +509,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled /// or the set OobData procedure is failed. + /// 3 static public void SetRemoteOobData(string address, BluetoothOobData oobData) { if (IsBluetoothEnabled && Globals.IsInitialize) @@ -508,6 +528,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled. /// or if the Remove Oobdata procedure is failed. + /// 3 static public void RemoveRemoteOobData(string address) { if (IsBluetoothEnabled && Globals.IsInitialize) @@ -525,6 +546,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled /// or the Start LE scan is failed. + /// 3 static public void StartLeScan() { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -551,6 +573,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled /// or the Stop LE scan is failed. + /// 3 static public void StopLeScan() { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -575,6 +598,7 @@ namespace Tizen.Network.Bluetooth /// The Bluetooth must be enabled before calling this API. /// /// The BluetoothLeAdvertiser instance. + /// 3 static public BluetoothLeAdvertiser GetBluetoothLeAdvertiser() { return BluetoothLeAdvertiser.Instance; @@ -591,6 +615,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled /// or the socket create error occurs. + /// 3 static public BluetoothServerSocket CreateServerSocket(string serviceUuid) { if (IsBluetoothEnabled && Globals.IsInitialize) @@ -613,6 +638,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled /// or the socket destroy error occurs. + /// 3 static public void DestroyServerSocket(BluetoothServerSocket socket) { if (IsBluetoothEnabled && Globals.IsInitialize) diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAudio.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAudio.cs index 640ff7b..8ff829d 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAudio.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAudio.cs @@ -23,6 +23,7 @@ namespace Tizen.Network.Bluetooth /// like headset, hands-free, and headphone. /// /// http://tizen.org/privilege/bluetooth + /// 3 public class BluetoothAudio : BluetoothProfile { internal BluetoothAudio() @@ -32,6 +33,7 @@ namespace Tizen.Network.Bluetooth /// /// The AudioConnectionStateChanged event is called when the audio connection state is changed. /// + /// 3 public event EventHandler AudioConnectionStateChanged { add @@ -56,6 +58,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled /// or when the connection attempt fails. + /// 3 public void Connect(BluetoothAudioProfileType profileType) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -85,6 +88,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled /// or when Disconnection attempt fails. + /// 3 public void Disconnect(BluetoothAudioProfileType type) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAvrcp.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAvrcp.cs index 09ae692..8605fef 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAvrcp.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothAvrcp.cs @@ -22,6 +22,7 @@ namespace Tizen.Network.Bluetooth /// This class is used to notify changes of the target device (For example, media player) to the control device (For example, headset). /// /// http://tizen.org/privilege/bluetooth + /// 3 public class BluetoothAvrcp : BluetoothProfile { internal BluetoothAvrcp() @@ -31,6 +32,7 @@ namespace Tizen.Network.Bluetooth /// /// The TargetConnectionStateChanged event is invoked when the connection state is changed. /// + /// 3 public event EventHandler TargetConnectionStateChanged { add @@ -46,6 +48,7 @@ namespace Tizen.Network.Bluetooth /// /// The EqualizerStateChanged event is invoked when the equalizer state is changed by the remote control device. /// + /// 3 public event EventHandler EqualizerStateChanged { add @@ -61,6 +64,7 @@ namespace Tizen.Network.Bluetooth /// /// The RepeatModeChanged event is invoked when the repeat mode is changed by the remote control device. /// + /// 3 public event EventHandler RepeatModeChanged { add @@ -76,6 +80,7 @@ namespace Tizen.Network.Bluetooth /// /// The ShuffleModeChanged event is invoked when the shuffle mode is changed by the remote control device. /// + /// 3 public event EventHandler ShuffleModeChanged { add @@ -91,6 +96,7 @@ namespace Tizen.Network.Bluetooth /// /// The ScanModeChanged event is invoked when the scan mode is changed by the remote control device. /// + /// 3 public event EventHandler ScanModeChanged { add @@ -113,6 +119,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled /// or when notifying the equalizer state to the remote device fails. + /// 3 public void NotifyEqualizerState(EqualizerState state) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -136,6 +143,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not enabled /// or when notifying the repeat mode state to the remote device fails. /// + /// 3 public void NotifyRepeatMode(RepeatMode mode) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -158,6 +166,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled /// or when notifying the shuffle mode state to the remote device fails. + /// 3 public void NotifyShuffleMode(ShuffleMode mode) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -180,6 +189,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled /// or when notifying the scan mode state to the remote device fails. + /// 3 public void NotifyScanMode(ScanMode mode) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -202,6 +212,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled /// or when notifying the player state to the remote device fails. + /// 3 public void NotifyPlayerState(PlayerState state) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -224,6 +235,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled /// or when notifying the current position state to the remote device fails. + /// 3 public void NotifyCurrentPosition(uint position) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -246,6 +258,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the Bluetooth is not supported. /// Thrown when the Bluetooth is not enabled /// or when notifying the shuffle track state to the remote device fails. + /// 3 public void NotifyTrack(Track trackData) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothData.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothData.cs index cf386c5..e3015d0 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothData.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothData.cs @@ -26,6 +26,7 @@ namespace Tizen.Network.Bluetooth /// /// This class is used to handle the device class types and the service. /// + /// 3 public class BluetoothClass { internal BluetoothMajorDeviceClassType MajorType; @@ -39,6 +40,7 @@ namespace Tizen.Network.Bluetooth /// /// The type of the major device class. /// + /// 3 public BluetoothMajorDeviceClassType MajorDeviceClassType { get @@ -49,6 +51,7 @@ namespace Tizen.Network.Bluetooth /// /// The type of the minor device class. /// + /// 3 public BluetoothMinorDeviceClassType MinorDeviceClassType { get @@ -59,6 +62,7 @@ namespace Tizen.Network.Bluetooth /// /// The major service class mask. /// + /// 3 public int MajorServiceClassMask { get @@ -71,11 +75,13 @@ namespace Tizen.Network.Bluetooth /// /// This class contains the information of the Bluetooth OOB data. /// + /// 3 public class BluetoothOobData { /// /// The default constructor. Initializes an object of the BluetoothOobData. /// + /// 3 public BluetoothOobData() { } @@ -83,6 +89,7 @@ namespace Tizen.Network.Bluetooth /// /// The hash value. /// + /// 3 public byte[] HashValue { get; @@ -91,6 +98,7 @@ namespace Tizen.Network.Bluetooth /// /// The randomizer value. /// + /// 3 public byte[] RandomizerValue { get; @@ -101,6 +109,7 @@ namespace Tizen.Network.Bluetooth /// /// This class contains the information of the Bluetooth device SDP data. /// + /// 3 public class BluetoothDeviceSdpData { internal string Address; @@ -113,6 +122,7 @@ namespace Tizen.Network.Bluetooth /// /// The device address. /// + /// 3 public string DeviceAddress { get @@ -123,6 +133,7 @@ namespace Tizen.Network.Bluetooth /// /// The service UUID. /// + /// 3 public IEnumerable ServiceUuid { get @@ -135,6 +146,7 @@ namespace Tizen.Network.Bluetooth /// /// This class contains the information of the Bluetooth device connection data. /// + /// 3 public class BluetoothDeviceConnectionData { internal string RemoteAddress; @@ -148,6 +160,7 @@ namespace Tizen.Network.Bluetooth /// /// The device address. /// + /// 3 public string Address { get @@ -158,6 +171,7 @@ namespace Tizen.Network.Bluetooth /// /// The type of the connection link. /// + /// 3 public BluetoothConnectionLinkType LinkType { get @@ -168,6 +182,7 @@ namespace Tizen.Network.Bluetooth /// /// The disconnect reason. /// + /// 3 public BluetoothDisconnectReason DisconnectReason { get @@ -180,11 +195,13 @@ namespace Tizen.Network.Bluetooth /// /// This class contains the information of the track data. /// + /// 3 public class Track { /// /// The default constructor. Initializes an object of the track. /// + /// 3 public Track() { } @@ -192,6 +209,7 @@ namespace Tizen.Network.Bluetooth /// /// The title of the track. /// + /// 3 public string Title { get; @@ -200,6 +218,7 @@ namespace Tizen.Network.Bluetooth /// /// The artist of the track. /// + /// 3 public string Artist { get; @@ -208,6 +227,7 @@ namespace Tizen.Network.Bluetooth /// /// The album of the track. /// + /// 3 public string Album { get; @@ -216,6 +236,7 @@ namespace Tizen.Network.Bluetooth /// /// The genre of the track. /// + /// 3 public string Genre { get; @@ -224,6 +245,7 @@ namespace Tizen.Network.Bluetooth /// /// The track number. /// + /// 3 public uint TrackNum { get; @@ -232,6 +254,7 @@ namespace Tizen.Network.Bluetooth /// /// The number of all tracks. /// + /// 3 public uint TotalTracks { get; @@ -240,6 +263,7 @@ namespace Tizen.Network.Bluetooth /// /// The duration of the track in milliseconds. /// + /// 3 public uint Duration { get; @@ -250,11 +274,13 @@ namespace Tizen.Network.Bluetooth /// /// This class contains the information of the manufacturer data. /// + /// 3 public class ManufacturerData { /// /// The default Constructor. Initializes an object of the ManufacturerData. /// + /// 3 public ManufacturerData() { } @@ -262,6 +288,7 @@ namespace Tizen.Network.Bluetooth /// /// The manufacturer ID. /// + /// 3 public int Id { get; @@ -270,6 +297,7 @@ namespace Tizen.Network.Bluetooth /// /// The length of the manufacturer data. /// + /// 3 public int DataLength { get; @@ -278,6 +306,7 @@ namespace Tizen.Network.Bluetooth /// /// The manufacturer data. /// + /// 3 public byte[] Data { get; @@ -327,11 +356,13 @@ namespace Tizen.Network.Bluetooth /// /// This class contains the information of the Bluetooth service data. /// + /// 3 public class BluetoothServiceData { /// /// The default constructor. Initializes an object of the BluetoothServiceData. /// + /// 3 public BluetoothServiceData() { } @@ -339,6 +370,7 @@ namespace Tizen.Network.Bluetooth /// /// The UUID of the service. /// + /// 3 public string Uuid { get; @@ -347,6 +379,7 @@ namespace Tizen.Network.Bluetooth /// /// The data length of the service data. /// + /// 3 public int DataLength { get; @@ -355,6 +388,7 @@ namespace Tizen.Network.Bluetooth /// /// The service data. /// + /// 3 public byte[] Data { get; @@ -365,6 +399,7 @@ namespace Tizen.Network.Bluetooth /// /// This class contains the service data information. /// + /// 3 public class BluetoothLeServiceData { internal string Uuid; @@ -378,6 +413,7 @@ namespace Tizen.Network.Bluetooth /// /// The Bluetooth LE service UUID. /// + /// 3 public string ServiceUuid { get @@ -388,6 +424,7 @@ namespace Tizen.Network.Bluetooth /// /// The Bluetooth LE service data. /// + /// 3 public byte[] ServiceData { get @@ -398,6 +435,7 @@ namespace Tizen.Network.Bluetooth /// /// The length of the service data. /// + /// 3 public int ServiceDataLength { get @@ -410,6 +448,7 @@ namespace Tizen.Network.Bluetooth /// /// This class contains the information of the socket data. /// + /// 3 public class SocketData { internal string RecvData; @@ -423,6 +462,7 @@ namespace Tizen.Network.Bluetooth /// /// The socket FD. /// + /// 3 public int SocketFd { get @@ -433,6 +473,7 @@ namespace Tizen.Network.Bluetooth /// /// The length of the received data. /// + /// 3 public int DataSize { get @@ -443,6 +484,7 @@ namespace Tizen.Network.Bluetooth /// /// The received data. /// + /// 3 public string Data { get @@ -455,6 +497,7 @@ namespace Tizen.Network.Bluetooth /// /// This class contains the information of the socket connection. /// + /// 3 public class SocketConnection { internal string Uuid; @@ -468,6 +511,7 @@ namespace Tizen.Network.Bluetooth /// /// The connected socket FD. /// + /// 3 public int SocketFd { get @@ -478,6 +522,7 @@ namespace Tizen.Network.Bluetooth /// /// The remote device address. /// + /// 3 public string Address { get @@ -488,6 +533,7 @@ namespace Tizen.Network.Bluetooth /// /// The service UUID. /// + /// 3 public string ServiceUuid { get diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothDevice.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothDevice.cs index 75c4c40..1a06057 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothDevice.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothDevice.cs @@ -28,6 +28,7 @@ namespace Tizen.Network.Bluetooth /// The BluetoothDevice class is used to search for services available on remote devices. /// /// http://tizen.org/privilege/bluetooth + /// 3 public class BluetoothDevice { private event EventHandler _bondCreated; @@ -62,6 +63,7 @@ namespace Tizen.Network.Bluetooth /// /// The address of the device. /// + /// 3 public string Address { get @@ -72,6 +74,7 @@ namespace Tizen.Network.Bluetooth /// /// The name of the device. /// + /// 3 public string Name { get @@ -82,6 +85,7 @@ namespace Tizen.Network.Bluetooth /// /// The strength indicator of received signal of the device. /// + /// 3 public int Rssi { get @@ -92,6 +96,7 @@ namespace Tizen.Network.Bluetooth /// /// The class of the device. /// + /// 3 public BluetoothClass Class { get @@ -102,6 +107,7 @@ namespace Tizen.Network.Bluetooth /// /// The service UUID list of the device. /// + /// 3 public IEnumerable ServiceUuidList { get @@ -112,6 +118,7 @@ namespace Tizen.Network.Bluetooth /// /// The number of services. /// + /// 3 public int ServiceCount { get @@ -122,6 +129,7 @@ namespace Tizen.Network.Bluetooth /// /// The paired state of the device. /// + /// 3 public bool IsPaired { get @@ -132,6 +140,7 @@ namespace Tizen.Network.Bluetooth /// /// The connection state of the device. /// + /// 3 public bool IsConnected { get @@ -142,6 +151,7 @@ namespace Tizen.Network.Bluetooth /// /// The authorization state of the device. /// + /// 3 public bool IsAuthorized { get @@ -152,6 +162,7 @@ namespace Tizen.Network.Bluetooth /// /// The Bluetooth appearance. /// + /// 3 public BluetoothAppearanceType AppearanceType { get @@ -163,6 +174,7 @@ namespace Tizen.Network.Bluetooth /// /// The length of the manufacturer data. /// + /// 3 public int ManufacturerDataLength { get @@ -173,6 +185,7 @@ namespace Tizen.Network.Bluetooth /// /// The manufacturer data. /// + /// 3 public string ManufacturerData { get @@ -184,6 +197,7 @@ namespace Tizen.Network.Bluetooth /// /// The BondCreated event is raised when the process of creating the bond is finished. /// + /// 3 public event EventHandler BondCreated { add @@ -207,6 +221,7 @@ namespace Tizen.Network.Bluetooth /// /// The BondDestroyed event is raised when the bond is destroyed. /// + /// 3 public event EventHandler BondDestroyed { add @@ -230,6 +245,7 @@ namespace Tizen.Network.Bluetooth /// /// The AuthorizationChanged event is raised when the authorization of the device is changed. /// + /// 3 public event EventHandler AuthorizationChanged { add @@ -253,6 +269,7 @@ namespace Tizen.Network.Bluetooth /// /// The ServiceSearched event is raised when the process of service searched is finished. /// + /// 3 public event EventHandler ServiceSearched { add @@ -276,6 +293,7 @@ namespace Tizen.Network.Bluetooth /// /// The ConnectionStateChanged event is raised when the connection state is changed. /// + /// 3 public event EventHandler ConnectionStateChanged { add @@ -438,6 +456,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the BT/BTLE is not enabled /// or when the create bonding process to the remote device fails. + /// 3 public void CreateBond() { if (BluetoothAdapter.IsBluetoothEnabled) @@ -459,6 +478,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the BT/BTLE is not enabled /// or when the cancel bonding procedure to remote device fails. + /// 3 public void CancelBonding() { int ret = Interop.Bluetooth.CancelBonding(); @@ -478,6 +498,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the BT/BTLE is not enabled /// or when the destroy bonding procedure fails. + /// 3 public void DestroyBond() { if (BluetoothAdapter.IsBluetoothEnabled) @@ -500,6 +521,7 @@ namespace Tizen.Network.Bluetooth /// The alias name of the remote device. /// Thrown when the BT/BTLE is not enabled /// or when the set alias name to remote device fails. + /// 3 public void SetAlias(string aliasName) { if (BluetoothAdapter.IsBluetoothEnabled) @@ -523,6 +545,7 @@ namespace Tizen.Network.Bluetooth /// The authorization state. /// Thrown when the BT/BTLE is not enabled /// or when the set authorization to remote device fails. + /// 3 public void SetAuthorization(BluetoothAuthorizationType authorizationState) { if (BluetoothAdapter.IsBluetoothEnabled) @@ -543,6 +566,7 @@ namespace Tizen.Network.Bluetooth /// The UUID list of the device. /// Thrown when the BT/BTLE is not enabled /// or when the get Mask from UUID fails. + /// 3 public BluetoothServiceClassType GetMaskFromUuid(string[] uuids) { BluetoothServiceClassType serviceMask; @@ -565,6 +589,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the BT/BTLE is not enabled /// or when the remote device service search fails. + /// 3 public void StartServiceSearch() { Log.Info(Globals.LogTag, "startservicesearch entry"); @@ -588,6 +613,7 @@ namespace Tizen.Network.Bluetooth /// The connected Bluetooth profiles. /// Thrown when the BT/BTLE is not enabled /// or when there is no BT connection. + /// 3 public IEnumerable GetConnectedProfiles() { if (BluetoothAdapter.IsBluetoothEnabled) @@ -625,6 +651,7 @@ namespace Tizen.Network.Bluetooth /// The Bluetooth profile type. /// Thrown when the BT/BTLE is not enabled /// or when there is no BT connection. + /// 3 public bool IsProfileConnected(BluetoothProfileType profileType) { if (BluetoothAdapter.IsBluetoothEnabled) @@ -649,6 +676,7 @@ namespace Tizen.Network.Bluetooth /// /// The Bluetooth must be enabled. /// + /// 3 public T GetProfile() where T : BluetoothProfile { /* @@ -690,6 +718,7 @@ namespace Tizen.Network.Bluetooth /// /// The IBluetoothClientSocket instance. /// The UUID of the service. + /// 3 public IBluetoothClientSocket CreateSocket(string serviceUuid) { BluetoothSocket clientSocket = new BluetoothSocket(); diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothEnumerations.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothEnumerations.cs index 1842de9..ac2fca9 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothEnumerations.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothEnumerations.cs @@ -22,6 +22,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth states. /// + /// 3 public enum BluetoothState { /// @@ -37,6 +38,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth errors. /// + /// 3 public enum BluetoothError { /// @@ -140,6 +142,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth visibility modes. /// + /// 3 public enum VisibilityMode { /// @@ -159,6 +162,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth major device class types. /// + /// 3 public enum BluetoothMajorDeviceClassType { /// @@ -210,6 +214,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth minor device class types. /// + /// 3 public enum BluetoothMinorDeviceClassType { /// @@ -541,6 +546,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth device discovery states. /// + /// 3 public enum BluetoothDeviceDiscoveryState { /// @@ -560,6 +566,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth appearance types. /// + /// 3 public enum BluetoothAppearanceType { /// @@ -583,6 +590,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth audio profile types. /// + /// 3 public enum BluetoothAudioProfileType { /// @@ -610,6 +618,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth service class types. /// + /// 3 public enum BluetoothServiceClassType { /// @@ -721,6 +730,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth profile types. /// + /// 3 public enum BluetoothProfileType { /// @@ -764,6 +774,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth authorization types. /// + /// 3 public enum BluetoothAuthorizationType { /// @@ -779,6 +790,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth connection link types. /// + /// 3 public enum BluetoothConnectionLinkType { /// @@ -798,6 +810,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth disconnect reason. /// + /// 3 public enum BluetoothDisconnectReason { /// @@ -821,6 +834,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the connected Bluetooth device event roles. /// + /// 3 public enum BluetoothSocketRole { /// @@ -840,6 +854,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth socket connection states. /// + /// 3 public enum BluetoothSocketState { /// @@ -855,6 +870,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the equalizer states. /// + /// 3 public enum EqualizerState { /// @@ -870,6 +886,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the repeat modes. /// + /// 3 public enum RepeatMode { /// @@ -893,6 +910,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the shuffle modes. /// + /// 3 public enum ShuffleMode { /// @@ -912,6 +930,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the scan modes. /// + /// 3 public enum ScanMode { /// @@ -931,6 +950,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the player states. /// + /// 3 public enum PlayerState { /// @@ -958,6 +978,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth LE device address types. /// + /// 3 public enum BluetoothLeDeviceAddressType { /// @@ -973,6 +994,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth LePacket types. /// + /// 3 public enum BluetoothLePacketType { /// @@ -988,6 +1010,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth LE data types. /// + /// 3 public enum BluetoothLeDataType { /// @@ -1003,6 +1026,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth LE advertising mode types. /// + /// 3 public enum BluetoothLeAdvertisingMode { /// @@ -1022,6 +1046,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth LE advertising mode type. /// + /// 3 public enum BluetoothLeAdvertisingState { /// @@ -1037,6 +1062,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the integer type for GATT handle's values. /// + /// 3 public enum IntDataType { /// @@ -1068,6 +1094,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumerations of the float type for GATT handle's values. /// + /// 3 public enum FloatDataType { /// @@ -1083,6 +1110,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the GATT handle's types. /// + /// 3 public enum GattHandleType { /// @@ -1102,6 +1130,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the service types. /// + /// 3 public enum BluetoothGattServiceType { /// @@ -1117,6 +1146,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the characteristic's property. /// + /// 3 [Flags] public enum BluetoothGattProperty { @@ -1157,6 +1187,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the Bluetooth GATT permission types. /// + /// 3 [Flags] public enum BluetoothGattPermission { @@ -1173,6 +1204,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the write types. /// + /// 3 public enum BluetoothGattWriteType { /// @@ -1188,6 +1220,7 @@ namespace Tizen.Network.Bluetooth /// /// Enumeration for the remote device request types for attributes. /// + /// 3 public enum BluetoothGattRequestType { /// diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothEventArgs.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothEventArgs.cs index df91d91..1d621d9 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothEventArgs.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothEventArgs.cs @@ -22,6 +22,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the changed Bluetooth state. /// + /// 3 public class StateChangedEventArgs : EventArgs { private BluetoothState _type; @@ -36,6 +37,7 @@ namespace Tizen.Network.Bluetooth /// /// The state of Bluetooth. /// + /// 3 public BluetoothState BTState { get @@ -47,6 +49,7 @@ namespace Tizen.Network.Bluetooth /// /// The BluetoothError result. /// + /// 3 public BluetoothError Result { get @@ -59,6 +62,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the changed Bluetooth name. /// + /// 3 public class NameChangedEventArgs : EventArgs { private string _name; @@ -71,6 +75,7 @@ namespace Tizen.Network.Bluetooth /// /// The name of the device. /// + /// 3 public string DeviceName { get @@ -83,6 +88,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the changed Bluetooth visibility mode. /// + /// 3 public class VisibilityModeChangedEventArgs : EventArgs { private VisibilityMode _mode; @@ -97,6 +103,7 @@ namespace Tizen.Network.Bluetooth /// /// The visibility mode. /// + /// 3 public VisibilityMode Visibility { get @@ -108,6 +115,7 @@ namespace Tizen.Network.Bluetooth /// /// The BluetoothError result. /// + /// 3 public BluetoothError Result { get @@ -120,6 +128,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the duration until the visibility mode is changed from TimeLimitedDiscoverable to NonDiscoverable. /// + /// 3 public class VisibilityDurationChangedEventArgs : EventArgs { private int _duration; @@ -132,6 +141,7 @@ namespace Tizen.Network.Bluetooth /// /// The duration. /// + /// 3 public int Duration { get @@ -144,6 +154,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the changed Bluetooth device discovery state and the discovered device information. /// + /// 3 public class DiscoveryStateChangedEventArgs : EventArgs { private BluetoothError _result; @@ -166,6 +177,7 @@ namespace Tizen.Network.Bluetooth /// /// The BluetoothError result. /// + /// 3 public BluetoothError Result { get @@ -177,6 +189,7 @@ namespace Tizen.Network.Bluetooth /// /// The state of the discovery. /// + /// 3 public BluetoothDeviceDiscoveryState DiscoveryState { get @@ -188,6 +201,7 @@ namespace Tizen.Network.Bluetooth /// /// The remote device found. /// + /// 3 public BluetoothDevice DeviceFound { get @@ -200,6 +214,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the bonded device information. /// + /// 3 public class BondCreatedEventArgs : EventArgs { private BluetoothError _result; @@ -214,6 +229,7 @@ namespace Tizen.Network.Bluetooth /// /// The BluetoothError result. /// + /// 3 public BluetoothError Result { get @@ -225,6 +241,7 @@ namespace Tizen.Network.Bluetooth /// /// The remote device. /// + /// 3 public BluetoothDevice Device { get @@ -237,6 +254,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the address of the remote Bluetooth device to destroy bond with. /// + /// 3 public class BondDestroyedEventArgs : EventArgs { private BluetoothError _result; @@ -251,6 +269,7 @@ namespace Tizen.Network.Bluetooth /// /// The BluetoothError result. /// + /// 3 public BluetoothError Result { get @@ -263,6 +282,7 @@ namespace Tizen.Network.Bluetooth /// The remote device address. /// /// The device address. + /// 3 public string DeviceAddress { get @@ -275,6 +295,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the authorization state and the address of the remote Bluetooth device. /// + /// 3 public class AuthorizationChangedEventArgs : EventArgs { private BluetoothAuthorizationType _authType; @@ -289,6 +310,7 @@ namespace Tizen.Network.Bluetooth /// /// The authorization. /// + /// 3 public BluetoothAuthorizationType Authorization { get @@ -300,6 +322,7 @@ namespace Tizen.Network.Bluetooth /// /// The device address. /// + /// 3 public string DeviceAddress { get @@ -313,6 +336,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the service lists found on the remote Bluetooth device. /// + /// 3 public class ServiceSearchedEventArgs : EventArgs { private BluetoothDeviceSdpData _sdpData; @@ -327,6 +351,7 @@ namespace Tizen.Network.Bluetooth /// /// The BluetoothError result. /// + /// 3 public BluetoothError Result { get @@ -337,6 +362,7 @@ namespace Tizen.Network.Bluetooth /// /// The sdp data. /// + /// 3 public BluetoothDeviceSdpData SdpData { get @@ -349,6 +375,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the connection state and the connection information of the remote device. /// + /// 3 public class DeviceConnectionStateChangedEventArgs : EventArgs { private bool _isConnected; @@ -363,6 +390,7 @@ namespace Tizen.Network.Bluetooth /// /// A value indicating whether the device is connected. /// + /// 3 public bool IsConnected { get @@ -374,6 +402,7 @@ namespace Tizen.Network.Bluetooth /// /// The device connection data. /// + /// 3 public BluetoothDeviceConnectionData ConnectionData { get @@ -386,6 +415,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the data received information. /// + /// 3 public class SocketDataReceivedEventArgs : EventArgs { private SocketData _data; @@ -398,6 +428,7 @@ namespace Tizen.Network.Bluetooth /// /// The socket data. /// + /// 3 public SocketData Data { get @@ -410,6 +441,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the changed connection state. /// + /// 3 public class SocketConnectionStateChangedEventArgs : EventArgs { private BluetoothError _result; @@ -426,6 +458,7 @@ namespace Tizen.Network.Bluetooth /// /// The BluetoothError result. /// + /// 3 public BluetoothError Result { get @@ -437,6 +470,7 @@ namespace Tizen.Network.Bluetooth /// /// The socket state. /// + /// 3 public BluetoothSocketState State { get @@ -448,6 +482,7 @@ namespace Tizen.Network.Bluetooth /// /// The socket connection. /// + /// 3 public SocketConnection Connection { get @@ -460,6 +495,7 @@ namespace Tizen.Network.Bluetooth /// /// The AcceptStateChanged event is raised when the socket connection state is changed. /// + /// 3 public class AcceptStateChangedEventArgs : EventArgs { private BluetoothError _result; @@ -478,6 +514,7 @@ namespace Tizen.Network.Bluetooth /// /// The BluetoothError result. /// + /// 3 public BluetoothError Result { get @@ -489,6 +526,7 @@ namespace Tizen.Network.Bluetooth /// /// The socket state. /// + /// 3 public BluetoothSocketState State { get @@ -500,6 +538,7 @@ namespace Tizen.Network.Bluetooth /// /// The socket connection. /// + /// 3 public SocketConnection Connection { get @@ -511,6 +550,7 @@ namespace Tizen.Network.Bluetooth /// /// The server socket instance. /// + /// 3 public IBluetoothServerSocket Server { get @@ -523,6 +563,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the connection state, remote address, and the type of audio profile. /// + /// 3 public class AudioConnectionStateChangedEventArgs : EventArgs { private int _result; @@ -541,6 +582,7 @@ namespace Tizen.Network.Bluetooth /// /// The result. /// + /// 3 public int Result { get @@ -552,6 +594,7 @@ namespace Tizen.Network.Bluetooth /// /// A value indicating whether this instance is connected. /// + /// 3 public bool IsConnected { get @@ -563,6 +606,7 @@ namespace Tizen.Network.Bluetooth /// /// The address. /// + /// 3 public string Address { get @@ -574,6 +618,7 @@ namespace Tizen.Network.Bluetooth /// /// The type of the audio profile. /// + /// 3 public BluetoothAudioProfileType ProfileType { get @@ -586,6 +631,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the connection state and the address of the remote Bluetooth device. /// + /// 3 public class HidConnectionStateChangedEventArgs : EventArgs { private int _result; @@ -602,6 +648,7 @@ namespace Tizen.Network.Bluetooth /// /// The result. /// + /// 3 public int Result { get @@ -613,6 +660,7 @@ namespace Tizen.Network.Bluetooth /// /// A value indicating whether this instance is connected. /// + /// 3 public bool IsConnected { get @@ -624,6 +672,7 @@ namespace Tizen.Network.Bluetooth /// /// The address. /// + /// 3 public string Address { get @@ -636,6 +685,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the changed equalizer state. /// + /// 3 public class EqualizerStateChangedEventArgs : EventArgs { private EqualizerState _state; @@ -648,6 +698,7 @@ namespace Tizen.Network.Bluetooth /// /// The state of the equalizer. /// + /// 3 public EqualizerState State { get @@ -660,6 +711,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the changed repeat mode. /// + /// 3 public class RepeatModeChangedEventArgs : EventArgs { private RepeatMode _mode; @@ -672,6 +724,7 @@ namespace Tizen.Network.Bluetooth /// /// The repeat mode. /// + /// 3 public RepeatMode Mode { get @@ -684,6 +737,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the changed shuffle mode. /// + /// 3 public class ShuffleModeChangedeventArgs : EventArgs { private ShuffleMode _mode; @@ -696,6 +750,7 @@ namespace Tizen.Network.Bluetooth /// /// The shuffle mode. /// + /// 3 public ShuffleMode Mode { get @@ -708,6 +763,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the changed scan mode. /// + /// 3 public class ScanModeChangedEventArgs : EventArgs { private ScanMode _mode; @@ -720,6 +776,7 @@ namespace Tizen.Network.Bluetooth /// /// The scan mode. /// + /// 3 public ScanMode Mode { get @@ -732,6 +789,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the connection state and the remote device address. /// + /// 3 public class TargetConnectionStateChangedEventArgs : EventArgs { private bool _isConnected; @@ -746,6 +804,7 @@ namespace Tizen.Network.Bluetooth /// /// A value indicating whether this instance is connected. /// + /// 3 public bool IsConnected { get @@ -757,6 +816,7 @@ namespace Tizen.Network.Bluetooth /// /// The address. /// + /// 3 public string Address { get @@ -769,6 +829,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the changed Bluetooth LE advertising state changed information. /// + /// 3 public class AdvertisingStateChangedEventArgs : EventArgs { private BluetoothLeAdvertisingState _state; @@ -787,6 +848,7 @@ namespace Tizen.Network.Bluetooth /// /// The result. /// + /// 3 public int Result { get @@ -798,6 +860,7 @@ namespace Tizen.Network.Bluetooth /// /// The advertiser handle. /// + /// 3 public IntPtr AdvertiserHandle { get @@ -809,6 +872,7 @@ namespace Tizen.Network.Bluetooth /// /// The LE advertising state. /// + /// 3 public BluetoothLeAdvertisingState State { get @@ -821,6 +885,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the changed Bluetooth LE scan result information. /// + /// 3 public class AdapterLeScanResultChangedEventArgs : EventArgs { private BluetoothLeDevice _deviceData; @@ -835,6 +900,7 @@ namespace Tizen.Network.Bluetooth /// /// The result. /// + /// 3 public BluetoothError Result { get @@ -846,6 +912,7 @@ namespace Tizen.Network.Bluetooth /// /// The LE device data. /// + /// 3 public BluetoothLeDevice DeviceData { get @@ -858,6 +925,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the changed Bluetooth LE GATT connection state. /// + /// 3 public class GattConnectionStateChangedEventArgs : EventArgs { private bool _isConnected; @@ -874,6 +942,7 @@ namespace Tizen.Network.Bluetooth /// /// The result. /// + /// 3 public int Result { get @@ -885,6 +954,7 @@ namespace Tizen.Network.Bluetooth /// /// A value indicating whether this instance is connected. /// + /// 3 public bool IsConnected { get @@ -896,6 +966,7 @@ namespace Tizen.Network.Bluetooth /// /// The remote address. /// + /// 3 public string RemoteAddress { get @@ -908,6 +979,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class contains the changed attribute value. /// + /// 3 public class ValueChangedEventArgs : EventArgs { internal ValueChangedEventArgs(byte[] value) @@ -918,12 +990,14 @@ namespace Tizen.Network.Bluetooth /// /// The attribute value. /// + /// 3 public byte[] Value { get; } } /// /// An extended EventArgs class contains the read value request data. /// + /// 3 public class ReadRequestedEventArgs : EventArgs { internal ReadRequestedEventArgs(BluetoothGattServer server, string clientAddress, int requestId, int offset) @@ -937,24 +1011,29 @@ namespace Tizen.Network.Bluetooth /// /// The GATT server instance. /// + /// 3 public BluetoothGattServer Server { get; } /// /// The client address. /// + /// 3 public string ClientAddress { get; } /// /// The request identifier. /// + /// 3 public int RequestId { get; } /// /// The offset. /// + /// 3 public int Offset { get; } } /// /// An extended EventArgs class contains the read value request data. /// + /// 3 public class WriteRequestedEventArgs : EventArgs { internal WriteRequestedEventArgs(BluetoothGattServer server, string clientAddress, int requestId, byte[] value, int offset, bool response_needed) @@ -970,32 +1049,39 @@ namespace Tizen.Network.Bluetooth /// /// The GATT server instance. /// + /// 3 public BluetoothGattServer Server { get; } /// /// The client address. /// + /// 3 public string ClientAddress { get; } /// /// The request identifier. /// + /// 3 public int RequestId { get; } /// /// The read value. /// + /// 3 public byte[] Value { get; } /// /// The offset. /// + /// 3 public int Offset { get; } /// /// Indicates whether a response is required by the remote device. /// + /// 3 public bool Response_needed { get; } } /// /// An extended EventArgs class contains the client preference to enable or disable the Notification/Indication. /// + /// 3 public class NotificationStateChangedEventArg : EventArgs { internal NotificationStateChangedEventArg(BluetoothGattServer server, bool value) @@ -1007,16 +1093,19 @@ namespace Tizen.Network.Bluetooth /// /// The GATT server instance. /// + /// 3 public BluetoothGattServer Server { get; } /// /// A value indicating whether the notification is enabled. /// + /// 3 public bool Value { get; } } /// /// An extended EventArgs class contains the read value request data. /// + /// 3 public class NotificationSentEventArg : EventArgs { internal NotificationSentEventArg(BluetoothGattServer server, string clientAddress, int result, bool completed) @@ -1030,24 +1119,29 @@ namespace Tizen.Network.Bluetooth /// /// The GATT server instance. /// + /// 3 public BluetoothGattServer Server { get; } /// /// The client address. /// + /// 3 public string ClientAddress { get; } /// /// The result. /// + /// 3 public int Result { get; } /// /// Gets a value indicating whether the notification sent is completed. /// + /// 3 public bool Completed { get; } } /// /// An extended EventArgs class which contains the connection state and address of the remote Bluetooth device. /// + /// 4 public class ConnectionRequestedEventArgs : EventArgs { private string _address; @@ -1060,6 +1154,7 @@ namespace Tizen.Network.Bluetooth /// /// The address. /// + /// 4 public string Address { get @@ -1072,6 +1167,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class which contains the file transfer progress state, file transfer progress by percent. /// + /// 4 public class TransferProgressEventArgs : EventArgs { private string _file; @@ -1088,6 +1184,7 @@ namespace Tizen.Network.Bluetooth /// /// The File name. /// + /// 4 public string File { get @@ -1099,6 +1196,7 @@ namespace Tizen.Network.Bluetooth /// /// The File size. /// + /// 4 public long Size { get @@ -1110,6 +1208,7 @@ namespace Tizen.Network.Bluetooth /// /// The File transfer percent. /// + /// 4 public int Percent { get @@ -1122,6 +1221,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class which contains the file transfer finished state and file state. /// + /// 4 public class TransferFinishedEventArgs : EventArgs { private string _file; @@ -1138,6 +1238,7 @@ namespace Tizen.Network.Bluetooth /// /// The File name. /// + /// 4 public string File { get @@ -1149,6 +1250,7 @@ namespace Tizen.Network.Bluetooth /// /// The File size. /// + /// 4 public long Size { get @@ -1160,6 +1262,7 @@ namespace Tizen.Network.Bluetooth /// /// The return value. /// + /// 4 public int Result { get @@ -1172,6 +1275,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class which contains the Push Request respond state /// + /// 4 public class PushRespondedEventArgs : EventArgs { @@ -1187,6 +1291,7 @@ namespace Tizen.Network.Bluetooth /// /// The return value. /// + /// 4 public int Result { get @@ -1198,6 +1303,7 @@ namespace Tizen.Network.Bluetooth /// /// The address. /// + /// 4 public string Address { get @@ -1210,6 +1316,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class which contains the file push progress state, push progress by percent. /// + /// 4 public class PushProgressEventArgs : EventArgs { private string _file; @@ -1226,6 +1333,7 @@ namespace Tizen.Network.Bluetooth /// /// The File name. /// + /// 4 public string File { get @@ -1237,6 +1345,7 @@ namespace Tizen.Network.Bluetooth /// /// The File size. /// + /// 4 public long Size { get @@ -1248,6 +1357,7 @@ namespace Tizen.Network.Bluetooth /// /// The File transfer percent. /// + /// 4 public int Percent { get @@ -1260,6 +1370,7 @@ namespace Tizen.Network.Bluetooth /// /// An extended EventArgs class which contains the Push Request respond state /// + /// 4 public class PushFinishedEventArgs : EventArgs { @@ -1275,6 +1386,7 @@ namespace Tizen.Network.Bluetooth /// /// The return value. /// + /// 4 public int Result { get @@ -1286,6 +1398,7 @@ namespace Tizen.Network.Bluetooth /// /// The address. /// + /// 4 public string Address { get diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothGatt.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothGatt.cs index aa2077a..8084bed 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothGatt.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothGatt.cs @@ -25,6 +25,7 @@ namespace Tizen.Network.Bluetooth /// /// The Bluetooth GATT server. /// + /// 3 public class BluetoothGattServer { private static BluetoothGattServer _instance; @@ -37,6 +38,7 @@ namespace Tizen.Network.Bluetooth /// /// (event) This event is called when the indication acknowledgement is received for each notified client. /// + /// 3 public event EventHandler NotificationSent { add @@ -55,6 +57,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the BT/BTLE is not supported. /// Thrown when the create GATT server fails. + /// 3 public static BluetoothGattServer CreateServer() { if (_instance == null) @@ -73,6 +76,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the BT/BTLE is not supported. /// Thrown when the register server application fails. + /// 3 public void Start() { _impl.Start(); @@ -84,6 +88,7 @@ namespace Tizen.Network.Bluetooth /// The service, which needs to be registered with this server. /// Thrown when the BT/BTLE is not supported. /// Thrown when the register service fails. + /// 3 public void RegisterGattService(BluetoothGattService service) { if (service.IsRegistered()) @@ -102,6 +107,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the BT/BTLE is not supported. /// Thrown when the unregister service fails. + /// 3 public void UnregisterGattService(BluetoothGattService service) { if (service.GetGattServer() != this) @@ -120,6 +126,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the BT/BTLE is not supported. /// Thrown when the unregister all services fail. + /// 3 public void UnregisterGattServices() { _impl.UnregisterAllGattServices(this); @@ -130,6 +137,7 @@ namespace Tizen.Network.Bluetooth /// /// The UUID for the service to get. /// The Service with the given UUID if it exists, null otherwise. + /// 3 public BluetoothGattService GetService(string uuid) { return _impl.GetService(this, uuid); @@ -139,6 +147,7 @@ namespace Tizen.Network.Bluetooth /// Gets the list of services that belongs to this server. /// /// The list of services that belongs to this server. + /// 3 public IEnumerable GetServices() { return _impl.GetServices(this); @@ -151,6 +160,7 @@ namespace Tizen.Network.Bluetooth /// The remote device address to send, notify, or indicate and if set to NULL, then notify/indicate all is enabled. /// Thrown when the BT/BTLE is not enabled /// or when the remote device is disconnected, or when service is not registered, or when the CCCD is not enabled. + /// 3 public async Task SendIndicationAsync(BluetoothGattCharacteristic characteristic, string clientAddress) { return await _impl.SendIndicationAsync(this, characteristic, clientAddress); @@ -163,6 +173,7 @@ namespace Tizen.Network.Bluetooth /// The remote device address to send, notify, or indicate and if set to NULL, then notify/indicate all is enabled. /// Thrown when the BT/BTLE is not enabled /// or when the remote device is disconnected, or when service is not registered, or when the CCCD is not enabled. + /// 3 public void SendNotification(BluetoothGattCharacteristic characteristic, string clientAddress) { _impl.SendNotification(characteristic, clientAddress); @@ -178,6 +189,7 @@ namespace Tizen.Network.Bluetooth /// The offset from where the value is read. /// Thrown when the BT/BTLE is not enabled /// or when the remote device is disconnected, or the send response procedure fails. + /// 3 public void SendResponse(int requestId, BluetoothGattRequestType type, int status, byte[] value, int offset) { _impl.SendResponse(requestId, (int)type, status, value, offset); @@ -192,6 +204,7 @@ namespace Tizen.Network.Bluetooth /// /// The Bluetooth GATT client. /// + /// 3 public class BluetoothGattClient { private BluetoothGattClientImpl _impl; @@ -212,6 +225,7 @@ namespace Tizen.Network.Bluetooth /// /// Destroy Bluetooth GATT client /// + /// 3 public void DestroyClient() { _impl.GetHandle().Dispose(); @@ -222,6 +236,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the BT/BTLE is not enabled /// or when the remote device is disconnected. + /// 3 public string RemoteAddress { get @@ -241,6 +256,7 @@ namespace Tizen.Network.Bluetooth /// The service with the given UUID if it exists, null otherwise. /// Thrown when the BT/BTLE is not enabled /// or when the remote device is disconnected, or when the get service fails. + /// 3 public BluetoothGattService GetService(string uuid) { return _impl.GetService(this, uuid); @@ -252,6 +268,7 @@ namespace Tizen.Network.Bluetooth /// The list of services that belongs to the remote device. /// Thrown when the BT/BTLE is not enabled /// or when the remote device is disconnected, or when the get service fails. + /// 3 public IEnumerable GetServices() { return _impl.GetServices(this); @@ -264,6 +281,7 @@ namespace Tizen.Network.Bluetooth /// true on success, false otherwise. /// Thrown when the BT/BTLE is not enabled /// or when the remote device is disconnected, or when the read attribute value fails. + /// 3 public async Task ReadValueAsync(BluetoothGattCharacteristic characteristic) { return await _impl.ReadValueAsyncTask(characteristic.GetHandle()); @@ -276,6 +294,7 @@ namespace Tizen.Network.Bluetooth /// true on success, false otherwise. /// Thrown when the BT/BTLE is not enabled /// or when the remote device is disconnected, or when the read attribute value fails. + /// 3 public async Task ReadValueAsync(BluetoothGattDescriptor descriptor) { return await _impl.ReadValueAsyncTask(descriptor.GetHandle()); @@ -288,6 +307,7 @@ namespace Tizen.Network.Bluetooth /// true on success, false otherwise. /// Thrown when the BT/BTLE is not enabled /// or when the remote device is disconnected or when the write attribute value fails. + /// 3 public async Task WriteValueAsync(BluetoothGattCharacteristic characteristic) { return await _impl.WriteValueAsyncTask(characteristic.GetHandle()); @@ -300,6 +320,7 @@ namespace Tizen.Network.Bluetooth /// true on success, false otherwise. /// Thrown when the BT/BTLE is not enabled /// or when the remote device is disconnected, or when the write attribute value fails. + /// 3 public async Task WriteValueAsync(BluetoothGattDescriptor descriptor) { return await _impl.WriteValueAsyncTask(descriptor.GetHandle()); @@ -314,6 +335,7 @@ namespace Tizen.Network.Bluetooth /// /// The Bluetooth GATT service. /// + /// 3 public class BluetoothGattService { private BluetoothGattServiceImpl _impl; @@ -327,6 +349,7 @@ namespace Tizen.Network.Bluetooth /// The UUID of the service. /// The type of service. /// Thrown when the create GATT service procedure fails. + /// 3 public BluetoothGattService(string uuid, BluetoothGattServiceType type) { Uuid = uuid; @@ -342,6 +365,7 @@ namespace Tizen.Network.Bluetooth /// /// Specification name from the UUID. /// + /// 3 public string Uuid { get; } /// @@ -350,6 +374,7 @@ namespace Tizen.Network.Bluetooth /// The characteristic to be added. /// true on success, false otherwise. /// Thrown when the add GATT characteristic procedure fails. + /// 3 public void AddCharacteristic(BluetoothGattCharacteristic characteristic) { if (GetGattClient() != null) @@ -371,6 +396,7 @@ namespace Tizen.Network.Bluetooth /// /// The UUID for the characteristic to get. /// The characteristic with a given UUID if it exists, null otherwise. + /// 3 public BluetoothGattCharacteristic GetCharacteristic(string uuid) { return _impl.GetCharacteristic(this, uuid); @@ -380,6 +406,7 @@ namespace Tizen.Network.Bluetooth /// Gets list of the characteristic that belongs to this service. /// /// The list of the characteristic that belongs to this service. + /// 3 public IEnumerable GetCharacteristics() { return _impl.GetCharacteristics(this); @@ -391,6 +418,7 @@ namespace Tizen.Network.Bluetooth /// The service to be included. /// true on success, false otherwise /// Thrown when the add GATT service procedure fails./// + /// 3 public void AddService(BluetoothGattService service) { if (GetGattClient() != null) @@ -412,6 +440,7 @@ namespace Tizen.Network.Bluetooth /// /// The UUID for the service to get. /// The service with a given UUID if it exists, null otherwise. + /// 3 public BluetoothGattService GetIncludeService(string uuid) { return _impl.GetIncludeService(this, uuid); @@ -421,6 +450,7 @@ namespace Tizen.Network.Bluetooth /// Gets the included service list of this service. /// /// The included service list of this service. + /// 3 public IEnumerable GetIncludeServices() { return _impl.GetIncludeServices(this); @@ -430,6 +460,7 @@ namespace Tizen.Network.Bluetooth /// Gets the server instance which the specified service belongs to. /// /// The server instance which the specified service belongs to. + /// 3 public BluetoothGattServer GetGattServer() { return _parentServer; @@ -439,6 +470,7 @@ namespace Tizen.Network.Bluetooth /// Gets the client instance which the specified service belongs to. /// /// The client instance which the specified service belongs to. + /// 3 public BluetoothGattClient GetGattClient() { return _parentClient; @@ -492,6 +524,7 @@ namespace Tizen.Network.Bluetooth /// /// The Bluetooth GATT characteristic. /// + /// 3 public class BluetoothGattCharacteristic : BluetoothGattAttribute { private BluetoothGattCharacteristicImpl _impl; @@ -512,6 +545,7 @@ namespace Tizen.Network.Bluetooth /// The value associated with the characterstic. /// throws in case of internal error. /// Thrown when the create GATT characteristics procedure fails. + /// 3 public BluetoothGattCharacteristic(string uuid, BluetoothGattPermission permissions, BluetoothGattProperty properties, byte[] value) : base(uuid, permissions) { _impl = new BluetoothGattCharacteristicImpl(uuid, permissions, properties, value); @@ -528,6 +562,7 @@ namespace Tizen.Network.Bluetooth /// /// Adding the event handle on characteristic on the server side will not have any effect. /// + /// 3 public event EventHandler ValueChanged { add @@ -566,6 +601,7 @@ namespace Tizen.Network.Bluetooth /// /// Adding event handle on the characteristic on the client side will not have any effect. /// + /// 3 public event EventHandler NotificationStateChanged { add @@ -598,6 +634,7 @@ namespace Tizen.Network.Bluetooth /// /// The property for this characteristic. /// + /// 3 public BluetoothGattProperty Properties { get @@ -616,6 +653,7 @@ namespace Tizen.Network.Bluetooth /// /// The write type to be used for write operations. /// + /// 3 public BluetoothGattWriteType WriteType { get @@ -658,6 +696,7 @@ namespace Tizen.Network.Bluetooth /// The descriptor to be added. /// true on success, false otherwise. /// Thrown when the add GATT descriptor procedure fails. + /// 3 public void AddDescriptor(BluetoothGattDescriptor descriptor) { if (Client != null) @@ -679,6 +718,7 @@ namespace Tizen.Network.Bluetooth /// /// The UUID for the descriptor to get. /// The descriptor with a given UUID if it exists, null otherwise. + /// 3 public BluetoothGattDescriptor GetDescriptor(string uuid) { return _impl.GetDescriptor(this, uuid); @@ -688,6 +728,7 @@ namespace Tizen.Network.Bluetooth /// Gets the list of descriptors that belongs to this characteristic. /// /// The list of descriptors that belongs to this characteristic. + /// 3 public IEnumerable GetDescriptors() { return _impl.GetDescriptors(this); @@ -697,6 +738,7 @@ namespace Tizen.Network.Bluetooth /// Gets the service instance, which the specified characterstic belongs to. /// /// The characteristic instance, the specified characterstic belongs to. + /// 3 public BluetoothGattService GetService() { return _parent; @@ -715,6 +757,7 @@ namespace Tizen.Network.Bluetooth /// /// The Bluetooth GATT descriptor. /// + /// 3 public class BluetoothGattDescriptor : BluetoothGattAttribute { private BluetoothGattCharacteristic _parent = null; @@ -728,6 +771,7 @@ namespace Tizen.Network.Bluetooth /// The value associated with the descriptor. /// throws in case of internal error. /// Thrown when the create GATT descriptor procedure fails. + /// 3 public BluetoothGattDescriptor(string uuid, BluetoothGattPermission permisions, byte[] value) : base (uuid, permisions) { _impl = new BluetoothGattDescriptorImpl(uuid, permisions, value); @@ -766,6 +810,7 @@ namespace Tizen.Network.Bluetooth /// Gets the characteristic instance, which the specified descriptor belongs to. /// /// The characteristic instance, the specified descriptor belongs to. + /// 3 public BluetoothGattCharacteristic GetCharacteristic() { return _parent; @@ -784,6 +829,7 @@ namespace Tizen.Network.Bluetooth /// /// The Bluetooth GATT attribute. /// + /// 3 public abstract class BluetoothGattAttribute { private Interop.Bluetooth.BtGattServerReadValueRequestedCallback _readValueRequestedCallback; @@ -797,6 +843,7 @@ namespace Tizen.Network.Bluetooth /// /// The UUID of the GATT attribute. /// Permission for the GATT attribute. + /// 3 public BluetoothGattAttribute(string uuid, BluetoothGattPermission permission) { Uuid = uuid; @@ -809,6 +856,7 @@ namespace Tizen.Network.Bluetooth /// This event is called when the client request to read the value of a characteristic or a descriptor. /// /// Thrown when the set read value requested callback procedure fails. + /// 3 public event EventHandler ReadRequested { add @@ -836,6 +884,7 @@ namespace Tizen.Network.Bluetooth /// This event is called when a value of a characteristic or a descriptor has been changed by a client. /// /// Thrown when the set write value requested callback procedure fails. + /// 3 public event EventHandler WriteRequested { add @@ -862,16 +911,19 @@ namespace Tizen.Network.Bluetooth /// /// The attribute's UUID. /// + /// 3 public string Uuid { get; } /// /// Permissions for this attribute. /// + /// 3 public BluetoothGattPermission Permissions { get; } /// /// The value of this descriptor. /// + /// 3 public byte[] Value { get @@ -893,6 +945,7 @@ namespace Tizen.Network.Bluetooth /// /// /// The string value at specified offset. + /// 3 public string GetValue(int offset) { return Impl.GetValue(offset); @@ -903,6 +956,7 @@ namespace Tizen.Network.Bluetooth /// /// value to set /// Throws exception if the value is null. + /// 3 public void SetValue(string value) { if (string.IsNullOrEmpty(value)) @@ -919,6 +973,7 @@ namespace Tizen.Network.Bluetooth /// An offset in the attribute value buffer. /// The int value at given offset. /// Throws exception if (offset + size of int value) is greater than the length of the value buffer. + /// 3 public int GetValue(IntDataType type, int offset) { return Impl.GetValue(type, offset); @@ -931,6 +986,7 @@ namespace Tizen.Network.Bluetooth /// The value to set. /// An offset in the attribute value buffer. /// Throws exception if (offset + size of int value) is greater than the length of the value buffer. + /// 3 public void SetValue(IntDataType type, int value, int offset) { Impl.SetValue(type, value, offset); @@ -943,6 +999,7 @@ namespace Tizen.Network.Bluetooth /// An offset in the attribute value buffer. /// The float value at given offset. /// Throws exception if (offset + size of float value) is greater than the length of the value buffer. + /// 3 public float GetValue(FloatDataType type, int offset) { return Impl.GetValue(type, offset); @@ -956,6 +1013,7 @@ namespace Tizen.Network.Bluetooth /// An exponent of the float value. /// An offset in the attribute value buffer. /// Throws exception if (offset + size of float value) is greater than the length of the value buffer. + /// 3 public void SetValue(FloatDataType type, int mantissa, int exponent, int offset) { Impl.SetValue(type, mantissa, exponent, offset); diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothHid.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothHid.cs index a1fcf42..d93805e 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothHid.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothHid.cs @@ -6,6 +6,7 @@ namespace Tizen.Network.Bluetooth /// A class which is used to handle the connection to Bluetooth HID like keyboards and mouse. /// /// http://tizen.org/privilege/bluetooth + /// 3 public class BluetoothHid : BluetoothProfile { internal BluetoothHid() @@ -15,6 +16,7 @@ namespace Tizen.Network.Bluetooth /// /// The HidConnectionStateChanged event is called when the HID host connection state is changed. /// + /// 3 public event EventHandler HidConnectionStateChanged { add @@ -36,6 +38,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the Bluetooth is not enabled /// or when the connection attempt to the remote device fails. + /// 3 public void Connect() { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -58,6 +61,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the Bluetooth is not enabled /// or when the disconnection attempt to the remote device fails. + /// 3 public void Disconnect() { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothLeAdapter.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothLeAdapter.cs index 30183d2..91ca0ff 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothLeAdapter.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothLeAdapter.cs @@ -25,6 +25,7 @@ namespace Tizen.Network.Bluetooth { /// /// This is the BluetoothLeAdvertiser class. It handles the LE advertising operation amd callback. /// + /// 3 public class BluetoothLeAdvertiser { private static readonly BluetoothLeAdvertiser _instance = new BluetoothLeAdvertiser(); @@ -44,6 +45,7 @@ namespace Tizen.Network.Bluetooth { /// /// This event is called when the LE advertising state changes. /// + /// 3 public event EventHandler AdvertisingStateChanged { add @@ -64,6 +66,7 @@ namespace Tizen.Network.Bluetooth { /// The advertiser object carrying information of the advertising. /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled. + /// 3 public void StartAdvertising(BluetoothLeAdvertiseData advertiseData) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -89,6 +92,7 @@ namespace Tizen.Network.Bluetooth { /// The advertiser object carrying information of the advertising. /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled. + /// 3 public void StopAdvertising(BluetoothLeAdvertiseData advertiseData) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -110,6 +114,7 @@ namespace Tizen.Network.Bluetooth { /// This is the BluetoothLeDevice class. /// It handles the LE device operations like getting data from the scan result information. /// + /// 3 public class BluetoothLeDevice { //properties of Bluetoothlesacandata @@ -124,6 +129,7 @@ namespace Tizen.Network.Bluetooth { /// /// This event is called when the GATT client connects/disconnects with the server. /// + /// 3 public event EventHandler GattConnectionStateChanged { add @@ -179,6 +185,7 @@ namespace Tizen.Network.Bluetooth { /// /// The remote address. /// + /// 3 public string RemoteAddress { get @@ -190,6 +197,7 @@ namespace Tizen.Network.Bluetooth { /// /// The type of the address. /// + /// 3 public BluetoothLeDeviceAddressType AddressType { get @@ -201,6 +209,7 @@ namespace Tizen.Network.Bluetooth { /// /// The rssi value. /// + /// 3 public int Rssi { get @@ -212,6 +221,7 @@ namespace Tizen.Network.Bluetooth { /// /// The advertsing data information. /// + /// 3 public byte[] AdvertsingDataInformation { get @@ -223,6 +233,7 @@ namespace Tizen.Network.Bluetooth { /// /// The scan data information. /// + /// 3 public byte[] ScanDataInformation { get @@ -234,6 +245,7 @@ namespace Tizen.Network.Bluetooth { /// /// The type of the packet. /// + /// 3 public BluetoothLePacketType PacketType { get @@ -255,6 +267,7 @@ namespace Tizen.Network.Bluetooth { /// /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled. + /// 3 public IEnumerable ServiceUuid { get @@ -277,6 +290,7 @@ namespace Tizen.Network.Bluetooth { /// /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled. + /// 3 public string DeviceName { get @@ -298,6 +312,7 @@ namespace Tizen.Network.Bluetooth { /// /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled. + /// 3 public int TxPowerLevel { get @@ -319,6 +334,7 @@ namespace Tizen.Network.Bluetooth { /// /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled. + /// 3 public IEnumerable ServiceSolictationUuid { get @@ -339,6 +355,7 @@ namespace Tizen.Network.Bluetooth { /// /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled. + /// 3 public int Appearance { get @@ -359,6 +376,7 @@ namespace Tizen.Network.Bluetooth { /// /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled./// + /// 3 public ManufacturerData ManufacturerData { get @@ -380,6 +398,7 @@ namespace Tizen.Network.Bluetooth { /// Returns the service data list. /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled. + /// 3 public IEnumerable GetServiceDataList() { int serviceCount = 0; @@ -403,6 +422,7 @@ namespace Tizen.Network.Bluetooth { /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled /// or when the gatt connection attempt to remote device fails. + /// 3 public BluetoothGattClient GattConnect(bool autoConnect) { BluetoothGattClient client = null; @@ -433,6 +453,7 @@ namespace Tizen.Network.Bluetooth { /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled /// or when the GATT disconnection attempt to remote device fails. + /// 3 public void GattDisconnect() { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -452,6 +473,7 @@ namespace Tizen.Network.Bluetooth { /// /// Bluetooth LE advertise data. Handles the data advertising. /// + /// 3 public class BluetoothLeAdvertiseData:IDisposable { private IntPtr _handle = IntPtr.Zero; @@ -468,6 +490,7 @@ namespace Tizen.Network.Bluetooth { /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled /// or when create advertiser fails. + /// 3 public BluetoothLeAdvertiseData() { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -515,6 +538,7 @@ namespace Tizen.Network.Bluetooth { /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled /// or when the set advertising mode fails. + /// 3 public BluetoothLeAdvertisingMode AdvertisingMode { get @@ -544,6 +568,7 @@ namespace Tizen.Network.Bluetooth { /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled /// or when the set advertising connectable mode fails. + /// 3 public bool AdvertisingConnectable { get @@ -567,6 +592,7 @@ namespace Tizen.Network.Bluetooth { /// /// Dispose /// + /// 3 public void Dispose() { Dispose(true); @@ -581,6 +607,7 @@ namespace Tizen.Network.Bluetooth { /// /// The type of the packet. /// + /// 3 public BluetoothLePacketType PacketType { get @@ -602,6 +629,7 @@ namespace Tizen.Network.Bluetooth { /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled /// or when the set appearance fails. + /// 3 public int Appearance { get @@ -630,6 +658,7 @@ namespace Tizen.Network.Bluetooth { /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled /// or when the set advertising device name fails. + /// 3 public bool IncludeDeviceName { get @@ -661,6 +690,7 @@ namespace Tizen.Network.Bluetooth { /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled /// or when the set advertising TC power level fails. + /// 3 public bool IncludeTxPowerLevel { get @@ -693,6 +723,7 @@ namespace Tizen.Network.Bluetooth { /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled /// or when the add advertising service UUID procedure fails. + /// 3 public void AddAdvertisingServiceUuid(BluetoothLePacketType packetType, string serviceUuid) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -722,6 +753,7 @@ namespace Tizen.Network.Bluetooth { /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled /// or when the add advertising service solicitation UUID procedure fails. + /// 3 public void AddAdvertisingServiceSolicitationUuid(BluetoothLePacketType packetType, string serviceSolicitationUuid) { @@ -753,6 +785,7 @@ namespace Tizen.Network.Bluetooth { /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled /// or when the add advertising data procedure fails. + /// 3 public void AddAdvertisingServiceData(BluetoothLePacketType packetType, BluetoothServiceData data) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -789,6 +822,7 @@ namespace Tizen.Network.Bluetooth { /// Thrown when the Bluetooth LE is not supported. /// Thrown when the Bluetooth LE is not enabled /// or when the add advertising manufacturer data procedure fails. + /// 3 public void AddAdvertisingManufacturerData(BluetoothLePacketType packetType, ManufacturerData manufacturerData) { diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothOpp.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothOpp.cs index 4723987..5a4a379 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothOpp.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothOpp.cs @@ -23,6 +23,7 @@ namespace Tizen.Network.Bluetooth /// A class which is used to handle the connection and send and receive the object over Opp profile. /// /// http://tizen.org/privilege/bluetooth + /// 4 public class BluetoothOppServer { private static BluetoothOppServerImpl _impl; @@ -31,6 +32,7 @@ namespace Tizen.Network.Bluetooth /// /// The constructor /// + /// 4 public BluetoothOppServer() { _impl = BluetoothOppServerImpl.Instance; @@ -39,6 +41,7 @@ namespace Tizen.Network.Bluetooth /// /// (event) ConnectionRequested is called when OPP client requests for connection. /// + /// 4 public event EventHandler ConnectionRequested { add @@ -54,6 +57,7 @@ namespace Tizen.Network.Bluetooth /// /// (event) TransferProgress is called when the file transfer state is changed. /// + /// 4 public event EventHandler TransferProgress { add @@ -69,6 +73,7 @@ namespace Tizen.Network.Bluetooth /// /// (event) TransferFinished is called when the file tranfser is completed. /// + /// 4 public event EventHandler TransferFinished { add @@ -92,6 +97,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the required feature is not Supported. /// Thrown when the BT/BTLE is not Supported. /// Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors. + /// 4 public static BluetoothOppServer StartServer(string FilePath) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -124,6 +130,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the required feature is not Supported. /// Thrown when the BT/BTLE is not Supported. /// Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors. + /// 4 public void StopServer() { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -154,6 +161,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the required feature is not Supported. /// Thrown when the BT/BTLE is not Supported. /// Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors. + /// 4 public int AcceptPush(string FileName) { int _transitionId = -1; @@ -180,6 +188,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the required feature is not Supported. /// Thrown when the BT/BTLE is not Supported. /// Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors. + /// 4 public void RejectPush() { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -205,6 +214,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the required feature is not Supported. /// Thrown when the BT/BTLE is not Supported. /// Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors. + /// 4 public void CancelTransfer(int TransferId) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -230,6 +240,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the required feature is not Supported. /// Thrown when the BT/BTLE is not Supported. /// Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors. + /// 4 public void SetDestinationPath(string FilePath) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -252,6 +263,7 @@ namespace Tizen.Network.Bluetooth /// A class which is used to handle the connection and send and receive the object over Opp profile. /// /// http://tizen.org/privilege/bluetooth + /// 4 public class BluetoothOppClient : BluetoothProfile { internal BluetoothOppClient() @@ -261,6 +273,7 @@ namespace Tizen.Network.Bluetooth /// /// (event) PushResponded is called when remote OPP Server responds to a File push request. /// + /// 4 public event EventHandler PushResponded { add @@ -276,6 +289,7 @@ namespace Tizen.Network.Bluetooth /// /// (event) PushProgress is called when the file transfer state is changed. /// + /// 4 public event EventHandler PushProgress { add @@ -291,6 +305,7 @@ namespace Tizen.Network.Bluetooth /// /// (event) PushFinished is called when the file tranfser is completed. /// + /// 4 public event EventHandler PushFinished { add @@ -311,6 +326,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the required feature is not Supported. /// Thrown when the BT/BTLE is not Supported. /// Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors. + /// 4 public void AddFile(string FilePath) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -335,6 +351,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the required feature is not Supported. /// Thrown when the BT/BTLE is not Supported. /// Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors. + /// 4 public void ClearFiles() { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -359,6 +376,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the required feature is not Supported. /// Thrown when the BT/BTLE is not Supported. /// Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors. + /// 4 public void CancelPush() { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) @@ -384,6 +402,7 @@ namespace Tizen.Network.Bluetooth /// Thrown when the required feature is not Supported. /// Thrown when the BT/BTLE is not Supported. /// Thrown when the BT/BTLE is not Enabled or Other Bluetooth Errors. + /// 4 public void PushFile(string Destination) { if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize) diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothProfile.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothProfile.cs index c7cfad2..297f44f 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothProfile.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothProfile.cs @@ -21,6 +21,7 @@ namespace Tizen.Network.Bluetooth /// Any common properties/functions can be added in this class in future. /// /// http://tizen.org/privilege/bluetooth + /// 3 public abstract class BluetoothProfile { internal string RemoteAddress { get; set; } diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothServerSocket.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothServerSocket.cs index d2390f9..8601ac9 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothServerSocket.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothServerSocket.cs @@ -23,6 +23,7 @@ namespace Tizen.Network.Bluetooth /// /// The BluetoothSocket provides functions for managing connections to other devices and exchanging data. /// + /// 3 public class BluetoothServerSocket : IDisposable { private event EventHandler _acceptStateChanged; @@ -35,6 +36,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the Bluetooth is not enabled /// or when the register accpet state changed callback fails. + /// 3 public event EventHandler AcceptStateChanged { add @@ -102,6 +104,7 @@ namespace Tizen.Network.Bluetooth /// /// Thrown when the Bluetooth is not enabled /// or when the listen on socket procedure fails. + /// 3 public void Listen() { int ret = Interop.Bluetooth.Listen(socketFd, 1); @@ -123,6 +126,7 @@ namespace Tizen.Network.Bluetooth /// /// Dispose /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothSocket.cs b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothSocket.cs index c5198cb..35b8ba1 100644 --- a/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothSocket.cs +++ b/src/Tizen.Network.Bluetooth/Tizen.Network.Bluetooth/BluetoothSocket.cs @@ -23,18 +23,21 @@ namespace Tizen.Network.Bluetooth /// /// The IBluetoothServerSocket interface handles the server socket operations. /// + /// 3 public interface IBluetoothServerSocket { /// /// Event handler to receive data over bluetooth socket. /// This event occurs when the socket server receives data from the client. /// + /// 3 event EventHandler DataReceived; /// /// Event handler method to receive bluetooth socket connection state changed events. /// This event occurs when the connection state between two devices is changed. /// + /// 3 event EventHandler ConnectionStateChanged; /// @@ -46,22 +49,26 @@ namespace Tizen.Network.Bluetooth /// /// The data to be sent. /// + /// 3 int SendData(string data); } /// /// The IBluetoothClientSocket interface handles the client socket operations. /// + /// 3 public interface IBluetoothClientSocket : IBluetoothServerSocket { /// /// Connect client socket to server socket on remote device. /// + /// 3 void Connect(); /// /// Disconnect client socket from server socket. /// + /// 3 void Disconnect(); } diff --git a/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionManager.cs b/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionManager.cs index d8cccca..8652293 100755 --- a/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionManager.cs +++ b/src/Tizen.Network.Connection/Tizen.Network.Connection/ConnectionManager.cs @@ -27,6 +27,7 @@ namespace Tizen.Network.Connection /// /// This class manages the connection handle resources. /// + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] public sealed class SafeConnectionHandle : SafeHandle { @@ -38,6 +39,7 @@ namespace Tizen.Network.Connection /// Checks whether the handle value is valid or not. /// /// True if the handle is invalid, otherwise false. + /// 3 public override bool IsInvalid { get diff --git a/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpDevice.cs b/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpDevice.cs index ab2430a..8d012f0 100644 --- a/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpDevice.cs +++ b/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpDevice.cs @@ -23,7 +23,7 @@ namespace Tizen.Network.Mtp /// /// A class for Mtp Device information. It allows applications to handle device information. /// - /// 5 + /// 4 public class MtpDevice : IDisposable { private int _deviceHandle = -1; @@ -34,7 +34,7 @@ namespace Tizen.Network.Mtp /// Gets the manufacturer name of the device information. /// /// Manufacture name of device. - /// 5 + /// 4 public string ManufacturerName { get @@ -54,7 +54,7 @@ namespace Tizen.Network.Mtp /// Gets the model name of the device information. /// /// Model name of device. - /// 5 + /// 4 public string ModelName { get @@ -74,7 +74,7 @@ namespace Tizen.Network.Mtp /// Gets the serial number of the device information. /// /// Serial number of device. - /// 5 + /// 4 public string SerialNumber { get @@ -94,7 +94,7 @@ namespace Tizen.Network.Mtp /// Gets the device version of the device information. /// /// Version number of device. - /// 5 + /// 4 public string DeviceVersion { get @@ -126,6 +126,7 @@ namespace Tizen.Network.Mtp /// /// Dispose /// + /// 4 public void Dispose() { Dispose(true); @@ -162,7 +163,7 @@ namespace Tizen.Network.Mtp /// http://tizen.org/feature/network.mtp /// Thrown when Mtp is not supported. /// Thrown when the method failed due to invalid operation. - /// 5 + /// 4 public IEnumerable GetStorages() { IntPtr storagePtr; diff --git a/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpEnumerations.cs b/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpEnumerations.cs index 17e0ae0..4db646c 100644 --- a/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpEnumerations.cs +++ b/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpEnumerations.cs @@ -21,7 +21,7 @@ namespace Tizen.Network.Mtp /// /// Enumeration for Mtp storage type. /// - /// 5 + /// 4 public enum MtpStorageType { /// @@ -49,7 +49,7 @@ namespace Tizen.Network.Mtp /// /// Enumeration for Mtp file type. /// - /// 5 + /// 4 public enum MtpFileType { /// @@ -245,7 +245,7 @@ namespace Tizen.Network.Mtp /// /// Enumeration for Mtp Event type. /// - /// 5 + /// 4 public enum MtpEventType { /// diff --git a/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpErrorFactory.cs b/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpErrorFactory.cs index 06d318b..6dee6db 100644 --- a/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpErrorFactory.cs +++ b/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpErrorFactory.cs @@ -27,7 +27,7 @@ namespace Tizen.Network.Mtp /// /// Enumeration for Mtp Error. /// - /// 5 + /// 4 public enum MtpError { /// diff --git a/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpEventArgs.cs b/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpEventArgs.cs index e6e7245..e882c43 100644 --- a/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpEventArgs.cs +++ b/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpEventArgs.cs @@ -22,7 +22,7 @@ namespace Tizen.Network.Mtp /// /// An extended EventArgs class which contains Mtp event. /// - /// 5 + /// 4 public class MtpStateChangedEventArgs : EventArgs { private MtpEventType _type = MtpEventType.Unknown; @@ -37,7 +37,7 @@ namespace Tizen.Network.Mtp /// /// The Mtp event type. /// - /// 5 + /// 4 public MtpEventType Type { get @@ -49,7 +49,7 @@ namespace Tizen.Network.Mtp /// /// The event parameter. /// - /// 5 + /// 4 public int EventParameter { get diff --git a/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpManager.cs b/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpManager.cs index f202f4b..36249e1 100644 --- a/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpManager.cs +++ b/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpManager.cs @@ -27,7 +27,7 @@ namespace Tizen.Network.Mtp /// http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage. /// http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. /// - /// 5 + /// 4 static public class MtpManager { /// @@ -37,7 +37,7 @@ namespace Tizen.Network.Mtp /// http://tizen.org/feature/network.mtp /// Thrown when Mtp is not supported. /// Thrown when the method failed due to invalid operation. - /// 5 + /// 4 static public IEnumerable GetDevices() { try @@ -53,7 +53,7 @@ namespace Tizen.Network.Mtp /// /// MtpStateChanged is raised when the Mtp device state is changed. /// - /// 5 + /// 4 static public event EventHandler MtpStateChanged { add diff --git a/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpObject.cs b/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpObject.cs index d8209c4..6c9c176 100644 --- a/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpObject.cs +++ b/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpObject.cs @@ -23,7 +23,7 @@ namespace Tizen.Network.Mtp /// /// A class for Mtp Object information. It allows applications to handle object information. /// - /// 5 + /// 4 public class MtpObject : IDisposable { private int _deviceHandle = -1; @@ -34,7 +34,7 @@ namespace Tizen.Network.Mtp /// Gets the filename of the object information. /// /// File name of object. - /// 5 + /// 4 public string FileName { get @@ -54,7 +54,7 @@ namespace Tizen.Network.Mtp /// Gets the keywords of the object information. /// /// Keywords of object. - /// 5 + /// 4 public string Keywords { get @@ -74,7 +74,7 @@ namespace Tizen.Network.Mtp /// Gets the association description of the object information. /// /// Association description of object. - /// 5 + /// 4 public int AssociationDescription { get @@ -93,7 +93,7 @@ namespace Tizen.Network.Mtp /// Gets the association type of the object information. /// /// Association type of object. - /// 5 + /// 4 public int AssociationType { get @@ -112,7 +112,7 @@ namespace Tizen.Network.Mtp /// Gets the size of the object information. /// /// Size of object. - /// 5 + /// 4 public int Size { get @@ -131,7 +131,7 @@ namespace Tizen.Network.Mtp /// Gets the parent object handle of the object information. /// /// Handle of Parent object. - /// 5 + /// 4 public int ParentObjectHandle { get @@ -150,7 +150,7 @@ namespace Tizen.Network.Mtp /// Gets the mtp storage of the object information. /// /// Storage of object. - /// 5 + /// 4 public int Storage { get @@ -169,7 +169,7 @@ namespace Tizen.Network.Mtp /// Gets the object created time of the object information. /// /// Date created of object. - /// 5 + /// 4 public int DateCreated { get @@ -188,7 +188,7 @@ namespace Tizen.Network.Mtp /// Gets the object modified time of the object information. /// /// Date modified of object. - /// 5 + /// 4 public int DateModified { get @@ -207,7 +207,7 @@ namespace Tizen.Network.Mtp /// Gets the file type of the object information. /// /// File type of object. - /// 5 + /// 4 public MtpFileType FileType { get @@ -226,7 +226,7 @@ namespace Tizen.Network.Mtp /// Gets the image bit depth of the object information. /// /// Bit depth of image. - /// 5 + /// 4 public int ImageBitDepth { get @@ -245,7 +245,7 @@ namespace Tizen.Network.Mtp /// Gets the image pixel width of the object information. /// /// Pixel width of image. - /// 5 + /// 4 public int ImagePixelWidth { get @@ -264,7 +264,7 @@ namespace Tizen.Network.Mtp /// Gets the image pixel height of the object information. /// /// Pixel height of image. - /// 5 + /// 4 public int ImagePixelHeight { get @@ -283,7 +283,7 @@ namespace Tizen.Network.Mtp /// Gets the thumbnail size of the object information. /// /// Size of thumbnail. - /// 5 + /// 4 public int ThumbnailSize { get @@ -302,7 +302,7 @@ namespace Tizen.Network.Mtp /// Gets the thumbnail file type of the object information. /// /// File type of thumbnail. - /// 5 + /// 4 public int ThumbnailFileType { get @@ -321,7 +321,7 @@ namespace Tizen.Network.Mtp /// Gets the thumbnail pixel width of the object information. /// /// Pixel width of thumbnail. - /// 5 + /// 4 public int ThumbnailPixelWidth { get @@ -340,7 +340,7 @@ namespace Tizen.Network.Mtp /// Gets the thumbnail pixel height of the object information. /// /// Pixel height of thumbnail. - /// 5 + /// 4 public int ThumbnailPixelHeight { get @@ -372,6 +372,7 @@ namespace Tizen.Network.Mtp /// /// Dispose /// + /// 4 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpStorage.cs b/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpStorage.cs index df192e6..e53474f 100644 --- a/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpStorage.cs +++ b/src/Tizen.Network.Mtp/Tizen.Network.Mtp/MtpStorage.cs @@ -23,7 +23,7 @@ namespace Tizen.Network.Mtp /// /// A class for Mtp Storage information. It allows applications to handle storage information. /// - /// 5 + /// 4 public class MtpStorage : IDisposable { private int _deviceHandle = -1; @@ -37,7 +37,7 @@ namespace Tizen.Network.Mtp /// Gets the description of the storage information. /// /// Description of storage. - /// 5 + /// 4 public string Description { get @@ -57,7 +57,7 @@ namespace Tizen.Network.Mtp /// Gets the free space of the storage information in bytes. /// /// Free space of storage(bytes). - /// 5 + /// 4 public UInt64 FreeSpace { get @@ -76,7 +76,7 @@ namespace Tizen.Network.Mtp /// Gets the max capacity of the storage information in bytes. /// /// Max capacity of storage(bytes). - /// 5 + /// 4 public UInt64 MaxCapacity { get @@ -95,7 +95,7 @@ namespace Tizen.Network.Mtp /// Gets the storage type of the storage information. /// /// Type of storage. - /// 5 + /// 4 public MtpStorageType StorageType { get @@ -114,7 +114,7 @@ namespace Tizen.Network.Mtp /// Gets the volume identifier of the storage information. /// /// Volume identifier of stroage. - /// 5 + /// 4 public string VolumeIdentifier { get @@ -147,6 +147,7 @@ namespace Tizen.Network.Mtp /// /// Dispose /// + /// 4 public void Dispose() { Dispose(true); @@ -186,7 +187,7 @@ namespace Tizen.Network.Mtp /// http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage. /// http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. /// - /// 5 + /// 4 public MtpObject GetRootObject() { _rootObject = new MtpObject(_deviceHandle, 0); @@ -208,7 +209,7 @@ namespace Tizen.Network.Mtp /// Thrown when Mtp is not supported. /// Thrown when method is failed due to an invalid parameter. /// Thrown when the method failed due to invalid operation. - /// 5 + /// 4 public IEnumerable GetObjectList(MtpObject parentObject, MtpFileType fileType) { IntPtr objectPtr; diff --git a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcCardEmulationAdapter.cs b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcCardEmulationAdapter.cs index e445da3..1712a23 100755 --- a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcCardEmulationAdapter.cs +++ b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcCardEmulationAdapter.cs @@ -152,6 +152,7 @@ namespace Tizen.Network.Nfc /// /// Dispose /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcNdefMessage.cs b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcNdefMessage.cs index ae61d0d..df7bc3b 100755 --- a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcNdefMessage.cs +++ b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcNdefMessage.cs @@ -81,6 +81,7 @@ namespace Tizen.Network.Nfc /// /// Dispose /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcNdefRecord.cs b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcNdefRecord.cs index 234e03b..df7ee5b 100755 --- a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcNdefRecord.cs +++ b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcNdefRecord.cs @@ -295,6 +295,7 @@ namespace Tizen.Network.Nfc /// /// Dispose /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2p.cs b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2p.cs index 15531de..4842dec 100755 --- a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2p.cs +++ b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2p.cs @@ -67,6 +67,7 @@ namespace Tizen.Network.Nfc /// /// Dispose /// + /// 3 public void Dispose() { Dispose(true); @@ -167,6 +168,7 @@ namespace Tizen.Network.Nfc /// /// Dispose /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2pAdapter.cs b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2pAdapter.cs index 3e50575..a772fc2 100755 --- a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2pAdapter.cs +++ b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcP2pAdapter.cs @@ -66,6 +66,7 @@ namespace Tizen.Network.Nfc /// /// Dispose /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcSecureElement.cs b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcSecureElement.cs index 0bcaf31..b80b5c9 100755 --- a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcSecureElement.cs +++ b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcSecureElement.cs @@ -45,6 +45,7 @@ namespace Tizen.Network.Nfc /// /// Dispose /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTag.cs b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTag.cs index f7be13c..def9c37 100755 --- a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTag.cs +++ b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTag.cs @@ -119,6 +119,7 @@ namespace Tizen.Network.Nfc /// /// Dispose /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTagAdapter.cs b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTagAdapter.cs index 0c3c392..f07187d 100755 --- a/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTagAdapter.cs +++ b/src/Tizen.Network.Nfc/Tizen.Network.Nfc/NfcTagAdapter.cs @@ -66,6 +66,7 @@ namespace Tizen.Network.Nfc /// /// Dispose /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Network.Nsd/Tizen.Network.Nsd/INsdBrowser.cs b/src/Tizen.Network.Nsd/Tizen.Network.Nsd/INsdBrowser.cs index 7fa490a..e09a20a 100755 --- a/src/Tizen.Network.Nsd/Tizen.Network.Nsd/INsdBrowser.cs +++ b/src/Tizen.Network.Nsd/Tizen.Network.Nsd/INsdBrowser.cs @@ -21,6 +21,7 @@ namespace Tizen.Network.Nsd /// /// This interface is used for managing network service discovery using DNSSD/SSDP. /// + /// 4 public interface INsdBrowser { /// diff --git a/src/Tizen.Network.Nsd/Tizen.Network.Nsd/INsdService.cs b/src/Tizen.Network.Nsd/Tizen.Network.Nsd/INsdService.cs index 7b0c6e3..13c933e 100755 --- a/src/Tizen.Network.Nsd/Tizen.Network.Nsd/INsdService.cs +++ b/src/Tizen.Network.Nsd/Tizen.Network.Nsd/INsdService.cs @@ -21,6 +21,7 @@ namespace Tizen.Network.Nsd /// /// This interface is used for managing local service registration using DNSSD/SSDP. /// + /// 4 public interface INsdService : IDisposable { /// diff --git a/src/Tizen.Network.Nsd/Tizen.Network.Nsd/NsdEnumerations.cs b/src/Tizen.Network.Nsd/Tizen.Network.Nsd/NsdEnumerations.cs index ce98b1e..30f054c 100755 --- a/src/Tizen.Network.Nsd/Tizen.Network.Nsd/NsdEnumerations.cs +++ b/src/Tizen.Network.Nsd/Tizen.Network.Nsd/NsdEnumerations.cs @@ -27,22 +27,27 @@ namespace Tizen.Network.Nsd /// /// Available DNS-SD service found. /// + /// 4 Available, /// /// DNS-SD service not available. /// + /// 4 Unavailable, /// /// Lookup failure for service name. /// + /// 4 ServiceNameLookupFailed, /// /// Lookup failure for host name and port number. /// + /// 4 HostNameLookupFailed, /// /// Lookup failure for IP address. /// + /// 4 AddressLookupFailed } @@ -55,10 +60,12 @@ namespace Tizen.Network.Nsd /// /// Available SSDP service found. /// + /// 4 Available, /// /// SSDP service not available. /// + /// 4 Unavailable } diff --git a/src/Tizen.Network.Smartcard/Tizen.Network.Smartcard/SmartcardChannel.cs b/src/Tizen.Network.Smartcard/Tizen.Network.Smartcard/SmartcardChannel.cs index e9015ac..9845e0b 100644 --- a/src/Tizen.Network.Smartcard/Tizen.Network.Smartcard/SmartcardChannel.cs +++ b/src/Tizen.Network.Smartcard/Tizen.Network.Smartcard/SmartcardChannel.cs @@ -126,6 +126,7 @@ namespace Tizen.Network.Smartcard /// /// Dispose /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Network.Smartcard/Tizen.Network.Smartcard/SmartcardReader.cs b/src/Tizen.Network.Smartcard/Tizen.Network.Smartcard/SmartcardReader.cs index 9bfca63..65eb317 100644 --- a/src/Tizen.Network.Smartcard/Tizen.Network.Smartcard/SmartcardReader.cs +++ b/src/Tizen.Network.Smartcard/Tizen.Network.Smartcard/SmartcardReader.cs @@ -85,6 +85,7 @@ namespace Tizen.Network.Smartcard /// /// Dispose /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Network.Smartcard/Tizen.Network.Smartcard/SmartcardSession.cs b/src/Tizen.Network.Smartcard/Tizen.Network.Smartcard/SmartcardSession.cs index 02815f4..3467509 100644 --- a/src/Tizen.Network.Smartcard/Tizen.Network.Smartcard/SmartcardSession.cs +++ b/src/Tizen.Network.Smartcard/Tizen.Network.Smartcard/SmartcardSession.cs @@ -121,6 +121,7 @@ namespace Tizen.Network.Smartcard /// /// Dispose /// + /// 3 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiAP.cs b/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiAP.cs index bbee576..004c8a9 100755 --- a/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiAP.cs +++ b/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiAP.cs @@ -503,6 +503,7 @@ namespace Tizen.Network.WiFi /// /// A class which is used to represent WPS PBC information of the access point. /// + /// 3 public class WpsPbcInfo : WpsInfo { } @@ -510,6 +511,7 @@ namespace Tizen.Network.WiFi /// /// A class which is used to represent WPS PIN information of the access point. /// + /// 3 public class WpsPinInfo : WpsInfo { private string _pin; diff --git a/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiManager.cs b/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiManager.cs index 21fe633..2c39137 100755 --- a/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiManager.cs +++ b/src/Tizen.Network.WiFi/Tizen.Network.WiFi/WiFiManager.cs @@ -25,6 +25,7 @@ namespace Tizen.Network.WiFi /// /// A class for managing the WiFiManager handle. /// + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] public sealed class SafeWiFiManagerHandle : SafeHandle { @@ -36,6 +37,7 @@ namespace Tizen.Network.WiFi /// Checks the validity of the handle. /// /// Represents the validity of the handle. + /// 3 public override bool IsInvalid { get diff --git a/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectEnumerations.cs b/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectEnumerations.cs index 398437b..a02a98e 100644 --- a/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectEnumerations.cs +++ b/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectEnumerations.cs @@ -22,6 +22,7 @@ namespace Tizen.Network.WiFiDirect /// /// Enumeration for the Wi-Fi Direct discovery state. /// + /// 3 public enum WiFiDirectDiscoveryState { /// @@ -49,6 +50,7 @@ namespace Tizen.Network.WiFiDirect /// /// Enumeration for the Wi-Fi Direct display device types. /// + /// 3 public enum WiFiDirectDisplayType { /// @@ -72,6 +74,7 @@ namespace Tizen.Network.WiFiDirect /// /// Enumeration for the Wi-Fi Discovery channel. /// + /// 3 public enum WiFiDirectDiscoveryChannel { /// @@ -99,6 +102,7 @@ namespace Tizen.Network.WiFiDirect /// /// Enumeration for the Wi-Fi Direct connection state. /// + /// 3 public enum WiFiDirectConnectionState { /// @@ -142,6 +146,7 @@ namespace Tizen.Network.WiFiDirect /// /// Enumeration for the Wi-Fi Direct primary device type. /// + /// 3 public enum WiFiDirectPrimaryDeviceType { /// @@ -197,6 +202,7 @@ namespace Tizen.Network.WiFiDirect /// /// Enumeration for the Wi-Fi Direct secondary device type. /// + /// 3 public enum WiFiDirectSecondaryDeviceType { /// @@ -432,6 +438,7 @@ namespace Tizen.Network.WiFiDirect /// /// Enumeration for the Wi-Fi Direct link status. /// + /// 3 public enum WiFiDirectState { /// @@ -475,6 +482,7 @@ namespace Tizen.Network.WiFiDirect /// /// Enumeration for the Wi-Fi WPS type. /// + /// 3 public enum WiFiDirectWpsType { /// @@ -498,6 +506,7 @@ namespace Tizen.Network.WiFiDirect /// /// Enumeration for the service discovery type. /// + /// 3 public enum WiFiDirectServiceType { /// @@ -537,6 +546,7 @@ namespace Tizen.Network.WiFiDirect /// /// Enumeration for the Wi-Fi Direct service discovery state. /// + /// 3 public enum WiFiDirectServiceDiscoveryState { /// @@ -556,6 +566,7 @@ namespace Tizen.Network.WiFiDirect /// /// Enumeration for the Wi-Fi Direct device state. /// + /// 3 public enum WiFiDirectDeviceState { /// @@ -571,6 +582,7 @@ namespace Tizen.Network.WiFiDirect /// /// Enumeration for the Wi-Fi Direct error code. /// + /// 3 public enum WiFiDirectError { /// diff --git a/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectEventArgs.cs b/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectEventArgs.cs index 5675c8a..3b89bdb 100644 --- a/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectEventArgs.cs +++ b/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectEventArgs.cs @@ -22,6 +22,7 @@ namespace Tizen.Network.WiFiDirect /// /// An extended EventArgs class which contains the changed connection state during connecting or disconnecting the peer device. /// + /// 3 public class ConnectionStateChangedEventArgs : EventArgs { private WiFiDirectError _error; @@ -38,6 +39,7 @@ namespace Tizen.Network.WiFiDirect /// /// The Wi-Fi Direct result. /// + /// 3 public WiFiDirectError Error { get @@ -49,6 +51,7 @@ namespace Tizen.Network.WiFiDirect /// /// The Wi-Fi Direct connection state of the peer. /// + /// 3 public WiFiDirectConnectionState State { get @@ -60,6 +63,7 @@ namespace Tizen.Network.WiFiDirect /// /// The MacAddress of the peer. /// + /// 3 public string MacAddress { get @@ -72,6 +76,7 @@ namespace Tizen.Network.WiFiDirect /// /// An extended EventArgs class which contains address properties of the peer when it connects to a group owner. /// + /// 3 public class IpAddressAssignedEventArgs : EventArgs { private string _macAddress; @@ -88,6 +93,7 @@ namespace Tizen.Network.WiFiDirect /// /// The MacAddress of the connected peer. /// + /// 3 public string MacAddress { get @@ -99,6 +105,7 @@ namespace Tizen.Network.WiFiDirect /// /// The IpAddress of the connected peer. /// + /// 3 public string IpAddress { get @@ -110,6 +117,7 @@ namespace Tizen.Network.WiFiDirect /// /// The InterfaceAddress of the connected peer. /// + /// 3 public string InterfaceAddress { get @@ -122,6 +130,7 @@ namespace Tizen.Network.WiFiDirect /// /// An extended EventArgs class which contains the changed Wi-Fi Direct state of the local device. /// + /// 3 public class StateChangedEventArgs : EventArgs { private WiFiDirectState _state; @@ -134,6 +143,7 @@ namespace Tizen.Network.WiFiDirect /// /// The Wi-Fi Direct state. /// + /// 3 public WiFiDirectState State { get @@ -146,6 +156,7 @@ namespace Tizen.Network.WiFiDirect /// /// An extended EventArgs class which contains the changed Wi-Fi Direct discovery state during the Wi-Fi Direct scan operation. /// + /// 3 public class DiscoveryStateChangedEventArgs : EventArgs { private WiFiDirectError _error; @@ -160,6 +171,7 @@ namespace Tizen.Network.WiFiDirect /// /// The Wi-Fi Direct result. /// + /// 3 public WiFiDirectError Error { get @@ -171,6 +183,7 @@ namespace Tizen.Network.WiFiDirect /// /// The Wi-Fi Direct discovery state. /// + /// 3 public WiFiDirectDiscoveryState DiscoveryState { get @@ -183,6 +196,7 @@ namespace Tizen.Network.WiFiDirect /// /// An extended EventArgs class which contains the found peer information during the Wi-Fi Direct scan operation. /// + /// 3 public class PeerFoundEventArgs : EventArgs { private WiFiDirectError _error; @@ -199,6 +213,7 @@ namespace Tizen.Network.WiFiDirect /// /// The Wi-Fi Direct result. /// + /// 3 public WiFiDirectError Error { get @@ -210,6 +225,7 @@ namespace Tizen.Network.WiFiDirect /// /// The Wi-Fi Direct discovery state. /// + /// 3 public WiFiDirectDiscoveryState DiscoveryState { get @@ -221,6 +237,7 @@ namespace Tizen.Network.WiFiDirect /// /// The found peer. /// + /// 3 public WiFiDirectPeer Peer { get @@ -233,6 +250,7 @@ namespace Tizen.Network.WiFiDirect /// /// An extended EventArgs class which contains the changed device state during activation or deactivation. /// + /// 3 public class DeviceStateChangedEventArgs : EventArgs { private WiFiDirectError _error; @@ -247,6 +265,7 @@ namespace Tizen.Network.WiFiDirect /// /// The Wi-Fi Direct result. /// + /// 3 public WiFiDirectError Error { get @@ -258,6 +277,7 @@ namespace Tizen.Network.WiFiDirect /// /// The state of the device. /// + /// 3 public WiFiDirectDeviceState DeviceState { get @@ -270,6 +290,7 @@ namespace Tizen.Network.WiFiDirect /// /// An extended EventArgs class which contains the changed service information during the service discovery. /// + /// 3 public class ServiceStateChangedEventArgs : EventArgs { private WiFiDirectError _error; @@ -290,6 +311,7 @@ namespace Tizen.Network.WiFiDirect /// /// The Wi-Fi Direct result. /// + /// 3 public WiFiDirectError Error { get @@ -301,6 +323,7 @@ namespace Tizen.Network.WiFiDirect /// /// The service discovery state. /// + /// 3 public WiFiDirectServiceDiscoveryState ServiceDiscoveryState { get @@ -312,6 +335,7 @@ namespace Tizen.Network.WiFiDirect /// /// The types of service. /// + /// 3 public WiFiDirectServiceType ServiceType { get @@ -323,6 +347,7 @@ namespace Tizen.Network.WiFiDirect /// /// The received response. /// + /// 3 public string Response { get @@ -334,6 +359,7 @@ namespace Tizen.Network.WiFiDirect /// /// The peer servicing device. /// + /// 3 public WiFiDirectPeer Peer { get @@ -346,6 +372,7 @@ namespace Tizen.Network.WiFiDirect /// /// An extended EventArgs class which contains the changed connection state during disconnecting of all peers or grouping related operations. /// + /// 3 public class ConnectionStatusChangedEventArgs : EventArgs { private WiFiDirectError _error; @@ -360,6 +387,7 @@ namespace Tizen.Network.WiFiDirect /// /// The Wi-Fi Direct result. /// + /// 3 public WiFiDirectError Error { get @@ -371,6 +399,7 @@ namespace Tizen.Network.WiFiDirect /// /// The connection state. /// + /// 3 public WiFiDirectConnectionState ConnectionState { get diff --git a/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectManager.cs b/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectManager.cs index c7751a6..cd26d3d 100644 --- a/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectManager.cs +++ b/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectManager.cs @@ -24,6 +24,7 @@ namespace Tizen.Network.WiFiDirect /// A class which is used to manage settings of Wi-Fi Direct.
/// This class is used to discover peer devices and manage settings of Wi-Fi Direct. ///
+ /// 3 public static class WiFiDirectManager { /// @@ -40,6 +41,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 [EditorBrowsable(EditorBrowsableState.Never)] public static bool IsInitialized { @@ -63,6 +65,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static bool IsGroupOwner { get @@ -94,6 +97,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static bool IsAutonomousGroup { get @@ -124,6 +128,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static string Ssid { get @@ -155,6 +160,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static string NetworkInterface { get @@ -186,6 +192,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static string IpAddress { get @@ -217,6 +224,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static string SubnetMask { get @@ -248,6 +256,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static string GatewayAddress { get @@ -278,6 +287,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static string MacAddress { get @@ -305,6 +315,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static WiFiDirectState State { get @@ -324,6 +335,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static bool IsDiscoverable { get @@ -355,6 +367,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static bool IsListenOnly { get @@ -385,6 +398,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static WiFiDirectPrimaryDeviceType PrimaryType { get @@ -415,6 +429,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static WiFiDirectSecondaryDeviceType SecondaryType { get @@ -445,6 +460,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static int WpsMode { get @@ -472,6 +488,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static WiFiDirectWpsType Wps { get @@ -502,6 +519,7 @@ namespace Tizen.Network.WiFiDirect /// /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static int OperatingChannel { get @@ -530,6 +548,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static bool PersistentGroupEnabled { get @@ -566,6 +585,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static bool AutoConnect { get @@ -606,6 +626,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static string WpsPin { get @@ -648,6 +669,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static string Name { get @@ -684,6 +706,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static WiFiDirectWpsType RequestedWps { get @@ -720,6 +743,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static int GroupOwnerIntent { get @@ -756,6 +780,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static int MaxClients { get @@ -797,6 +822,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static string Passphrase { get @@ -843,6 +869,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static int SessionTimer { get @@ -876,6 +903,7 @@ namespace Tizen.Network.WiFiDirect /// /// (event) StateChanged is raised when Wi-Fi Direct state is changed. /// + /// 3 public static event EventHandler StateChanged { add @@ -892,6 +920,7 @@ namespace Tizen.Network.WiFiDirect /// /// (event) DiscoveryStateChanged is raised when Wi-Fi Direct discovery state is changed. /// + /// 3 public static event EventHandler DiscoveryStateChanged { add @@ -914,6 +943,7 @@ namespace Tizen.Network.WiFiDirect /// /// (event) DeviceStateChanged is raised when device state is changed. /// + /// 3 public static event EventHandler DeviceStateChanged { add @@ -936,6 +966,7 @@ namespace Tizen.Network.WiFiDirect /// /// (event) PeerFound is raised when peer is found. /// + /// 3 public static event EventHandler PeerFound { add @@ -958,6 +989,7 @@ namespace Tizen.Network.WiFiDirect /// /// (event) ConnectionStatusChanged is raised when status of connection is changed. /// + /// 3 public static event EventHandler ConnectionStatusChanged { add @@ -986,6 +1018,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static void Activate() { if (Globals.IsInitialize) @@ -1016,6 +1049,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static void Deactivate() { if (Globals.IsActivated) @@ -1049,6 +1083,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static void StartDiscovery(bool listenOnly, int duration, WiFiDirectDiscoveryChannel channel = WiFiDirectDiscoveryChannel.FullScan) { if (Globals.IsActivated) @@ -1079,6 +1114,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static void CancelDiscovery() { if (WiFiDirectManager.State == WiFiDirectState.Discovering) @@ -1109,6 +1145,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static IEnumerable GetDiscoveredPeers() { if (Globals.IsActivated) @@ -1138,6 +1175,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static IEnumerable GetConnectedPeers() { if (Globals.IsActivated) @@ -1167,6 +1205,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static void DisconnectAll() { if (Globals.IsActivated) @@ -1197,6 +1236,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static void CreateGroup() { if (Globals.IsActivated) @@ -1227,6 +1267,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static void DestroyGroup() { if (Globals.IsActivated) @@ -1253,6 +1294,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static void ActivatePushButton() { if (Globals.IsActivated) @@ -1280,6 +1322,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static IEnumerable GetSupportedWpsTypes() { if (Globals.IsInitialize) @@ -1306,6 +1349,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static IEnumerable GetPersistentGroups() { if (Globals.IsInitialize) @@ -1332,6 +1376,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static void RemovePersistentGroup(WiFiDirectPersistentGroup group) { if (Globals.IsInitialize) @@ -1367,6 +1412,7 @@ namespace Tizen.Network.WiFiDirect /// /// The object is in invalid state. /// Thrown when application does not have privilege to access this method. + /// 3 public static void InitMiracast(bool enable) { if (Globals.IsActivated) @@ -1401,6 +1447,7 @@ namespace Tizen.Network.WiFiDirect /// /// The object is in invalid state. /// Thrown when application does not have privilege to access this method. + /// 3 public static void InitDisplay() { if (Globals.IsActivated) @@ -1435,6 +1482,7 @@ namespace Tizen.Network.WiFiDirect /// /// The object is in invalid state. /// Thrown when application does not have privilege to access this method. + /// 3 public static void DeinitDisplay() { if (Globals.IsActivated && Globals.s_isDisplay) @@ -1472,6 +1520,7 @@ namespace Tizen.Network.WiFiDirect /// /// The object is in invalid state. /// Thrown when application does not have privilege to access this method. + /// 3 public static void SetDisplay(WiFiDirectDisplayType type, int port, int hdcp) { if (Globals.IsActivated && Globals.s_isDisplay) @@ -1507,6 +1556,7 @@ namespace Tizen.Network.WiFiDirect /// /// The object is in invalid state. /// Thrown when application does not have privilege to access this method. + /// 3 public static void SetDisplayAvailability(bool availability) { if (Globals.IsActivated && Globals.s_isDisplay) @@ -1538,6 +1588,7 @@ namespace Tizen.Network.WiFiDirect /// The object is in invalid state. /// The required feature is not supported. /// Thrown when application does not have privilege to access this method. + /// 3 public static void SetAutoGroupRemove(bool enable) { if (Globals.IsActivated) @@ -1577,6 +1628,7 @@ namespace Tizen.Network.WiFiDirect /// /// The object is in invalid state. /// Thrown when application does not have privilege to access this method. + /// 3 public static uint RegisterService(WiFiDirectServiceType type, string info, string serviceInfo) { if (Globals.IsActivated) @@ -1611,6 +1663,7 @@ namespace Tizen.Network.WiFiDirect /// /// The object is in invalid state. /// Thrown when application does not have privilege to access this method. + /// 3 public static void DeregisterService(uint serviceId) { if (Globals.IsActivated) diff --git a/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectPeer.cs b/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectPeer.cs index 12afe95..f3bf6f3 100644 --- a/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectPeer.cs +++ b/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectPeer.cs @@ -27,6 +27,7 @@ namespace Tizen.Network.WiFiDirect /// The WiFiDirectPeer class is used to handle the connection with remote devices using Wi-Fi Direct. /// /// http://tizen.org/privilege/wifidirect + /// 3 public class WiFiDirectPeer { private event EventHandler _connectionStateChanged; @@ -60,6 +61,7 @@ namespace Tizen.Network.WiFiDirect /// /// The name of the peer device. /// + /// 3 public string Name { get @@ -71,6 +73,7 @@ namespace Tizen.Network.WiFiDirect /// /// The IP address of the peer device. /// + /// 3 public string IpAddress { get @@ -82,6 +85,7 @@ namespace Tizen.Network.WiFiDirect /// /// The MAC address of the peer device. /// + /// 3 public string MacAddress { get @@ -93,6 +97,7 @@ namespace Tizen.Network.WiFiDirect /// /// The Interface address of the peer device. /// + /// 3 public string InterfaceAddress { get @@ -104,6 +109,7 @@ namespace Tizen.Network.WiFiDirect /// /// The listening channel of the peer device. /// + /// 3 public int Channel { get @@ -115,6 +121,7 @@ namespace Tizen.Network.WiFiDirect /// /// The connected state of the peer device. /// + /// 3 public bool IsConnected { get @@ -126,6 +133,7 @@ namespace Tizen.Network.WiFiDirect /// /// The P2P group state of the peer device. /// + /// 3 public bool IsGroupOwner { get @@ -137,6 +145,7 @@ namespace Tizen.Network.WiFiDirect /// /// The P2P state of the peer device. /// + /// 3 public bool P2PSupport { get @@ -148,6 +157,7 @@ namespace Tizen.Network.WiFiDirect /// /// The primary catagory of the peer device. /// + /// 3 public WiFiDirectPrimaryDeviceType PrimaryType { get @@ -159,6 +169,7 @@ namespace Tizen.Network.WiFiDirect /// /// The sub category of the peer device. /// + /// 3 public WiFiDirectSecondaryDeviceType SecondaryType { get @@ -170,6 +181,7 @@ namespace Tizen.Network.WiFiDirect /// /// The list of the supported WPS type of the peer device. /// + /// 3 public int WpsTypes { get @@ -181,6 +193,7 @@ namespace Tizen.Network.WiFiDirect /// /// The P2P invitation state of the peer device. /// + /// 3 public bool IsP2PInvitationSupported { get @@ -192,6 +205,7 @@ namespace Tizen.Network.WiFiDirect /// /// The number of registered services of the peer device. /// + /// 3 public uint ServiceCount { get @@ -203,6 +217,7 @@ namespace Tizen.Network.WiFiDirect /// /// The list of registered services of the peer device. /// + /// 3 public IEnumerable ServiceList { get @@ -214,6 +229,7 @@ namespace Tizen.Network.WiFiDirect /// /// Checks if the peer device is a Wi-Fi display device. /// + /// 3 public bool IsMiracastDevice { get @@ -229,6 +245,7 @@ namespace Tizen.Network.WiFiDirect /// Wi-Fi Direct must be activated. /// If there is any error, a default value of WiFiDirectDisplayType will be returned. /// + /// 3 public WiFiDirectDisplayType Display { get @@ -259,6 +276,7 @@ namespace Tizen.Network.WiFiDirect /// Wi-Fi Direct must be activated. /// If there is any error, false will be returned. /// + /// 3 public bool DisplayAvailability { get @@ -289,6 +307,7 @@ namespace Tizen.Network.WiFiDirect /// Wi-Fi Direct must be activated. /// If there is any error, -1 will be returned. /// + /// 3 public int Hdcp { get @@ -320,6 +339,7 @@ namespace Tizen.Network.WiFiDirect /// Wi-Fi Direct must be activated. /// If there is any error, -1 will be returned. /// + /// 3 public int Port { get @@ -351,6 +371,7 @@ namespace Tizen.Network.WiFiDirect /// Wi-Fi Direct must be activated. /// If there is any error, -1 will be returned. /// + /// 3 public int Throughput { get @@ -382,6 +403,7 @@ namespace Tizen.Network.WiFiDirect /// Wi-Fi Direct must be activated. /// If there is any error, -1 will be returned. /// + /// 3 public int Rssi { get @@ -408,6 +430,7 @@ namespace Tizen.Network.WiFiDirect /// /// The ConnectionStateChanged event is raised when the connection state of the peer device changes. /// + /// 3 public event EventHandler ConnectionStateChanged { add @@ -439,6 +462,7 @@ namespace Tizen.Network.WiFiDirect /// /// The IpAddressAssigned event is raised when the IP address of the peer device is assigned. /// + /// 3 public event EventHandler IpAddressAssigned { add @@ -470,6 +494,7 @@ namespace Tizen.Network.WiFiDirect /// /// The ServiceStateChanged event is raised when the state of service discovery is changed. /// + /// 3 public event EventHandler ServiceStateChanged { add @@ -590,6 +615,7 @@ namespace Tizen.Network.WiFiDirect /// If this succeeds, the ConnectionStateChanged event will be invoked. /// /// Thrown when the Wi-Fi Direct is not supported + /// 3 public void Connect() { if (Globals.IsActivated) @@ -616,6 +642,7 @@ namespace Tizen.Network.WiFiDirect /// Wi-Fi Direct must be activated. /// /// Thrown when the Wi-Fi Direct is not supported. + /// 3 public void CancelConnection() { if (Globals.IsActivated) @@ -643,6 +670,7 @@ namespace Tizen.Network.WiFiDirect /// If this succeeds, the ConnectionStateChanged event will be invoked. /// /// Thrown when the Wi-Fi Direct is not supported. + /// 3 public void Disconnect() { if (Globals.IsActivated) @@ -669,6 +697,7 @@ namespace Tizen.Network.WiFiDirect /// Wi-Fi Direct must be activated. /// /// Thrown when the Wi-Fi Direct is not supported. + /// 3 public void SetAutoConnect() { if (Globals.IsActivated) @@ -701,6 +730,7 @@ namespace Tizen.Network.WiFiDirect /// 2. When the Wi-Fi Direct service discovery is not supported. /// /// The type of the service. + /// 3 public void StartServiceDiscovery(WiFiDirectServiceType type) { if (Globals.IsActivated) @@ -732,6 +762,7 @@ namespace Tizen.Network.WiFiDirect /// 2. When the Wi-Fi Direct service discovery is not supported. /// /// The type of the service. + /// 3 public void CancelServiceDiscovery(WiFiDirectServiceType type) { if (Globals.IsActivated) diff --git a/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectPersistentGroup.cs b/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectPersistentGroup.cs index 0473bdb..cfef8f1 100644 --- a/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectPersistentGroup.cs +++ b/src/Tizen.Network.WiFiDirect/Tizen.Network.WiFiDirect/WiFiDirectPersistentGroup.cs @@ -21,6 +21,7 @@ namespace Tizen.Network.WiFiDirect /// /// A class to handle persistent groups. /// + /// 3 public class WiFiDirectPersistentGroup { private string _address; @@ -35,6 +36,7 @@ namespace Tizen.Network.WiFiDirect /// /// The MAC address of the persistent group owner. /// + /// 3 public string MacAddress { get @@ -46,6 +48,7 @@ namespace Tizen.Network.WiFiDirect /// /// The SSID (Service Set Identifier) of the persistent group owner. /// + /// 3 public string Ssid { get diff --git a/src/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/PhonenumberUtils.cs b/src/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/PhonenumberUtils.cs index 5530d80..946338c 100644 --- a/src/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/PhonenumberUtils.cs +++ b/src/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/PhonenumberUtils.cs @@ -21,7 +21,7 @@ namespace Tizen.PhonenumberUtils /// /// The PhonenumberUtils class provides methods for parsing, formatting and normalizing phone numbers. /// - /// 4 + /// 3 public class PhonenumberUtils : IDisposable { private bool disposed = false; @@ -32,7 +32,7 @@ namespace Tizen.PhonenumberUtils /// http://tizen.org/feature/network.telephony /// Thrown when method failed due to invalid operation /// Thrown when feature is not supported - /// 4 + /// 3 public PhonenumberUtils() { int ret; @@ -58,7 +58,7 @@ namespace Tizen.PhonenumberUtils /// Releases all resources used by the PhonenumberUtils. /// It should be called after finished using of the object. ///
- /// 4 + /// 3 public void Dispose() { Dispose(true); @@ -92,7 +92,7 @@ namespace Tizen.PhonenumberUtils /// Thrown when feature is not supported /// Thrown when input coordinates are invalid /// Thrown when failed due to out of memory - /// 4 + /// 3 public string GetLocationFromNumber(string number, Region region, Language language) { int ret; @@ -119,7 +119,7 @@ namespace Tizen.PhonenumberUtils /// Thrown when feature is not supported /// Thrown when input coordinates are invalid /// Thrown when failed due to out of memory - /// 4 + /// 3 public string GetFormattedNumber(string number, Region region) { int ret; @@ -151,7 +151,7 @@ namespace Tizen.PhonenumberUtils /// Normalized number starts with plus('+') and country code, and excludes the separators such as dash or space. /// It is a format of E.164 standard including the country code based on current network. /// - /// 4 + /// 3 public string GetNormalizedNumber(string number) { int ret; diff --git a/src/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/PhonenumberUtilsEnumerations.cs b/src/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/PhonenumberUtilsEnumerations.cs index b1294cf..f852b07 100644 --- a/src/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/PhonenumberUtilsEnumerations.cs +++ b/src/Tizen.PhonenumberUtils/Tizen.PhonenumberUtils/PhonenumberUtilsEnumerations.cs @@ -19,7 +19,7 @@ namespace Tizen.PhonenumberUtils /// /// Enumeration for language type. /// - /// 4 + /// 3 public enum Language { /// @@ -151,7 +151,7 @@ namespace Tizen.PhonenumberUtils /// /// Enumeration for region type. /// - /// 4 + /// 3 public enum Region { /// diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarDatabase.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarDatabase.cs index c088bd5..45686aa 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarDatabase.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarDatabase.cs @@ -509,8 +509,8 @@ namespace Tizen.Pims.Calendar /// /// Registers a callback function to be invoked when a record changes. - /// 4 /// + /// 4 /// The view URI of the record to subscribe for change notifications /// The EventHandler to register /// http://tizen.org/privilege/calendar.read diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarFilter.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarFilter.cs index d31564b..76a65d4 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarFilter.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarFilter.cs @@ -199,6 +199,7 @@ namespace Tizen.Pims.Calendar /// /// Enumeration for the filter match type of a string. /// + /// 4 public enum StringMatchType { /// @@ -230,6 +231,7 @@ namespace Tizen.Pims.Calendar /// /// Enumeration for the filter match type of an integer. /// + /// 4 public enum IntegerMatchType { /// @@ -265,6 +267,7 @@ namespace Tizen.Pims.Calendar /// /// Enumeration for a filter operator. /// + /// 4 public enum LogicalOperator { /// @@ -284,6 +287,7 @@ namespace Tizen.Pims.Calendar /// Dispose /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// 4 protected virtual void Dispose(bool disposing) { if (!disposedValue) @@ -303,6 +307,7 @@ namespace Tizen.Pims.Calendar /// Releases all resources used by the CalendarFilter. /// It should be called after having finished using of the object. /// + /// 4 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarList.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarList.cs index 9c8b7d0..cef13cb 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarList.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarList.cs @@ -99,6 +99,7 @@ namespace Tizen.Pims.Calendar /// Disposes of the resources (other than memory) used by the CalendarList. /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// 4 protected virtual void Dispose(bool disposing) { if (!disposedValue) @@ -119,6 +120,7 @@ namespace Tizen.Pims.Calendar /// Releases all resources used by the CalendarList. /// It should be called after having finished using of the object. /// + /// 4 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarManager.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarManager.cs index 62981dd..c9ff809 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarManager.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarManager.cs @@ -60,6 +60,7 @@ namespace Tizen.Pims.Calendar /// Disposes of the resources (other than memory) used by the CalendarManager. /// /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// 4 protected virtual void Dispose(bool disposing) { if (!disposedValue) @@ -79,6 +80,7 @@ namespace Tizen.Pims.Calendar /// Releases all resources used by the CalendarManager. /// It should be called after having finished using of the object. ///
+ /// 4 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarQuery.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarQuery.cs index 68c715c..b713901 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarQuery.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarQuery.cs @@ -73,6 +73,7 @@ namespace Tizen.Pims.Calendar /// Disposes of the resources (other than memory) used by the CalendarQuery. ///
/// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// 4 protected virtual void Dispose(bool disposing) { if (!disposedValue) @@ -92,6 +93,7 @@ namespace Tizen.Pims.Calendar /// Releases all resources used by the CalendarQuery. /// It should be called after having finished using of the object. ///
+ /// 4 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarRecord.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarRecord.cs index 8eb9603..a97ab83 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarRecord.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarRecord.cs @@ -127,6 +127,7 @@ namespace Tizen.Pims.Calendar /// Disposes of the resources (other than memory) used by the CalendarRecord. ///
/// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// 4 protected virtual void Dispose(bool disposing) { if (!_disposedValue) @@ -147,6 +148,7 @@ namespace Tizen.Pims.Calendar /// Releases all resources used by the CalendarRecord. /// It should be called after having finished using of the object. ///
+ /// 4 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarReminder.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarReminder.cs index 9eb3c1e..e1804a8 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarReminder.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarReminder.cs @@ -38,6 +38,7 @@ namespace Tizen.Pims.Calendar /// Disposes of the resources (other than memory) used by the CalendarReminder. ///
/// true to release both managed and unmanaged resources; false to release only unmanaged resources. + /// 4 protected virtual void Dispose(bool disposing) { if (!disposedValue) @@ -50,6 +51,7 @@ namespace Tizen.Pims.Calendar /// Releases all resources used by the CalendarReminder. /// It should be called after having finished using of the object. ///
+ /// 4 public void Dispose() { Dispose(true); diff --git a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarVcalendar.cs b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarVcalendar.cs index d79e6c5..272fa28 100644 --- a/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarVcalendar.cs +++ b/src/Tizen.Pims.Calendar/Tizen.Pims.Calendar/CalendarVcalendar.cs @@ -23,6 +23,7 @@ namespace Tizen.Pims.Calendar ///
/// The record /// true to continue with the next iteration of the loop, otherwise false to break out of the loop + /// 4 public delegate bool ParseCallback(CalendarRecord record); /// @@ -31,6 +32,7 @@ namespace Tizen.Pims.Calendar /// /// It's based on the vCalendar v2.0 specification /// + /// 4 public static class CalendarVcalendar { /// @@ -42,6 +44,7 @@ namespace Tizen.Pims.Calendar /// /// Thrown when one of the arguments provided to a method is not valid /// Thrown when failed due to out of memory + /// 4 public static string Compose(CalendarList list) { string stream; @@ -63,6 +66,7 @@ namespace Tizen.Pims.Calendar /// /// Thrown when one of the arguments provided to a method is not valid /// Thrown when failed due to out of memory + /// 4 public static CalendarList Parse(string stream) { int error = 0; @@ -84,6 +88,7 @@ namespace Tizen.Pims.Calendar /// Thrown when method failed due to invalid operation /// Thrown when one of the arguments provided to a method is not valid /// Thrown when failed due to out of memory + /// 4 public static void ParseForEach(string path, ParseCallback callback) { int error = 0; diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsDatabase.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsDatabase.cs index 4693574..61e73d8 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsDatabase.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsDatabase.cs @@ -51,10 +51,12 @@ namespace Tizen.Pims.Contacts /// /// Normal /// + /// 4 Normal, /// /// Changing collation. /// + /// 4 ChangingCollation } @@ -68,22 +70,27 @@ namespace Tizen.Pims.Contacts /// /// None /// + /// 4 None = 0, /// /// Search record from name /// + /// 4 Name = 0x00000001, /// /// Search record from number /// + /// 4 Number = 0x00000002, /// /// Search record from data /// + /// 4 Data = 0x00000004, /// /// Search record from email. Now, support only PersonEmail view /// + /// 4 Email = 0x00000008, } diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsFilter.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsFilter.cs index 06a620e..b202299 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsFilter.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsFilter.cs @@ -199,26 +199,32 @@ namespace Tizen.Pims.Contacts /// /// Full string, case-sensitive /// + /// 4 Exactly, /// /// Full string, case-insensitive /// + /// 4 FullString, /// /// Sub string, case-insensitive /// + /// 4 Contains, /// /// Start with, case-insensitive /// + /// 4 StartsWith, /// /// End with, case-insensitive /// + /// 4 EndsWith, /// /// IS NOT NUL /// + /// 4 Exists, } @@ -231,30 +237,37 @@ namespace Tizen.Pims.Contacts /// /// = /// + /// 4 Equal, /// /// > /// + /// 4 GreaterThan, /// /// >= /// + /// 4 GreaterThanOrEqual, /// /// < /// + /// 4 LessThan, /// /// <= /// + /// 4 LessThanOrEqual, /// /// <>, this flag can yield poor performance /// + /// 4 NotEqual, /// /// IS NULL /// + /// 4 None, } @@ -267,10 +280,12 @@ namespace Tizen.Pims.Contacts /// /// AND /// + /// 4 And, /// /// OR /// + /// 4 Or, } diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsManager.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsManager.cs index 517988d..0d8ebbb 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsManager.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsManager.cs @@ -28,10 +28,12 @@ namespace Tizen.Pims.Contacts /// /// First name comes at the first /// + /// 4 FirstLast, /// /// First name comes at the last /// + /// 4 LastFirst }; @@ -44,10 +46,12 @@ namespace Tizen.Pims.Contacts /// /// Contacts are first sorted based on the first name /// + /// 4 FirstLast, /// /// Contacts are first sorted based on the last name /// + /// 4 LastFirst }; diff --git a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsViews.cs b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsViews.cs index 97dc02c..cb04fb5 100644 --- a/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsViews.cs +++ b/src/Tizen.Pims.Contacts/Tizen.Pims.Contacts/ContactsViews.cs @@ -396,14 +396,17 @@ namespace Tizen.Pims.Contacts /// /// Inserted /// + /// 4 Inserted, /// /// Updated /// + /// 4 Updated, /// /// Deleted /// + /// 4 Deleted, } @@ -416,22 +419,27 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts address book view /// + /// 4 public const string Uri = "tizen.contacts_view.addressbook"; /// /// integer, read only, DB record ID of the address book /// + /// 4 public const uint Id = (uint)Property.Id.AddressBookId; /// /// integer, read/write once, Account ID that the address book belongs to /// + /// 4 public const uint AccountId = (uint)Property.Id.AddressBookAccountId; /// /// string, read/write, It cannot be NULL. Duplicate names are not allowed. /// + /// 4 public const uint Name = (uint)Property.Id.AddressBookName; /// /// integer, read/write, AddressBook mode, refer to the ModeValue /// + /// 4 public const uint Mode = (uint)Property.Id.AddressBookMode; /// @@ -443,10 +451,12 @@ namespace Tizen.Pims.Contacts /// /// All module can read and write contacts of this address_book /// + /// 4 None, /// /// All module can only read contacts of this address_book /// + /// 4 ReadOnly, } } @@ -460,42 +470,52 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts group view /// + /// 4 public const string Uri = "tizen.contacts_view.group"; /// /// DB record ID of the group /// + /// 4 public const uint Id = (uint)Property.Id.GroupId; /// /// AddressBook ID that the group belongs to /// + /// 4 public const uint AddressBookId = (uint)Property.Id.GroupAddressBookId; /// /// Group name /// + /// 4 public const uint Name = (uint)Property.Id.GroupName; /// /// Ringtone path of the group /// + /// 4 public const uint RingtonePath = (uint)Property.Id.GroupRingtone; /// /// Image path of the group /// + /// 4 public const uint ImagePath = (uint)Property.Id.GroupImage; /// /// Vibration path of the group /// + /// 4 public const uint Vibration = (uint)Property.Id.GroupVibration; /// /// Extra data for default group name /// + /// 4 public const uint ExtraData = (uint)Property.Id.GroupExtraData; /// /// The group is read only or not /// + /// 4 public const uint IsReadOnly = (uint)Property.Id.GroupIsReadOnly; /// /// Message alert path of the group /// + /// 4 public const uint MessageAlert = (uint)Property.Id.GroupMessageAlert; } @@ -508,74 +528,92 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts person view /// + /// 4 public const string Uri = "tizen.contacts_view.person"; /// /// DB record ID of the person /// + /// 4 public const uint Id = (uint)Property.Id.PersonId; /// /// Display name of the person /// + /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// /// The first character of first string for grouping. This is normalized using ICU (projection) /// + /// 4 public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex; /// /// Display contact ID that the person belongs to /// + /// 4 public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId; /// /// Ringtone path of the person /// + /// 4 public const uint RingtonePath = (uint)Property.Id.PersonRingtone; /// /// Image thumbnail path of the person /// + /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// /// Vibration path of the person /// + /// 4 public const uint Vibration = (uint)Property.Id.PersonVibration; /// /// Message alert path of the person /// + /// 4 public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert; /// /// Status of social account /// + /// 4 public const uint Status = (uint)Property.Id.PersonStatus; /// /// The person is favorite or not /// + /// 4 public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite; /// /// The priority of favorite contacts. it can be used as sorting key /// + /// 4 public const uint FavoritePriority = (uint)Property.Id.PersonFavoritePriority; /// /// Link count of contact records (projection) /// + /// 4 public const uint LinkCount = (uint)Property.Id.PersonLinkCount; /// /// AddressBook IDs that the person belongs to (projection) /// + /// 4 public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds; /// /// The person has phone number or not /// + /// 4 public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber; /// /// The person has email or not /// + /// 4 public const uint HasEmail = (uint)Property.Id.PersonHasEmail; /// /// keyword matched data type /// + /// 4 public const uint SnippetType = (uint)Property.Id.PersonSnippetType; /// /// keyword matched data string /// + /// 4 public const uint SnippetString = (uint)Property.Id.PersonSnippetString; } @@ -588,130 +626,162 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contact view /// + /// 4 public const string Uri = "tizen.contacts_view.contact"; /// /// DB record ID of the contact /// + /// 4 public const uint Id = (uint)Property.Id.ContactId; /// /// Display name of the contact /// + /// 4 public const uint DisplayName = (uint)Property.Id.ContactDisplayName; /// /// The source type of display name, refer to the DisplayNameSourceType /// + /// 4 public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId; /// /// AddressBook ID that the contact belongs to /// + /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// /// Ringtone path of the contact /// + /// 4 public const uint RingtonePath = (uint)Property.Id.ContactRingtone; /// /// Image thumbnail path of the contact /// + /// 4 public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail; /// /// The contact is favorite or not /// + /// 4 public const uint IsFavorite = (uint)Property.Id.ContactIsFavorite; /// /// The contact has phone number or not /// + /// 4 public const uint HasPhoneNumber = (uint)Property.Id.ContactHasPhoneNumber; /// /// The contact has email or not /// + /// 4 public const uint HasEmail = (uint)Property.Id.ContactHasEmail; /// /// Person ID that the contact belongs to. If set when inserting, a contact will be linked to person /// + /// 4 public const uint PersonId = (uint)Property.Id.ContactPersonId; /// /// Unique identifier /// + /// 4 public const uint UId = (uint)Property.Id.ContactUId; /// /// Vibration path of the contact /// + /// 4 public const uint Vibration = (uint)Property.Id.ContactVibration; /// /// Message alert path of the contact /// + /// 4 public const uint MessageAlert = (uint)Property.Id.ContactMessageAlert; /// /// Last changed contact time /// + /// 4 public const uint ChangedTime = (uint)Property.Id.ContactChangedTime; /// /// The link mode, refer to the LinkModeValue. If the person_id was set, this value will be ignored /// + /// 4 public const uint LinkMode = (uint)Property.Id.ContactLinkMode; /// /// Name child record (single) /// + /// 4 public const uint Name = (uint)Property.Id.ContactName; /// /// Company child record (multiple) /// + /// 4 public const uint Company = (uint)Property.Id.ContactCompany; /// /// Note child record (multiple) /// + /// 4 public const uint Note = (uint)Property.Id.ContactNote; /// /// Number child record (multiple) /// + /// 4 public const uint Number = (uint)Property.Id.ContactNumber; /// /// Email child record (multiple) /// + /// 4 public const uint Email = (uint)Property.Id.ContactEmail; /// /// Event child record (multiple) /// + /// 4 public const uint Event = (uint)Property.Id.ContactEvent; /// /// Messenger child record (multiple) /// + /// 4 public const uint Messenger = (uint)Property.Id.ContactMessenger; /// /// Address child record (multiple) /// + /// 4 public const uint Address = (uint)Property.Id.ContactAddress; /// /// URL child record (multiple) /// + /// 4 public const uint URL = (uint)Property.Id.ContactURL; /// /// Nickname child record (multiple) /// + /// 4 public const uint Nickname = (uint)Property.Id.ContactNickname; /// /// Profile child record (multiple) /// + /// 4 public const uint Profile = (uint)Property.Id.ContactProfile; /// /// Relationship child record (multiple) /// + /// 4 public const uint Relationship = (uint)Property.Id.ContactRelationship; /// /// Image child record (multiple) /// + /// 4 public const uint Image = (uint)Property.Id.ContactImage; /// /// GroupRelation child record (multiple) /// + /// 4 public const uint GroupRelation = (uint)Property.Id.ContactGroupRelation; /// /// Extension child record (multiple) /// + /// 4 public const uint Extension = (uint)Property.Id.ContactExtension; /// /// Sip child record (multiple) /// + /// 4 public const uint Sip = (uint)Property.Id.ContactSip; /// @@ -723,10 +793,12 @@ namespace Tizen.Pims.Contacts /// /// Auto link immediately /// + /// 4 Auto, /// /// Do not auto link when the contact is inserted /// + /// 4 None } @@ -739,26 +811,32 @@ namespace Tizen.Pims.Contacts /// /// Invalid source of display name /// + /// 4 Invalid, /// /// Produced display name from email record /// + /// 4 Email, /// /// Produced display name from number record /// + /// 4 Number, /// /// Produced display name from nickname record /// + /// 4 Nickname, /// /// Produced display name from company record /// + /// 4 Company, /// /// Produced display name from name record /// + /// 4 Name, } @@ -771,66 +849,82 @@ namespace Tizen.Pims.Contacts /// /// None /// + /// 4 None, /// /// Name /// + /// 4 Name = 1, /// /// Address /// + /// 4 Address = 2, /// /// Messenger /// + /// 4 Messenger = 3, /// /// URL /// + /// 4 URL = 4, /// /// Event /// + /// 4 Event = 5, /// /// Company /// + /// 4 Company = 6, /// /// Nickname /// + /// 4 Nickname = 7, /// /// Number /// + /// 4 Number = 8, /// /// Email /// + /// 4 Email = 9, /// /// Profile /// + /// 4 Profile = 10, /// /// Relationship /// + /// 4 Relationship = 11, /// /// Note /// + /// 4 Note = 12, /// /// Image /// + /// 4 Image = 13, /// /// SIP /// + /// 4 Sip = 14, /// /// Extension /// + /// 4 Extension = 100 } } @@ -844,62 +938,77 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this simple contact view /// + /// 4 public const string Uri = "tizen.contacts_view.simple_contact"; /// /// DB record ID of the contact /// + /// 4 public const uint Id = (uint)Property.Id.ContactId; /// /// Display name of the contact /// + /// 4 public const uint DisplayName = (uint)Property.Id.ContactDisplayName; /// /// The source type of display name, refer to the Contact.DisplayNameSourceType /// + /// 4 public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId; /// /// AddressBook that the contact belongs to /// + /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// /// Ringtone path of the contact /// + /// 4 public const uint RingtonePath = (uint)Property.Id.ContactRingtone; /// /// Image thumbnail path of the contact /// + /// 4 public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail; /// /// The contact is favorite or not /// + /// 4 public const uint IsFavorite = (uint)Property.Id.ContactIsFavorite; /// /// The contact has phone number or not /// + /// 4 public const uint HasPhoneNumber = (uint)Property.Id.ContactHasPhoneNumber; /// /// The contact has email or not /// + /// 4 public const uint HasEmail = (uint)Property.Id.ContactHasEmail; /// /// Person ID that the contact belongs to /// + /// 4 public const uint PersonId = (uint)Property.Id.ContactPersonId; /// /// Unique identifier /// + /// 4 public const uint UId = (uint)Property.Id.ContactUId; /// /// Vibration path of the contact /// + /// 4 public const uint Vibration = (uint)Property.Id.ContactVibration; /// /// Message alert path of the contact /// + /// 4 public const uint MessageAlert = (uint)Property.Id.ContactMessageAlert; /// /// Last changed contact time /// + /// 4 public const uint ChangedTime = (uint)Property.Id.ContactChangedTime; } @@ -912,90 +1021,112 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this my profile view /// + /// 4 public const string Uri = "tizen.contacts_view.my_profile"; /// /// DB record ID of the my profile /// + /// 4 public const uint Id = (uint)Property.Id.MyProfileId; /// /// Display name of the profile /// + /// 4 public const uint DisplayName = (uint)Property.Id.MyProfileDisplayName; /// /// AddressBook ID that the profile belongs to /// + /// 4 public const uint AddressBookId = (uint)Property.Id.MyProfileAddressBookId; /// /// Image thumbnail path of the profile /// + /// 4 public const uint ThumbnailPath = (uint)Property.Id.MyProfileThumbnail; /// /// Unique identifier /// + /// 4 public const uint UId = (uint)Property.Id.MyProfileUId; /// /// Last changed profile time /// + /// 4 public const uint ChangedTime = (uint)Property.Id.MyProfileChangedTime; /// /// Name child record (single) /// + /// 4 public const uint Name = (uint)Property.Id.MyProfileName; /// /// Company child record (multiple) /// + /// 4 public const uint Company = (uint)Property.Id.MyProfileCompany; /// /// Note child record (multiple) /// + /// 4 public const uint Note = (uint)Property.Id.MyProfileNote; /// /// Number child record (multiple) /// + /// 4 public const uint Number = (uint)Property.Id.MyProfileNumber; /// /// Email child record (multiple) /// + /// 4 public const uint Email = (uint)Property.Id.MyProfileEmail; /// /// Event child record (multiple) /// + /// 4 public const uint Event = (uint)Property.Id.MyProfileEvent; /// /// Messenger child record (multiple) /// + /// 4 public const uint Messenger = (uint)Property.Id.MyProfileMessenger; /// /// Address child record (multiple) /// + /// 4 public const uint Address = (uint)Property.Id.MyProfileAddress; /// /// URL child record (multiple) /// + /// 4 public const uint URL = (uint)Property.Id.MyProfileURL; /// /// Nickname child record (multiple) /// + /// 4 public const uint Nickname = (uint)Property.Id.MyProfileNickname; /// /// Profile child record (multiple) /// + /// 4 public const uint Profile = (uint)Property.Id.MyProfileProfile; /// /// Relationship child record (multiple) /// + /// 4 public const uint Relationship = (uint)Property.Id.MyProfileRelationship; /// /// Image child record (multiple) /// + /// 4 public const uint Image = (uint)Property.Id.MyProfileImage; /// /// Extension child record (multiple) /// + /// 4 public const uint Extension = (uint)Property.Id.MyProfileExtension; /// /// Sip child record (multiple) /// + /// 4 public const uint Sip = (uint)Property.Id.MyProfileSip; } @@ -1008,46 +1139,57 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts name view /// + /// 4 public const string Uri = "tizen.contacts_view.name"; /// /// DB record ID of the name /// + /// 4 public const uint Id = (uint)Property.Id.NameId; /// /// Contacts ID that the name record belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.NameContactId; /// /// First name /// + /// 4 public const uint First = (uint)Property.Id.NameFirst; /// /// Last name /// + /// 4 public const uint Last = (uint)Property.Id.NameLast; /// /// Middle name /// + /// 4 public const uint Addition = (uint)Property.Id.NameAddition; /// /// Suffix /// + /// 4 public const uint Suffix = (uint)Property.Id.NameSuffix; /// /// Prefix /// + /// 4 public const uint Prefix = (uint)Property.Id.NamePrefix; /// /// Pronounce the first name /// + /// 4 public const uint PhoneticFirst = (uint)Property.Id.NamePhoneticFirst; /// /// Pronounce the middle name /// + /// 4 public const uint PhoneticMiddle = (uint)Property.Id.NamePhoneticMiddle; /// /// Pronounce the last name /// + /// 4 public const uint PhoneticLast = (uint)Property.Id.NamePhoneticLast; } @@ -1060,42 +1202,52 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts number view /// + /// 4 public const string Uri = "tizen.contacts_view.number"; /// /// DB record ID of the number /// + /// 4 public const uint Id = (uint)Property.Id.NumberId; /// /// Contact ID that the number belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.NumberContactId; /// /// Number type, refer to the Types /// + /// 4 public const uint Type = (uint)Property.Id.NumberType; /// /// Custom number type label, when the number type is Types.Custom /// + /// 4 public const uint Label = (uint)Property.Id.NumberLabel; /// /// The number is default number or not /// + /// 4 public const uint IsDefault = (uint)Property.Id.NumberIsDefault; /// /// Number /// + /// 4 public const uint NumberData = (uint)Property.Id.NumberNumber; /// /// You can only use this property for search filter. /// + /// 4 public const uint NormalizedNumber = (uint)Property.Id.NumberNormalizedNumber; /// /// You can only use this property for search filter. /// + /// 4 public const uint CleanedNumber = (uint)Property.Id.NumberCleanedNumber; /// /// You can only use this property for search filter. /// + /// 4 public const uint NumberFilter = (uint)Property.Id.NumberNumberFilter; /// @@ -1108,78 +1260,97 @@ namespace Tizen.Pims.Contacts /// /// Other number type /// + /// 4 Other = 0, /// /// Custom number type /// + /// 4 Custom = 1 << 0, /// /// A telephone number associated with a residence /// + /// 4 Home = 1 << 1, /// /// A telephone number associated with a place of work /// + /// 4 Work = 1 << 2, /// /// A voice telephone number /// + /// 4 Voice = 1 << 3, /// /// A facsimile telephone number /// + /// 4 Fax = 1 << 4, /// /// The telephone number has voice messaging support /// + /// 4 Message = 1 << 5, /// /// A cellular telephone number /// + /// 4 Cell = 1 << 6, /// /// A paging device telephone number /// + /// 4 Pager = 1 << 7, /// /// A bulletin board system telephone number /// + /// 4 BBS = 1 << 8, /// /// A MODEM connected telephone number /// + /// 4 Modem = 1 << 9, /// /// A car-phone telephone number /// + /// 4 Car = 1 << 10, /// /// An ISDN service telephone number /// + /// 4 ISDN = 1 << 11, /// /// A video conferencing telephone number /// + /// 4 Video = 1 << 12, /// /// A personal communication services telephone number /// + /// 4 PCS = 1 << 13, /// /// A company main number /// + /// 4 Company = 1 << 14, /// /// A radio phone number /// + /// 4 Radio = 1 << 15, /// /// An additional type for main /// + /// 4 Main = 1 << 29, /// /// An additional type for assistant /// + /// 4 Assistant = 1 << 30, } } @@ -1193,30 +1364,37 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts email view /// + /// 4 public const string Uri = "tizen.contacts_view.email"; /// /// DB record ID of the email /// + /// 4 public const uint Id = (uint)Property.Id.EmailId; /// /// Contact ID that the email belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.EmailContactId; /// /// Email type, refer to the Types /// + /// 4 public const uint Type = (uint)Property.Id.EmailType; /// /// Custom mail type label, when the email type is Types.Custom /// + /// 4 public const uint Label = (uint)Property.Id.EmailLabel; /// /// The email is default email or not /// + /// 4 public const uint IsDefault = (uint)Property.Id.EmailIsDefault; /// /// Email address /// + /// 4 public const uint Address = (uint)Property.Id.EmailEmail; /// @@ -1229,22 +1407,27 @@ namespace Tizen.Pims.Contacts /// /// Other email type /// + /// 4 Other = 0, /// /// Custom email type /// + /// 4 Custom = 1 << 0, /// /// An email address associated with a residence /// + /// 4 Home = 1 << 1, /// /// An email address associated with a place of work /// + /// 4 Work = 1 << 2, /// /// A mobile email address /// + /// 4 Mobile = 1 << 3, } } @@ -1258,54 +1441,67 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts address view /// + /// 4 public const string Uri = "tizen.contacts_view.address"; /// /// DB record ID of the address /// + /// 4 public const uint Id = (uint)Property.Id.AddressId; /// /// Contact ID that the address belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.AddressContactId; /// /// Address type, refer to the Types /// + /// 4 public const uint Type = (uint)Property.Id.AddressType; /// /// Address type label, when the address type is Types.Custom /// + /// 4 public const uint Label = (uint)Property.Id.AddressLabel; /// /// Post office box /// + /// 4 public const uint Postbox = (uint)Property.Id.AddressPostbox; /// /// Postal code /// + /// 4 public const uint PostalCode = (uint)Property.Id.AddressPostalCode; /// /// Region /// + /// 4 public const uint Region = (uint)Property.Id.AddressRegion; /// /// Locality /// + /// 4 public const uint Locality = (uint)Property.Id.AddressLocality; /// /// Street /// + /// 4 public const uint Street = (uint)Property.Id.AddressStreet; /// /// Country /// + /// 4 public const uint Country = (uint)Property.Id.AddressCountry; /// /// Extended address /// + /// 4 public const uint Extended = (uint)Property.Id.AddressExtended; /// /// The address is default or not /// + /// 4 public const uint IsDefault = (uint)Property.Id.AddressIsDefault; /// @@ -1318,34 +1514,42 @@ namespace Tizen.Pims.Contacts /// /// Other address type /// + /// 4 Other = 0, /// /// Custom address type /// + /// 4 Custom = 1 << 0, /// /// A delivery address for a residence /// + /// 4 Home = 1 << 1, /// /// A delivery address for a place of work /// + /// 4 Work = 1 << 2, /// /// A domestic delivery address /// + /// 4 Domestic = 1 << 3, /// /// An international delivery address /// + /// 4 International = 1 << 4, /// /// A postal delivery address /// + /// 4 Postal = 1 << 5, /// /// A parcel delivery address /// + /// 4 Parcel = 1 << 6, } } @@ -1359,18 +1563,22 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts note view /// + /// 4 public const string Uri = "tizen.contacts_view.note"; /// /// DB record ID of the note /// + /// 4 public const uint Id = (uint)Property.Id.NoteId; /// /// Contact ID that the note belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.NoteContactId; /// /// Note contents /// + /// 4 public const uint Contents = (uint)Property.Id.NoteNote; } @@ -1383,26 +1591,32 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts URL view /// + /// 4 public const string Uri = "tizen.contacts_view.url"; /// /// DB record ID of the URL /// + /// 4 public const uint Id = (uint)Property.Id.URLId; /// /// Contact ID that the URL belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.URLContactId; /// /// URL type, refer to the TypeValue /// + /// 4 public const uint Type = (uint)Property.Id.URLType; /// /// Custom URL type label, when the URL type is TypeValue.Custom /// + /// 4 public const uint Label = (uint)Property.Id.URLLabel; /// /// URL /// + /// 4 public const uint URLData = (uint)Property.Id.URLData; /// @@ -1414,18 +1628,22 @@ namespace Tizen.Pims.Contacts /// /// Other URL type /// + /// 4 Other, /// /// Custom URL type /// + /// 4 Custom, /// /// Home URL type /// + /// 4 Home, /// /// Work URL type /// + /// 4 Work, } } @@ -1440,30 +1658,37 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts event view /// + /// 4 public const string Uri = "tizen.contacts_view.event"; /// /// DB record ID of the event /// + /// 4 public const uint Id = (uint)Property.Id.EventId; /// /// Contact ID that the event belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.EventContactId; /// /// Event type, refer to the TypeValue /// + /// 4 public const uint Type = (uint)Property.Id.EventType; /// /// Custom event type label, when the event type is TypeValue.Custom /// + /// 4 public const uint Label = (uint)Property.Id.EventLabel; /// /// Event date(YYYYMMDD). e.g. 2014/1/1 : 20140101. Even if the calendar_type is set as CONTACTS_EVENT_CALENDAR_TYPE_CHINESE, you SHOULD set Gregorian date /// + /// 4 public const uint Date = (uint)Property.Id.EventDate; /// /// Calendar type, refer to the CalendarType /// + /// 4 public const uint IsLeapMonth = (uint)Property.Id.EventIsLeapMonth; /// @@ -1475,18 +1700,22 @@ namespace Tizen.Pims.Contacts /// /// Other event type /// + /// 4 Other, /// /// Custom event type /// + /// 4 Custom, /// /// Birthday event type /// + /// 4 Birthday, /// /// Anniversary event type /// + /// 4 Anniversary } @@ -1499,10 +1728,12 @@ namespace Tizen.Pims.Contacts /// /// Gregorian calendar /// + /// 4 Gregorian, /// /// Chinese calendar /// + /// 4 Chinese } } @@ -1516,26 +1747,32 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this relationship view /// + /// 4 public const string Uri = "tizen.contacts_view.relationship"; /// /// DB record ID of the relationship /// + /// 4 public const uint Id = (uint)Property.Id.RelationshipId; /// /// Contact ID that the relationship belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.RelationshipContactId; /// /// Relationship type, refer to the TypeValue /// + /// 4 public const uint Type = (uint)Property.Id.RelationshipType; /// /// Custom relationship type label, when the relationship type is TypeValue.Custom /// + /// 4 public const uint Label = (uint)Property.Id.RelationshipLabel; /// /// Selected contact name that the relationship belongs to /// + /// 4 public const uint Name = (uint)Property.Id.RelationshipName; /// @@ -1547,66 +1784,82 @@ namespace Tizen.Pims.Contacts /// /// Other relationship type /// + /// 4 Other, /// /// Assistant type /// + /// 4 Assistant, /// /// Brother type /// + /// 4 Brother, /// /// Child type /// + /// 4 Child, /// /// Domestic Partner type /// + /// 4 DomesticPartner, /// /// Father type /// + /// 4 Father, /// /// Friend type /// + /// 4 Friend, /// /// Manager type /// + /// 4 Manager, /// /// Mother type /// + /// 4 Mother, /// /// Parent type /// + /// 4 Parent, /// /// Partner type /// + /// 4 Partner, /// /// Referred by type /// + /// 4 ReferredBy, /// /// Relative type /// + /// 4 Relative, /// /// Sister type /// + /// 4 Sister, /// /// Spouse type /// + /// 4 Spouse, /// /// Custom type /// + /// 4 Custom, } } @@ -1620,30 +1873,37 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts image view /// + /// 4 public const string Uri = "tizen.contacts_view.image"; /// /// DB record ID of the image /// + /// 4 public const uint Id = (uint)Property.Id.ImageId; /// /// Contact ID that the image belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.ImageContactId; /// /// Image type, refer to the TypeValue /// + /// 4 public const uint Type = (uint)Property.Id.ImageType; /// /// Custom image type label, when the image type is TypeValue.Custom /// + /// 4 public const uint Label = (uint)Property.Id.ImageLabel; /// /// Image thumbnail path /// + /// 4 public const uint Path = (uint)Property.Id.ImagePath; /// /// The Image is default or not /// + /// 4 public const uint IsDefault = (uint)Property.Id.ImageIsDefault; /// @@ -1655,10 +1915,12 @@ namespace Tizen.Pims.Contacts /// /// Other type /// + /// 4 Other, /// /// Custom type /// + /// 4 Custom, } } @@ -1672,58 +1934,72 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts company view /// + /// 4 public const string Uri = "tizen.contacts_view.company"; /// /// DB record ID of the company /// + /// 4 public const uint Id = (uint)Property.Id.CompanyId; /// /// Contact ID that the company belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.CompanyContactId; /// /// Company type, refer to the TypeValue /// + /// 4 public const uint Type = (uint)Property.Id.CompanyType; /// /// Custom company type label, when the company type is TypeValue.Custom /// + /// 4 public const uint Label = (uint)Property.Id.CompanyLabel; /// /// Company name /// + /// 4 public const uint Name = (uint)Property.Id.CompanyName; /// /// Department /// + /// 4 public const uint Department = (uint)Property.Id.CompanyDepartment; /// /// Job title /// + /// 4 public const uint JobTitle = (uint)Property.Id.CompanyJobTitle; /// /// Assistant name /// + /// 4 public const uint AssistantName = (uint)Property.Id.CompanyAssistantName; /// /// Role /// + /// 4 public const uint Role = (uint)Property.Id.CompanyRole; /// /// Company logo image file path /// + /// 4 public const uint Logo = (uint)Property.Id.CompanyLogo; /// /// Company location /// + /// 4 public const uint Location = (uint)Property.Id.CompanyLocation; /// /// Description /// + /// 4 public const uint Description = (uint)Property.Id.CompanyDescription; /// /// Pronounce the company name /// + /// 4 public const uint PhoneticName = (uint)Property.Id.CompanyPhoneticName; /// @@ -1735,14 +2011,17 @@ namespace Tizen.Pims.Contacts /// /// Other type /// + /// 4 Other = 0, /// /// Custom type /// + /// 4 Custom = 1 << 0, /// /// Work type /// + /// 4 Work = 1 << 1, } } @@ -1756,18 +2035,22 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts nickname view /// + /// 4 public const string Uri = "tizen.contacts_view.nickname"; /// /// DB record ID of the nickname /// + /// 4 public const uint Id = (uint)Property.Id.NicknameId; /// /// Contact ID that the nickname belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.NicknameContactId; /// /// Nickname /// + /// 4 public const uint Name = (uint)Property.Id.NicknameName; } @@ -1780,26 +2063,32 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts messenger view /// + /// 4 public const string Uri = "tizen.contacts_view.messenger"; /// /// DB record ID of the messenger /// + /// 4 public const uint Id = (uint)Property.Id.MessengerId; /// /// Contact ID that the messenger belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.MessengerContactId; /// /// Messenger type, refer to the TypeValue /// + /// 4 public const uint Type = (uint)Property.Id.MessengerType; /// /// Custom messenger type label, when the messenger type is TypeValue.Custom /// + /// 4 public const uint Label = (uint)Property.Id.MessengerLabel; /// /// Messenger ID (email address or email ID...) /// + /// 4 public const uint IMId = (uint)Property.Id.MessengerIMId; /// @@ -1811,50 +2100,62 @@ namespace Tizen.Pims.Contacts /// /// Other messenger type /// + /// 4 Other, /// /// Custom messenger type /// + /// 4 Custom, /// /// Google messenger type /// + /// 4 Google, /// /// Windows live messenger type /// + /// 4 WindowsLive, /// /// Yahoo messenger type /// + /// 4 Yahoo, /// /// Facebook messenger type /// + /// 4 Facebook, /// /// ICQ type /// + /// 4 ICQ, /// /// AOL instance messenger type /// + /// 4 AOL, /// /// QQ type /// + /// 4 QQ, /// /// Jabber type /// + /// 4 Jabber, /// /// Skype type /// + /// 4 Skype, /// /// IRC type /// + /// 4 IRC, } } @@ -1869,50 +2170,62 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts profile view /// + /// 4 public const string Uri = "tizen.contacts_view.profile"; /// /// DB record ID of profile /// + /// 4 public const uint Id = (uint)Property.Id.ProfileId; /// /// Contacts ID that the profile belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.ProfileContactId; /// /// Unique identifier /// + /// 4 public const uint UId = (uint)Property.Id.ProfileUId; /// /// Profile contents /// + /// 4 public const uint Text = (uint)Property.Id.ProfileText; /// /// Priority to display the profile /// + /// 4 public const uint Order = (uint)Property.Id.ProfileOrder; /// /// Data for app_control_set_operation /// + /// 4 public const uint ServiceOperation = (uint)Property.Id.ProfileServiceOperation; /// /// Data for app_control_set_mime /// + /// 4 public const uint Mime = (uint)Property.Id.ProfileMIME; /// /// Data for app_control_set_app_id /// + /// 4 public const uint AppId = (uint)Property.Id.ProfileAppId; /// /// Data for app_control_set_uri /// + /// 4 public const uint ProfileUri = (uint)Property.Id.ProfileUri; /// /// Data for app_control_set_category /// + /// 4 public const uint Category = (uint)Property.Id.ProfileCategory; /// /// It includes "key:value,key:value," pairs. You should parse it. And you must base64 encode each key and value /// + /// 4 public const uint ExtraData = (uint)Property.Id.ProfileExtraData; } @@ -1925,26 +2238,32 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts sip view /// + /// 4 public const string Uri = "tizen.contacts_view.sip"; /// /// DB record ID of the sip /// + /// 4 public const uint Id = (uint)Property.Id.SipId; /// /// Contact ID that the sip belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.SipContactId; /// /// SIP address /// + /// 4 public const uint Address = (uint)Property.Id.SipAddress; /// /// sip type, refer to the TypeValue /// + /// 4 public const uint Type = (uint)Property.Id.SipType; /// /// Custom sip type label, when the sip type is TypeValue.Custom /// + /// 4 public const uint Label = (uint)Property.Id.SipLabel; /// @@ -1956,18 +2275,22 @@ namespace Tizen.Pims.Contacts /// /// Other SIP type /// + /// 4 Other, /// /// Custom SIP type /// + /// 4 Custom, /// /// Home SIP type /// + /// 4 Home, /// /// Work SIP type /// + /// 4 Work, } } @@ -1981,62 +2304,77 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts extension view /// + /// 4 public const string Uri = "tizen.contacts_view.extension"; /// /// DB record ID of the contact extension /// + /// 4 public const uint Id = (uint)Property.Id.ExtensionId; /// /// Contact ID that the contact extension belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.ExtensionContactId; /// /// The extra child record format for non-provided from contacts-service /// + /// 4 public const uint Data1 = (uint)Property.Id.ExtensionData1; /// /// The extra child record format for non-provided from contacts-service /// + /// 4 public const uint Data2 = (uint)Property.Id.ExtensionData2; /// /// The extra child record format for non-provided from contacts-service /// + /// 4 public const uint Data3 = (uint)Property.Id.ExtensionData3; /// /// The extra child record format for non-provided from contacts-service /// + /// 4 public const uint Data4 = (uint)Property.Id.ExtensionData4; /// /// The extra child record format for non-provided from contacts-service /// + /// 4 public const uint Data5 = (uint)Property.Id.ExtensionData5; /// /// The extra child record format for non-provided from contacts-service /// + /// 4 public const uint Data6 = (uint)Property.Id.ExtensionData6; /// /// The extra child record format for non-provided from contacts-service /// + /// 4 public const uint Data7 = (uint)Property.Id.ExtensionData7; /// /// The extra child record format for non-provided from contacts-service /// + /// 4 public const uint Data8 = (uint)Property.Id.ExtensionData8; /// /// The extra child record format for non-provided from contacts-service /// + /// 4 public const uint Data9 = (uint)Property.Id.ExtensionData9; /// /// The extra child record format for non-provided from contacts-service /// + /// 4 public const uint Data10 = (uint)Property.Id.ExtensionData10; /// /// The extra child record format for non-provided from contacts-service /// + /// 4 public const uint Data11 = (uint)Property.Id.ExtensionData11; /// /// The extra child record format for non-provided from contacts-service /// + /// 4 public const uint Data12 = (uint)Property.Id.ExtensionData12; } @@ -2049,22 +2387,27 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this relationship view /// + /// 4 public const string Uri = "tizen.contacts_view.group_relation"; /// /// DB record ID of the group relation (can not be used as filter) /// + /// 4 public const uint Id = (uint)Property.Id.GroupRelationId; /// /// DB record ID of the group /// + /// 4 public const uint GroupId = (uint)Property.Id.GroupRelationGroupId; /// /// DB record ID of the contact /// + /// 4 public const uint ContactId = (uint)Property.Id.GroupRelationContactId; /// /// Group name /// + /// 4 public const uint Name = (uint)Property.Id.GroupRelationGroupName; } @@ -2077,50 +2420,62 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contact speed dial view /// + /// 4 public const string Uri = "tizen.contacts_view.speeddial"; /// /// Stored speed dial number /// + /// 4 public const uint SpeedDialNumber = (uint)Property.Id.SpeedDialDialNumber; /// /// Number ID that the speed dial belongs to /// + /// 4 public const uint NumberId = (uint)Property.Id.SpeedDialNumberId; /// /// Contact number of specified speed dial /// + /// 4 public const uint Number = (uint)Property.Id.SpeedDialNumber; /// /// Contact number label of specified speed dial, when the number type is Number.Types.Custom /// + /// 4 public const uint NumberLabel = (uint)Property.Id.SpeedDialNumberLabel; /// /// Contact number type, refer to the Number.Types /// + /// 4 public const uint NumberType = (uint)Property.Id.SpeedDialNumberType; /// /// Person ID that the speed dial belongs to /// + /// 4 public const uint PersonId = (uint)Property.Id.SpeedDialPersonId; /// /// Display name that the speed dial belongs to /// + /// 4 public const uint DisplayName = (uint)Property.Id.SpeedDialDisplayName; /// /// Image thumbnail path that the speed dial belongs to /// + /// 4 public const uint ThumbnailPath = (uint)Property.Id.SpeedDialThumbnail; /// /// You can only use this property for search filter /// + /// 4 public const uint NormalizedNumber = (uint)Property.Id.SpeedDialNormalizedNumber; /// /// You can only use this property for search filter /// + /// 4 public const uint CleanedNumber = (uint)Property.Id.SpeedDialCleanedNumber; /// /// If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly /// + /// 4 public const uint NumberFilter = (uint)Property.Id.SpeedDialNumberFilter; } @@ -2133,50 +2488,62 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this phone log view /// + /// 4 public const string Uri = "tizen.contacts_view.phonelog"; /// /// DB record ID of phone log /// + /// 4 public const uint Id = (uint)Property.Id.PhonelogId; /// /// Person ID that the phone log belongs to /// + /// 4 public const uint PersonId = (uint)Property.Id.PhonelogPersonId; /// /// Number or Email that the phone log displays /// + /// 4 public const uint Address = (uint)Property.Id.PhonelogAddress; /// /// Call end time. The value means number of seconds since 1970-01-01 00:00:00 (UTC) /// + /// 4 public const uint LogTime = (uint)Property.Id.PhonelogLogTime; /// /// Log type, refer to the Type /// + /// 4 public const uint LogType = (uint)Property.Id.PhonelogLogType; /// /// You can set the related integer data (e.g. message_id, email_id or duration(seconds) of call) /// + /// 4 public const uint ExtraData1 = (uint)Property.Id.PhonelogExtraData1; /// /// You can set the related string data (e.g. short message, subject) /// + /// 4 public const uint ExtraData2 = (uint)Property.Id.PhonelogExtraData2; /// /// You can only use this property for search filter /// + /// 4 public const uint NormalizedAddress = (uint)Property.Id.PhonelogNormalizedAddress; /// /// You can only use this property for search filter /// + /// 4 public const uint CleanedAddress = (uint)Property.Id.PhonelogCleanedAddress; /// /// You can only use this property for search filter /// + /// 4 public const uint AddressFilter = (uint)Property.Id.PhonelogAddressFilter; /// /// You can set the related Sim slot number. SimSlotNo 0 means first Sim card, SimSlotNo 1 means second Sim. /// + /// 4 public const uint SimSlotNo = (uint)Property.Id.PhonelogSimSlotNo; /// @@ -2188,86 +2555,107 @@ namespace Tizen.Pims.Contacts /// /// None /// + /// 4 None, /// /// Incoming call /// + /// 4 VoiceIncoming = 1, /// /// Outgoing call /// + /// 4 VoiceOutgoing = 2, /// /// Incoming video call /// + /// 4 VideoIncoming = 3, /// /// Outgoing video call /// + /// 4 VideoOutgoing = 4, /// /// Not confirmed missed call /// + /// 4 VoiceMissedUnseen = 5, /// /// Confirmed missed call /// + /// 4 VoiceMissedSeen = 6, /// /// Not confirmed missed video call /// + /// 4 VideoMissedUnseen = 7, /// /// Confirmed missed video call /// + /// 4 VideoMissedSeen = 8, /// /// Rejected call /// + /// 4 VoiceRejected = 9, /// /// Rejected video call /// + /// 4 VideoRejected = 10, /// /// Blocked call /// + /// 4 VoiceBlocked = 11, /// /// Blocked video call /// + /// 4 VideoBlocked = 12, /// /// Incoming MMS /// + /// 4 MMSIncoming = 101, /// /// Outgoing MMS /// + /// 4 MMSOutgoing = 102, /// /// Incoming SMS /// + /// 4 SMSIncoming = 103, /// /// Outgoing SMS /// + /// 4 SMSOutgoing = 104, /// /// Blocked SMS /// + /// 4 SMSBlocked = 105, /// /// Blocked MMS /// + /// 4 MMSBlocked = 106, /// /// Received email /// + /// 4 EmailReceived = 201, /// /// Sent email /// + /// 4 EmailSent = 202, } @@ -2283,26 +2671,32 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contact updated info view /// + /// 4 public const string Uri = "tizen.contacts_view.contacts_updated_info"; /// /// Updated contact ID /// + /// 4 public const uint ContactId = (uint)Property.Id.UpdateInfoId; /// /// AddressBook ID that the updated contact belongs to /// + /// 4 public const uint AddressBookId = (uint)Property.Id.UpdateInfoAddressBookId; /// /// Contact change type, refer to the ContactsViews.ChangeType /// + /// 4 public const uint Type = (uint)Property.Id.UpdateInfoType; /// /// Updated version /// + /// 4 public const uint Version = (uint)Property.Id.UpdateInfoVersion; /// /// Contact image is changed or not /// + /// 4 public const uint ImageChanged = (uint)Property.Id.UpdateInfoImageChanged; } @@ -2316,18 +2710,22 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this my profile updated info view /// + /// 4 public const string Uri = "tizen.contacts_view.my_profile_updated_info"; /// /// Address book ID that the updated my profile belongs to /// + /// 4 public const uint AddressBookId = (uint)Property.Id.UpdateInfoAddressBookId; /// /// MyProfile change type, refer to the ContactsViews.ChangeType /// + /// 4 public const uint LastChangedType = (uint)Property.Id.UpdateInfoLastChangedType; /// /// Updated version /// + /// 4 public const uint Version = (uint)Property.Id.UpdateInfoVersion; } @@ -2341,22 +2739,27 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this group updated info view /// + /// 4 public const string Uri = "tizen.contacts_view.groups_updated_info"; /// /// Updated group ID /// + /// 4 public const uint GroupId = (uint)Property.Id.UpdateInfoId; /// /// Address book ID that the updated group belongs to /// + /// 4 public const uint AddressBookId = (uint)Property.Id.UpdateInfoAddressBookId; /// /// Group change type, refer to the ContactsViews.ChangeType /// + /// 4 public const uint Type = (uint)Property.Id.UpdateInfoType; /// /// Updated version /// + /// 4 public const uint Version = (uint)Property.Id.UpdateInfoVersion; } @@ -2370,18 +2773,22 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this group member updated info view /// + /// 4 public const string Uri = "tizen.contacts_view.groups_member_updated_info"; /// /// Updated group ID /// + /// 4 public const uint GroupId = (uint)Property.Id.UpdateInfoId; /// /// Address book ID that the updated group belongs to /// + /// 4 public const uint AddressBookId = (uint)Property.Id.UpdateInfoAddressBookId; /// /// Updated version /// + /// 4 public const uint Version = (uint)Property.Id.UpdateInfoVersion; } @@ -2395,26 +2802,32 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this group relation updated info view /// + /// 4 public const string Uri = "tizen.contacts_view.group_relations_updated_info"; /// /// Group ID of group relation /// + /// 4 public const uint GroupId = (uint)Property.Id.GroupId; /// /// Contact ID of the updated group relation /// + /// 4 public const uint ContactId = (uint)Property.Id.ContactId; /// /// Address book ID of contact that the updated group relation /// + /// 4 public const uint AddressBookId = (uint)Property.Id.AddressBookId; /// /// Group relation change type, refer to the ContactsViews.ChangeType /// + /// 4 public const uint Type = (uint)Property.Id.UpdateInfoType; /// /// Updated version /// + /// 4 public const uint Version = (uint)Property.Id.UpdateInfoVersion; } @@ -2428,86 +2841,107 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this person contact view /// + /// 4 public const string Uri = "tizen.contacts_view.person/simple_contact"; /// /// DB record ID of the person /// + /// 4 public const uint PersonId = (uint)Property.Id.PersonId; /// /// Display name of the person /// + /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// /// The first character of first string for grouping. This is normalized using ICU (projection) /// + /// 4 public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex; /// /// Display contact ID that the person belongs to (projection) /// + /// 4 public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId; /// /// Ringtone path of the person (projection) /// + /// 4 public const uint RingtonePath = (uint)Property.Id.PersonRingtone; /// /// Image thumbnail path of the person (projection) /// + /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// /// Vibration path of the person (projection) /// + /// 4 public const uint Vibration = (uint)Property.Id.PersonVibration; /// /// Message alert path of the person (projection) /// + /// 4 public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert; /// /// Status of social account (projection) /// + /// 4 public const uint Status = (uint)Property.Id.PersonStatus; /// /// The person is favorite or not /// + /// 4 public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite; /// /// Link count of contact records (projection) /// + /// 4 public const uint LinkCount = (uint)Property.Id.PersonLinkCount; /// /// Contact ID that the person belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.ContactId; /// /// AddressBook IDs that the person belongs to (projection) /// + /// 4 public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds; /// /// The person has phone number or not /// + /// 4 public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber; /// /// The person has email or not /// + /// 4 public const uint HasEmail = (uint)Property.Id.PersonHasEmail; /// /// AddressBook ID that the person belongs to /// + /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// /// AddressBook mode, refer to the AddressBook.Mode /// + /// 4 public const uint AddressBookMode = (uint)Property.Id.AddressBookMode; /// /// AddressBook name that the person belongs to /// + /// 4 public const uint AddressBookName = (uint)Property.Id.AddressBookName; /// /// keyword matched data type, refer to the Contact.DataType /// + /// 4 public const uint SnippetType = (uint)Property.Id.PersonSnippetType; /// /// keyword matched data string /// + /// 4 public const uint SnippetString = (uint)Property.Id.PersonSnippetString; }; @@ -2521,90 +2955,112 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this person number view /// + /// 4 public const string Uri = "tizen.contacts_view.person/simple_contact/number"; /// /// DB record ID of the person /// + /// 4 public const uint PersonId = (uint)Property.Id.PersonId; /// /// Display name of the person /// + /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// /// The first character of first string for grouping. This is normalized using ICU (projection) /// + /// 4 public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex; /// /// Display contact ID that the person belongs to (projection) /// + /// 4 public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId; /// /// Ringtone path of the person (projection) /// + /// 4 public const uint RingtonePath = (uint)Property.Id.PersonRingtone; /// /// Image thumbnail path of the person (projection) /// + /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// /// Vibration path of the person (projection) /// + /// 4 public const uint Vibration = (uint)Property.Id.PersonVibration; /// /// Message alert path of the person (projection) /// + /// 4 public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert; /// /// The person is favorite or not /// + /// 4 public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite; /// /// The person has phone number or not /// + /// 4 public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber; /// /// The person has email or not /// + /// 4 public const uint HasEmail = (uint)Property.Id.PersonHasEmail; /// /// Number ID that the person belongs to /// + /// 4 public const uint NumberId = (uint)Property.Id.NumberId; /// /// Number type, refer to the Number.Types (projection) /// + /// 4 public const uint Type = (uint)Property.Id.NumberType; /// /// Custom number type label, when the number type is Number.Types.Custom (projection) /// + /// 4 public const uint Label = (uint)Property.Id.NumberLabel; /// /// The number is default number or not /// + /// 4 public const uint IsPrimaryDefault = (uint)Property.Id.DataIsPrimaryDefault; /// /// Number /// + /// 4 public const uint Number = (uint)Property.Id.NumberNumber; /// /// If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly. /// + /// 4 public const uint NumberFilter = (uint)Property.Id.NumberNumberFilter; /// /// You can only use this property for search filter /// + /// 4 public const uint NormalizedNumber = (uint)Property.Id.NumberNormalizedNumber; /// /// You can only use this property for search filter /// + /// 4 public const uint CleanedNumber = (uint)Property.Id.NumberCleanedNumber; /// /// keyword matched data type, refer to they Contact.DataType /// + /// 4 public const uint SnippetType = (uint)Property.Id.PersonSnippetType; /// /// keyword matched data string /// + /// 4 public const uint SnippetString = (uint)Property.Id.PersonSnippetString; }; @@ -2618,78 +3074,97 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this person email view /// + /// 4 public const string Uri = "tizen.contacts_view.person/simple_contact/email"; /// /// DB record ID of the person /// + /// 4 public const uint PersonId = (uint)Property.Id.PersonId; /// /// Display name of the person /// + /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// /// The first character of first string for grouping. This is normalized using ICU (projection) /// + /// 4 public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex; /// /// Display contact ID that the person belongs to (projection) /// + /// 4 public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId; /// /// Ringtone path of the person (projection) /// + /// 4 public const uint RingtonePath = (uint)Property.Id.PersonRingtone; /// /// Image thumbnail path of the person (projection) /// + /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// /// Vibration path of the person (projection) /// + /// 4 public const uint Vibration = (uint)Property.Id.PersonVibration; /// /// Message alert path of the person (projection) /// + /// 4 public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert; /// /// The person is favorite or not /// + /// 4 public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite; /// /// The person has phone number or not /// + /// 4 public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber; /// /// The person has email or not /// + /// 4 public const uint HasEmail = (uint)Property.Id.PersonHasEmail; /// /// Email ID that the person belongs to /// + /// 4 public const uint EmailId = (uint)Property.Id.EmailId; /// /// Email type, refer to the Email.Types (projection) /// + /// 4 public const uint Type = (uint)Property.Id.EmailType; /// /// Custom mail type label, when the email type is Email.Types.Custom (projection) /// + /// 4 public const uint Label = (uint)Property.Id.EmailLabel; /// /// The email is default email or not /// + /// 4 public const uint IsPrimaryDefault = (uint)Property.Id.DataIsPrimaryDefault; /// /// Email address /// + /// 4 public const uint Email = (uint)Property.Id.EmailEmail; /// /// keyword matched data type, refer to they Contact.DataType /// + /// 4 public const uint SnippetType = (uint)Property.Id.PersonSnippetType; /// /// keyword matched data string /// + /// 4 public const uint SnippetString = (uint)Property.Id.PersonSnippetString; }; @@ -2703,90 +3178,112 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this person group relation view /// + /// 4 public const string Uri = "tizen.contacts_view.person/simple_contact/group"; /// /// DB record ID of the person /// + /// 4 public const uint PersonId = (uint)Property.Id.PersonId; /// /// Display name of the person /// + /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// /// The first character of first string for grouping. This is normalized using ICU (projection) /// + /// 4 public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex; /// /// Display contact ID that the person belongs to (projection) /// + /// 4 public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId; /// /// Ringtone path of the person (projection) /// + /// 4 public const uint RingtonePath = (uint)Property.Id.PersonRingtone; /// /// Image thumbnail path of the person (projection) /// + /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// /// Vibration path of the person (projection) /// + /// 4 public const uint Vibration = (uint)Property.Id.PersonVibration; /// /// Message alert path of the person (projection) /// + /// 4 public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert; /// /// Status of social account (projection) /// + /// 4 public const uint Status = (uint)Property.Id.PersonStatus; /// /// The person is favorite or not /// + /// 4 public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite; /// /// The person has phone number or not /// + /// 4 public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber; /// /// The person has email or not /// + /// 4 public const uint HasEmail = (uint)Property.Id.PersonHasEmail; /// /// Link count of contact records (projection) /// + /// 4 public const uint LinkCount = (uint)Property.Id.PersonLinkCount; /// /// AddressBook IDs that the person belongs to (projection) /// + /// 4 public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds; /// /// AddressBook ID that the person belongs to /// + /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// /// AddressBook name that the person belongs to /// + /// 4 public const uint AddressBookName = (uint)Property.Id.AddressBookName; /// /// AddressBook mode, refer to the AddressBook.Mode /// + /// 4 public const uint AddressBookMode = (uint)Property.Id.AddressBookMode; /// /// Group ID that the person belongs to /// + /// 4 public const uint GroupId = (uint)Property.Id.GroupRelationGroupId; /// /// Contact ID that the person belongs to (projection) /// + /// 4 public const uint ContactId = (uint)Property.Id.GroupRelationContactId; /// /// keyword matched data type, refer to they Contact.DataType /// + /// 4 public const uint SnippetType = (uint)Property.Id.PersonSnippetType; /// /// keyword matched data string /// + /// 4 public const uint SnippetString = (uint)Property.Id.PersonSnippetString; }; @@ -2800,86 +3297,107 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this person group assigned view /// + /// 4 public const string Uri = "tizen.contacts_view.person/simple_contact/group_assigned"; /// /// DB record ID of the person /// + /// 4 public const uint PersonId = (uint)Property.Id.PersonId; /// /// Display name of the person /// + /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// /// The first character of first string for grouping. This is normalized using ICU (projection) /// + /// 4 public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex; /// /// Display contact ID that the person belongs to (projection) /// + /// 4 public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId; /// /// Ringtone path of the person (projection) /// + /// 4 public const uint RingtonePath = (uint)Property.Id.PersonRingtone; /// /// Image thumbnail path of the person (projection) /// + /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// /// Vibration path of the person (projection) /// + /// 4 public const uint Vibration = (uint)Property.Id.PersonVibration; /// /// Message alert path of the person (projection) /// + /// 4 public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert; /// /// Status of social account (projection) /// + /// 4 public const uint Status = (uint)Property.Id.PersonStatus; /// /// The person is favorite or not /// + /// 4 public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite; /// /// The person has phone number or not /// + /// 4 public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber; /// /// The person has email or not /// + /// 4 public const uint HasEmail = (uint)Property.Id.PersonHasEmail; /// /// Link count of contact records (projection) /// + /// 4 public const uint LinkCount = (uint)Property.Id.PersonLinkCount; /// /// AddressBook IDs that the linked person belongs to (projection) /// + /// 4 public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds; /// /// AddressBook ID that the person belongs to /// + /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// /// AddressBook mode, refer to the AddressBook.Mode /// + /// 4 public const uint AddressBookMode = (uint)Property.Id.AddressBookMode; /// /// Group ID that the person belongs to /// + /// 4 public const uint GroupId = (uint)Property.Id.GroupRelationGroupId; /// /// Contact ID that the person belongs to (projection) /// + /// 4 public const uint ContactId = (uint)Property.Id.GroupRelationContactId; /// /// keyword matched data type, refer to they Contact.DataType /// + /// 4 public const uint SnippetType = (uint)Property.Id.PersonSnippetType; /// /// keyword matched data string /// + /// 4 public const uint SnippetString = (uint)Property.Id.PersonSnippetString; }; @@ -2893,82 +3411,102 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this person group not assigned view /// + /// 4 public const string Uri = "tizen.contacts_view.person/simple_contact/group_not_assigned"; /// /// DB record ID of the person /// + /// 4 public const uint PersonId = (uint)Property.Id.PersonId; /// /// Display name of the person /// + /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// /// The first character of first string for grouping. This is normalized using ICU (projection) /// + /// 4 public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex; /// /// Display contact ID that the person belongs to (projection) /// + /// 4 public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId; /// /// Ringtone path of the person (projection) /// + /// 4 public const uint RingtonePath = (uint)Property.Id.PersonRingtone; /// /// Image thumbnail path of the person (projection) /// + /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// /// Vibration path of the person (projection) /// + /// 4 public const uint Vibration = (uint)Property.Id.PersonVibration; /// /// Message alert path of the person (projection) /// + /// 4 public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert; /// /// Status of social account (projection) /// + /// 4 public const uint Status = (uint)Property.Id.PersonStatus; /// /// The person is favorite or not /// + /// 4 public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite; /// /// The person has phone number or not /// + /// 4 public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber; /// /// The person has email or not /// + /// 4 public const uint HasEmail = (uint)Property.Id.PersonHasEmail; /// /// Link count of contact records (projection) /// + /// 4 public const uint LinkCount = (uint)Property.Id.PersonLinkCount; /// /// AddressBook IDs that the linked person belongs to (projection) /// + /// 4 public const uint AddressBookIds = (uint)Property.Id.PersonAddressBookIds; /// /// AddressBook ID that the person belongs to /// + /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// /// AddressBook mode, refer to the AddressBook.Mode /// + /// 4 public const uint AddressBookMode = (uint)Property.Id.AddressBookMode; /// /// Contact ID that the person belongs to (projection) /// + /// 4 public const uint ContactId = (uint)Property.Id.ContactId; /// /// keyword matched data type, refer to they Contact.DataType /// + /// 4 public const uint SnippetType = (uint)Property.Id.PersonSnippetType; /// /// keyword matched data string /// + /// 4 public const uint SnippetString = (uint)Property.Id.PersonSnippetString; }; @@ -2982,62 +3520,77 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this phone log view /// + /// 4 public const string Uri = "tizen.contacts_view.person/simple_contact/phonelog"; /// /// DB record ID of the person /// + /// 4 public const uint PersonId = (uint)Property.Id.PersonId; /// /// Display name of the person /// + /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// /// Image thumbnail path of the person (projection) /// + /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// /// DB record ID of phone log /// + /// 4 public const uint LogId = (uint)Property.Id.PhonelogId; /// /// Number or Email that the phone log displays /// + /// 4 public const uint Address = (uint)Property.Id.PhonelogAddress; /// /// Number or Email type (projection) /// + /// 4 public const uint AddressType = (uint)Property.Id.DataData1; /// /// Call end time. The value means number of seconds since 1970-01-01 00:00:00 (UTC) /// + /// 4 public const uint LogTime = (uint)Property.Id.PhonelogLogTime; /// /// Log type, refer to the PhoneLog.Types /// + /// 4 public const uint LogType = (uint)Property.Id.PhonelogLogType; /// /// You can set the related integer data (e.g. message_id, email_id or duration(seconds) of call) (projection) /// + /// 4 public const uint ExtraData1 = (uint)Property.Id.PhonelogExtraData1; /// /// You can set the related string data (e.g. short message, subject) (projection) /// + /// 4 public const uint ExtraData2 = (uint)Property.Id.PhonelogExtraData2; /// /// You can only use this property for search filter /// + /// 4 public const uint NormalizedAddress = (uint)Property.Id.PhonelogNormalizedAddress; /// /// You can only use this property for search filter /// + /// 4 public const uint CleanedAddress = (uint)Property.Id.PhonelogCleanedAddress; /// /// You can only use this property for search filter /// + /// 4 public const uint AddressFilter = (uint)Property.Id.PhonelogAddressFilter; /// /// It is related to the Sim slot number. SimSlotNo 0 means first Sim card, SimSlotNo 1 means second Sim. /// + /// 4 public const uint SimSlotNo = (uint)Property.Id.PhonelogSimSlotNo; }; @@ -3051,58 +3604,72 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this person usage view /// + /// 4 public const string Uri = "tizen.contacts_view.person/usag"; /// /// DB record ID of the person /// + /// 4 public const uint PersonId = (uint)Property.Id.PersonId; /// /// Display name of the person /// + /// 4 public const uint DisplayName = (uint)Property.Id.PersonDisplayName; /// /// The first character of first string for grouping. This is normalized using ICU (projection) /// + /// 4 public const uint DisplayNameIndex = (uint)Property.Id.PersonDisplayNameIndex; /// /// Display contact ID that the person belongs to (projection) /// + /// 4 public const uint DisplayContactId = (uint)Property.Id.PersonDisplayContactId; /// /// Ringtone path of the person (projection) /// + /// 4 public const uint RingtonePath = (uint)Property.Id.PersonRingtone; /// /// Image thumbnail path of the person (projection) /// + /// 4 public const uint ThumbnailPath = (uint)Property.Id.PersonThumbnail; /// /// Vibration path of the person (projection) /// + /// 4 public const uint Vibration = (uint)Property.Id.PersonVibration; /// /// Message alert path of the person (projection) /// + /// 4 public const uint MessageAlert = (uint)Property.Id.PersonMessageAlert; /// /// The person is favorite or not /// + /// 4 public const uint IsFavorite = (uint)Property.Id.PersonIsFavorite; /// /// The person has phone number or not /// + /// 4 public const uint HasPhoneNumber = (uint)Property.Id.PersonHasPhoneNumber; /// /// The person has email or not /// + /// 4 public const uint HasEmail = (uint)Property.Id.PersonHasEmail; /// /// Usage type, refer to the Type /// + /// 4 public const uint UsageType = (uint)Property.Id.PersonUsageType; /// /// Usage number of person /// + /// 4 public const uint TimesUsed = (uint)Property.Id.PersonTimesUsed; /// @@ -3114,46 +3681,57 @@ namespace Tizen.Pims.Contacts /// /// None /// + /// 4 None, /// /// Outgoing call /// + /// 4 OutgoingCall, /// /// Outgoing message /// + /// 4 OutgoingMessage, /// /// Outgoing email /// + /// 4 OutgoingEmail, /// /// Incoming call /// + /// 4 IncomingCall, /// /// Incoming message /// + /// 4 IncomingMessage, /// /// Incoming email /// + /// 4 IncomingEmail, /// /// Missed call /// + /// 4 MissedCall, /// /// Rejected call /// + /// 4 RejectedCall, /// /// Blocked call /// + /// 4 BlockedCall, /// /// Blocked message /// + /// 4 BlockedMessage } }; @@ -3168,66 +3746,82 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts number view /// + /// 4 public const string Uri = "tizen.contacts_view.simple_contact/number"; /// /// Contact ID that the number belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.ContactId; /// /// Display name of contact that the number belongs to /// + /// 4 public const uint DisplayName = (uint)Property.Id.ContactDisplayName; /// /// The source type of display name, refer to the Contact.DisplayNameSourceType (projection) /// + /// 4 public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId; /// /// AddressBook ID that the number belongs to /// + /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// /// Person ID that the number belongs to /// + /// 4 public const uint PersonId = (uint)Property.Id.ContactPersonId; /// /// Ringtone path that the number belongs to (projection) /// + /// 4 public const uint RingtonePath = (uint)Property.Id.ContactRingtone; /// /// Image thumbnail path that the number belongs to (projection) /// + /// 4 public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail; /// /// DB record ID of the number /// + /// 4 public const uint NumberId = (uint)Property.Id.NumberId; /// /// Number type, refer to the Number.Types (projection) /// + /// 4 public const uint Type = (uint)Property.Id.NumberType; /// /// Custom number type label, when the number type is Number.Types.Custom (projection) /// + /// 4 public const uint Label = (uint)Property.Id.NumberLabel; /// /// The number is default number or not /// + /// 4 public const uint IsDefault = (uint)Property.Id.NumberIsDefault; /// /// Number /// + /// 4 public const uint Number = (uint)Property.Id.NumberNumber; /// /// If you add filter with this property, the string will be normalized as minimal match length internally and the match rule will be applied ContactsFilter.StringMatchType.Exactly /// + /// 4 public const uint NumberFilter = (uint)Property.Id.NumberNumberFilter; /// /// You can only use this property for search filter /// + /// 4 public const uint NormalizedNumber = (uint)Property.Id.NumberNormalizedNumber; /// /// You can only use this property for search filter /// + /// 4 public const uint CleanedNumber = (uint)Property.Id.NumberCleanedNumber; }; @@ -3241,54 +3835,67 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contacts email view /// + /// 4 public const string Uri = "tizen.contacts_view.simple_contact/email"; /// /// Contact ID that the number belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.ContactId; /// /// Display name of contact that the number belongs to /// + /// 4 public const uint DisplayName = (uint)Property.Id.ContactDisplayName; /// /// The source type of display name, refer to the Contact.DisplayNameSourceType (projection) /// + /// 4 public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId; /// /// AddressBook ID that the number belongs to /// + /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// /// Person ID that the number belongs to /// + /// 4 public const uint PersonId = (uint)Property.Id.ContactPersonId; /// /// Ringtone path that the number belongs to (projection) /// + /// 4 public const uint RingtonePath = (uint)Property.Id.ContactRingtone; /// /// Image thumbnail path that the number belongs to (projection) /// + /// 4 public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail; /// /// DB record ID of the email /// + /// 4 public const uint EmailId = (uint)Property.Id.EmailId; /// /// Email type, refer to the Email.Types (projection) /// + /// 4 public const uint Type = (uint)Property.Id.EmailType; /// /// Custom mail type label, when the email type is Email.Types.Custom (projection) /// + /// 4 public const uint Label = (uint)Property.Id.EmailLabel; /// /// Email is default email or not /// + /// 4 public const uint IsDefault = (uint)Property.Id.EmailIsDefault; /// /// Email address /// + /// 4 public const uint Email = (uint)Property.Id.EmailEmail; }; @@ -3302,42 +3909,52 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this contact group relation view /// + /// 4 public const string Uri = "tizen.contacts_view.simple_contact/group"; /// /// Contact ID that the number belongs to /// + /// 4 public const uint ContactId = (uint)Property.Id.ContactId; /// /// Display name of contact that the number belongs to /// + /// 4 public const uint DisplayName = (uint)Property.Id.ContactDisplayName; /// /// The source type of display name, refer to the Contact.DisplayNameSourceType (projection) /// + /// 4 public const uint DisplaySourceType = (uint)Property.Id.ContactDisplaySourceDataId; /// /// AddressBook ID that the number belongs to /// + /// 4 public const uint AddressBookId = (uint)Property.Id.ContactAddressBookId; /// /// Person ID that the number belongs to /// + /// 4 public const uint PersonId = (uint)Property.Id.ContactPersonId; /// /// Ringtone path that the number belongs to (projection) /// + /// 4 public const uint RingtonePath = (uint)Property.Id.ContactRingtone; /// /// Image thumbnail path that the number belongs to (projection) /// + /// 4 public const uint ThumbnailPath = (uint)Property.Id.ContactThumbnail; /// /// DB record ID of the group relation /// + /// 4 public const uint GroupId = (uint)Property.Id.GroupRelationGroupId; /// /// Group name (projection) /// + /// 4 public const uint GroupName = (uint)Property.Id.GroupRelationGroupName; }; @@ -3351,18 +3968,22 @@ namespace Tizen.Pims.Contacts /// /// Identifier of this log statistics view /// + /// 4 public const string Uri = "tizen.contacts_view.phonelog_stat"; /// /// Log count (projection) /// + /// 4 public const uint LogCount = (uint)Property.Id.PhonelogStatLogCount; /// /// Log type, see the contacts_phone_log_type_e /// + /// 4 public const uint LogType = (uint)Property.Id.PhonelogStatLogType; /// /// It is related to the Sim slot number. sim_slot_no 0 means first Sim card, sim_slot_no 1 means second Sim. It is same with handle index of telephony handle list. Refer to the telephony_init() /// + /// 4 public const uint SimSlotNo = (uint)Property.Id.PhonelogStatSimSlotNo; }; } diff --git a/src/Tizen.Security.PrivacyPrivilegeManager/Tizen.Security/PrivacyPrivilegeManager.cs b/src/Tizen.Security.PrivacyPrivilegeManager/Tizen.Security/PrivacyPrivilegeManager.cs index 6f56551..a69f60d 100644 --- a/src/Tizen.Security.PrivacyPrivilegeManager/Tizen.Security/PrivacyPrivilegeManager.cs +++ b/src/Tizen.Security.PrivacyPrivilegeManager/Tizen.Security/PrivacyPrivilegeManager.cs @@ -23,6 +23,7 @@ namespace Tizen.Security /// /// The PrivacyPrivilegeManager provides the properties or methods to check and request a permission for privacy privilege. /// + /// 4 public static class PrivacyPrivilegeManager { private const string LogTag = "Tizen.Privilege"; @@ -70,6 +71,7 @@ namespace Tizen.Security /// } /// /// + /// 4 public static CheckResult CheckPermission(string privilege) { Interop.PrivacyPrivilegeManager.CheckResult result; @@ -107,6 +109,7 @@ namespace Tizen.Security /// } /// /// + /// 4 public static void RequestPermission(string privilege) { int ret = (int)Interop.PrivacyPrivilegeManager.RequestPermission(privilege, s_requestResponseCb, IntPtr.Zero); @@ -167,6 +170,7 @@ namespace Tizen.Security /// } /// /// + /// 4 public static WeakReference GetResponseContext(string privilege) { if (!s_responseMap.ContainsKey(privilege)) @@ -180,6 +184,7 @@ namespace Tizen.Security /// This class manages event handlers of the privilege permission requests. /// This class enables having event handlers for an individual privilege. /// + /// 4 public class ResponseContext { private string _privilege; @@ -192,6 +197,7 @@ namespace Tizen.Security /// Occurs when the response for a permission request is fetched. /// /// Thrown when the bundle instance has been disposed. + /// 4 public event EventHandler ResponseFetched { add diff --git a/src/Tizen.Security.PrivacyPrivilegeManager/Tizen.Security/RequestResponseEventArgs.cs b/src/Tizen.Security.PrivacyPrivilegeManager/Tizen.Security/RequestResponseEventArgs.cs index 5f50b6c..fe2b0ec 100644 --- a/src/Tizen.Security.PrivacyPrivilegeManager/Tizen.Security/RequestResponseEventArgs.cs +++ b/src/Tizen.Security.PrivacyPrivilegeManager/Tizen.Security/RequestResponseEventArgs.cs @@ -21,22 +21,26 @@ namespace Tizen.Security /// /// This class is an event argument of the RequestResponse event. /// + /// 4 public class RequestResponseEventArgs : EventArgs { /// /// The cause of a triggered response. /// + /// 4 public CallCause cause { get; internal set; } /// /// The result of a permission request. /// + /// 4 public RequestResult result { get; internal set; } /// /// The privilege for which a permission was requested for. /// + /// 4 public string privilege { get; internal set; } } } diff --git a/src/Tizen.Security.TEEC/Tizen.Security.TEEC/Libteec.cs b/src/Tizen.Security.TEEC/Tizen.Security.TEEC/Libteec.cs index 858097f..a9e7290 100644 --- a/src/Tizen.Security.TEEC/Tizen.Security.TEEC/Libteec.cs +++ b/src/Tizen.Security.TEEC/Tizen.Security.TEEC/Libteec.cs @@ -29,12 +29,16 @@ namespace Tizen.Security.TEEC public class LoginMethod { /// No login data is provided. + /// 3 public const uint Public = 0x00000000; /// Login data about the user running the client application process is provided. + /// 3 public const uint User = 0x00000001; /// Login data about the group running the client application process is provided. + /// 3 public const uint Group = 0x00000002; /// Login data about the running client application itself is provided. + /// 3 public const uint Application = 0x00000003; } diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/AccelerometerDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/AccelerometerDataUpdatedEventArgs.cs index 3f99237..cd52b04 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/AccelerometerDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/AccelerometerDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The Accelerometer changed event arguments class is used for storing the data returned by a accelerometer. /// + /// 3 public class AccelerometerDataUpdatedEventArgs : EventArgs { internal AccelerometerDataUpdatedEventArgs(float[] values) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/FaceDownGestureDetectorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/FaceDownGestureDetectorDataUpdatedEventArgs.cs index fc23288..86c9df9 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/FaceDownGestureDetectorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/FaceDownGestureDetectorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The FaceDownGestureDetector changed event arguments class is used for storing the data returned by a face down gesture detector. /// + /// 3 public class FaceDownGestureDetectorDataUpdatedEventArgs : EventArgs { internal FaceDownGestureDetectorDataUpdatedEventArgs(float state) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/GravitySensorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/GravitySensorDataUpdatedEventArgs.cs index e99062a..8fffbd3 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/GravitySensorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/GravitySensorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The GravitySensor changed event arguments class is used for storing the data returned by a gravity sensor. /// + /// 3 public class GravitySensorDataUpdatedEventArgs : EventArgs { internal GravitySensorDataUpdatedEventArgs(float[] values) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/GyroscopeDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/GyroscopeDataUpdatedEventArgs.cs index 849b570..d56f562 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/GyroscopeDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/GyroscopeDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The Gyroscope changed event arguments class is used for storing the data returned by a gyroscope. /// + /// 3 public class GyroscopeDataUpdatedEventArgs : EventArgs { internal GyroscopeDataUpdatedEventArgs(float[] values) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/GyroscopeRotationVectorSensorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/GyroscopeRotationVectorSensorDataUpdatedEventArgs.cs index f5fb577..2de3028 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/GyroscopeRotationVectorSensorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/GyroscopeRotationVectorSensorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The GyroscopeRotationVectorSensor changed event arguments class is used for storing the data returned by a gyroscope rotation vector sensor. /// + /// 3 public class GyroscopeRotationVectorSensorDataUpdatedEventArgs : EventArgs { internal GyroscopeRotationVectorSensorDataUpdatedEventArgs(float[] values, SensorDataAccuracy accuracy) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/HeartRateMonitorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/HeartRateMonitorDataUpdatedEventArgs.cs index a513227..5a23088 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/HeartRateMonitorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/HeartRateMonitorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The HeartRateMonitor changed event arguments class is used for storing the data returned by a heart rate monitor. /// + /// 3 public class HeartRateMonitorDataUpdatedEventArgs : EventArgs { internal HeartRateMonitorDataUpdatedEventArgs(int heartRate) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/HumiditySensorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/HumiditySensorDataUpdatedEventArgs.cs index 452410a..de81db3 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/HumiditySensorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/HumiditySensorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The HumiditySensor changed event arguments class is used for storing the data returned by a humidity sensor. /// + /// 3 public class HumiditySensorDataUpdatedEventArgs : EventArgs { internal HumiditySensorDataUpdatedEventArgs(float humidity) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/InVehicleActivityDetectorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/InVehicleActivityDetectorDataUpdatedEventArgs.cs index 73bb7c1..e1801a8 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/InVehicleActivityDetectorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/InVehicleActivityDetectorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The InVehicleActivityDetector changed event arguments class is used for storing the data returned by a in-vehicle activity detector. /// + /// 3 public class InVehicleActivityDetectorDataUpdatedEventArgs : EventArgs { internal InVehicleActivityDetectorDataUpdatedEventArgs(float state) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/LightSensorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/LightSensorDataUpdatedEventArgs.cs index 4f1dc4c..1a47298 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/LightSensorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/LightSensorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The LightSensor changed event arguments class is used for storing the data returned by a light sensor. /// + /// 3 public class LightSensorDataUpdatedEventArgs : EventArgs { internal LightSensorDataUpdatedEventArgs(float level) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/LinearAccelerationSensorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/LinearAccelerationSensorDataUpdatedEventArgs.cs index cf920bf..6f16325 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/LinearAccelerationSensorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/LinearAccelerationSensorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The LinearAccelerationSensor changed event arguments class is used for storing the data returned by a linear acceleration sensor. /// + /// 3 public class LinearAccelerationSensorDataUpdatedEventArgs : EventArgs { internal LinearAccelerationSensorDataUpdatedEventArgs(float[] values) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/MagnetometerDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/MagnetometerDataUpdatedEventArgs.cs index e0deb30..1edd405 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/MagnetometerDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/MagnetometerDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The Magnetometer changed event arguments class is used for storing the data returned by a magnetometer sensor. /// + /// 3 public class MagnetometerDataUpdatedEventArgs : EventArgs { internal MagnetometerDataUpdatedEventArgs(float[] values) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/MagnetometerRotationVectorSensorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/MagnetometerRotationVectorSensorDataUpdatedEventArgs.cs index 4e1fc93..e53ab01 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/MagnetometerRotationVectorSensorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/MagnetometerRotationVectorSensorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The MagnetometerRotationVectorSensor changed event arguments class is used for storing the data returned by a magnetometer rotation vector sensor. /// + /// 3 public class MagnetometerRotationVectorSensorDataUpdatedEventArgs : EventArgs { internal MagnetometerRotationVectorSensorDataUpdatedEventArgs(float[] values, SensorDataAccuracy accuracy) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/OrientationSensorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/OrientationSensorDataUpdatedEventArgs.cs index c7f6239..6fa8368 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/OrientationSensorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/OrientationSensorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The OrientationSensor changed event arguments class is used for storing the data returned by a orientation sensor. /// + /// 3 public class OrientationSensorDataUpdatedEventArgs : EventArgs { internal OrientationSensorDataUpdatedEventArgs(float[] values) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/PedometerDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/PedometerDataUpdatedEventArgs.cs index 0a73a8e..30a2fee 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/PedometerDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/PedometerDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The Pedometer changed event arguments class is used for storing the data returned by a pedometer. /// + /// 3 public class PedometerDataUpdatedEventArgs : EventArgs { internal PedometerDataUpdatedEventArgs(float[] values) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/PickUpGestureDetectorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/PickUpGestureDetectorDataUpdatedEventArgs.cs index 82b5b88..ca9d581 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/PickUpGestureDetectorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/PickUpGestureDetectorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The PickUpGestureDetector changed event arguments class is used for storing the data returned by a pickup gesture detector. /// + /// 3 public class PickUpGestureDetectorDataUpdatedEventArgs : EventArgs { internal PickUpGestureDetectorDataUpdatedEventArgs(float state) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/PressureSensorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/PressureSensorDataUpdatedEventArgs.cs index 4bbe48e..278daa7 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/PressureSensorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/PressureSensorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The PressureSensor changed event arguments class is used for storing the data returned by a pressure sensor. /// + /// 3 public class PressureSensorDataUpdatedEventArgs : EventArgs { internal PressureSensorDataUpdatedEventArgs(float pressure) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/ProximitySensorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/ProximitySensorDataUpdatedEventArgs.cs index 27faa15..63bdc6d 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/ProximitySensorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/ProximitySensorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The ProximitySensor changed event arguments class is used for storing the data returned by a proximity sensor. /// + /// 3 public class ProximitySensorDataUpdatedEventArgs : EventArgs { internal ProximitySensorDataUpdatedEventArgs(float proximity) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/RotationVectorSensorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/RotationVectorSensorDataUpdatedEventArgs.cs index 98229ee..9593591 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/RotationVectorSensorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/RotationVectorSensorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The RotationVectorSensor changed event arguments class is used for storing the data returned by a rotation vector sensor. /// + /// 3 public class RotationVectorSensorDataUpdatedEventArgs : EventArgs { internal RotationVectorSensorDataUpdatedEventArgs(float[] values, SensorDataAccuracy accuracy) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/RunningActivityDetectorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/RunningActivityDetectorDataUpdatedEventArgs.cs index 66c6d7e..e1d1ef0 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/RunningActivityDetectorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/RunningActivityDetectorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The RunningActivityDetector changed event arguments class is used for storing the data returned by a running activity detector. /// + /// 3 public class RunningActivityDetectorDataUpdatedEventArgs : EventArgs { internal RunningActivityDetectorDataUpdatedEventArgs(float state) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/SensorAccuracyChangedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/SensorAccuracyChangedEventArgs.cs index 3735cc0..a6a401a 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/SensorAccuracyChangedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/SensorAccuracyChangedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The sensor accuracy changed event arguments class contains the parameters to be returned through the accuracy callback. /// + /// 3 public class SensorAccuracyChangedEventArgs : EventArgs { internal SensorAccuracyChangedEventArgs(TimeSpan timespan, SensorDataAccuracy accuracy) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/SleepMonitorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/SleepMonitorDataUpdatedEventArgs.cs index 82074fd..fb49120 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/SleepMonitorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/SleepMonitorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The SleepMonitor changed event arguments class is used for storing the data returned by a sleep monitor. /// + /// 3 public class SleepMonitorDataUpdatedEventArgs : EventArgs { internal SleepMonitorDataUpdatedEventArgs(int sleepState) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/StationaryActivityDetectorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/StationaryActivityDetectorDataUpdatedEventArgs.cs index aaf393a..93250f9 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/StationaryActivityDetectorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/StationaryActivityDetectorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The StationaryActivityDetector changed event arguments class is used for storing the data returned by a stationary activity detector. /// + /// 3 public class StationaryActivityDetectorDataUpdatedEventArgs : EventArgs { internal StationaryActivityDetectorDataUpdatedEventArgs(float state) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/TemperatureSensorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/TemperatureSensorDataUpdatedEventArgs.cs index 3b4a6ba..5a0e645 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/TemperatureSensorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/TemperatureSensorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The TemperatureSensor changed event arguments class is used for storing the data returned by a temperature sensor. /// + /// 3 public class TemperatureSensorDataUpdatedEventArgs : EventArgs { internal TemperatureSensorDataUpdatedEventArgs(float temperature) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/UltravioletSensorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/UltravioletSensorDataUpdatedEventArgs.cs index b42b1e3..e3ef9b7 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/UltravioletSensorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/UltravioletSensorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The UltravioletSensor changed event arguments class is used for storing the data returned by a ultraviolet sensor. /// + /// 3 public class UltravioletSensorDataUpdatedEventArgs : EventArgs { internal UltravioletSensorDataUpdatedEventArgs(float ultravioletIndex) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/UncalibratedGyroscopeDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/UncalibratedGyroscopeDataUpdatedEventArgs.cs index b358ef9..9db042f 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/UncalibratedGyroscopeDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/UncalibratedGyroscopeDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The UncalibratedGyroscope changed event arguments class is used for storing the data returned by a uncalibrated gyroscope. /// + /// 3 public class UncalibratedGyroscopeDataUpdatedEventArgs : EventArgs { internal UncalibratedGyroscopeDataUpdatedEventArgs(float[] values) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/UncalibratedMagnetometerDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/UncalibratedMagnetometerDataUpdatedEventArgs.cs index c8a2f53..cb0d386 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/UncalibratedMagnetometerDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/UncalibratedMagnetometerDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The UncalibratedMagnetometer changed event arguments class is used for storing the data returned by a uncalibrated magnetometer. /// + /// 3 public class UncalibratedMagnetometerDataUpdatedEventArgs : EventArgs { internal UncalibratedMagnetometerDataUpdatedEventArgs(float[] values) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/WalkingActivityDetectorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/WalkingActivityDetectorDataUpdatedEventArgs.cs index 0142047..b137381 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/WalkingActivityDetectorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/WalkingActivityDetectorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The WalkingActivityDetector changed event arguments class is used for storing the data returned by a walking activity detector. /// + /// 3 public class WalkingActivityDetectorDataUpdatedEventArgs : EventArgs { internal WalkingActivityDetectorDataUpdatedEventArgs(float state) diff --git a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/WristUpGestureDetectorDataUpdatedEventArgs.cs b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/WristUpGestureDetectorDataUpdatedEventArgs.cs index 2ac31fe..7560dc4 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/EventArgs/WristUpGestureDetectorDataUpdatedEventArgs.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/EventArgs/WristUpGestureDetectorDataUpdatedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The WristUpGestureDetector changed event arguments class is used for storing the data returned by a wrist up gesture detector. /// + /// 3 public class WristUpGestureDetectorDataUpdatedEventArgs : EventArgs { internal WristUpGestureDetectorDataUpdatedEventArgs(float state) diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs index 3c0867f..b8f7e89 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Accelerometer.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The Accelerometer Sensor class is used for registering callbacks for the accelerometer and getting the accelerometer data. /// + /// 3 public sealed class Accelerometer : Sensor { private static string AccelerometerKey = "http://tizen.org/feature/sensor.accelerometer"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs index 7ada88d..a7e297d 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/ActivityDetector.cs @@ -21,11 +21,13 @@ namespace Tizen.Sensor /// /// The Activity Detector class is used for storing the common activity information. /// + /// 3 public abstract class ActivityDetector : Sensor { /// /// Attribute key for a activity detector. /// + /// 3 protected const int ActivityAttribute = (((int)SensorType.StationaryActivityDetector << 8) | 0x80 | 0x1); /// diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs index 7340124..2d6a301 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/FaceDownGestureDetector.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The FaceDownGestureDetector class is used for registering callbacks for the face down gesture detector and getting the face down state. /// + /// 3 public sealed class FaceDownGestureDetector : Sensor { private static string GestureDetectorKey = "http://tizen.org/feature/sensor.gesture_recognition"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs index 746fef8..f8b1d40 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/GravitySensor.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The GravitySensor class is used for registering callbacks for the gravity sensor and getting the gravity data. /// + /// 3 public sealed class GravitySensor : Sensor { private const string GravitySensorKey = "http://tizen.org/feature/sensor.gravity"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs index 2045448..a1a859d 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Gyroscope.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The Gyroscope Sensor class is used for registering callbacks for the gyroscope and getting the gyroscope data. /// + /// 3 public sealed class Gyroscope : Sensor { private const string GyroscopeKey = "http://tizen.org/feature/sensor.gyroscope"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs index 0ab13a9..ae0ad4e 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/GyroscopeRotationVectorSensor.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The GyroscopeRotationVectorSensor class is used for registering callbacks for the gyroscope rotation vector sensor and getting the gyroscope rotation vector data. /// + /// 3 public sealed class GyroscopeRotationVectorSensor : Sensor { private const string GyroscopeRVKey = "http://tizen.org/feature/sensor.gyroscope_rotation_vector"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs index 330628c..010cd52 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HeartRateMonitor.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The HeartRateMonitor class is used for registering callbacks for the heart rate monitor and getting the heart rate data. /// + /// 3 public sealed class HeartRateMonitor : Sensor { private const string HRMKey = "http://tizen.org/feature/sensor.heart_rate_monitor"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs index d2abaf3..387138b 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/HumiditySensor.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The HumiditySensor class is used for registering callbacks for the humidity sensor and getting the humidity data. /// + /// 3 public sealed class HumiditySensor : Sensor { private const string HumiditySensorKey = "http://tizen.org/feature/sensor.humidity"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs index 787d2d6..233b079 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/InVehicleActivityDetector.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The InVehicleActivityDetector class is used for registering callbacks for the in-vehicle activity detector and getting the in-vehicle state. /// + /// 3 public sealed class InVehicleActivityDetector : ActivityDetector { private const string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs index 16d7615..deff1c6 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/LightSensor.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The LightSensor class is used for registering callbacks for the light sensor and getting the light data. /// + /// 3 public sealed class LightSensor : Sensor { private const string LightSensorKey = "http://tizen.org/feature/sensor.photometer"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs index b75a2de..46bd57a 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/LinearAccelerationSensor.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The LinearAccelerationSensor class is used for registering callbacks for the linear acceleration sensor and getting the linear acceleration data. /// + /// 3 public sealed class LinearAccelerationSensor : Sensor { private const string LinearAccelerationSensorKey = "http://tizen.org/feature/sensor.linear_acceleration"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs index 9845eae..0b13b71 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Magnetometer.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The Magnetometer class is used for registering callbacks for the magnetometer and getting the magnetometer data. /// + /// 3 public sealed class Magnetometer : Sensor { private static string MagnetometerKey = "http://tizen.org/feature/sensor.magnetometer"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs index 2a103d3..288af33 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/MagnetometerRotationVectorSensor.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The MagnetometerRotationVectorSensor class is used for registering callbacks for the magnetometer rotation vector sensor and getting the magnetometer rotation vector data. /// + /// 3 public sealed class MagnetometerRotationVectorSensor : Sensor { private static string MagnetometerRVKey = "http://tizen.org/feature/sensor.geomagnetic_rotation_vector"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs index de58ddc..866b29f 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/OrientationSensor.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The OrientationSensor class is used for registering callbacks for the orientation sensor and getting the orientation data. /// + /// 3 public sealed class OrientationSensor : Sensor { private static string OrientationSensorKey = "http://tizen.org/feature/sensor.tiltmeter"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs index 4c9c502..7408d87 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/Pedometer.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The Pedometer Sensor class is used for registering callbacks for the pedometer and getting the pedometer data. /// + /// 3 public sealed class Pedometer : Sensor { private static string PedometerKey = "http://tizen.org/feature/sensor.pedometer"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs index 115afc1..1f54973 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/PickUpGestureDetector.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The PickUpGestureDetector class is used for registering callbacks for the pick up activity detector and getting the pick up state. /// + /// 3 public sealed class PickUpGestureDetector : Sensor { private static string GestureDetectorKey = "http://tizen.org/feature/sensor.gesture_recognition"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs index e8fc7eb..03a8eff 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/PressureSensor.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The PressureSensor class is used for registering callbacks for the pressure sensor and getting the pressure data. /// + /// 3 public sealed class PressureSensor : Sensor { private static string PressureSensorKey = "http://tizen.org/feature/sensor.barometer"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs index 7ed55e5..ddcf132 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/ProximitySensor.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The ProximitySensor class is used for registering callbacks for the proximity sensor and getting the proximity data. /// + /// 3 public sealed class ProximitySensor : Sensor { private static string ProximitySensorKey = "http://tizen.org/feature/sensor.proximity"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs index a07e058..724e4c2 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/RotationVectorSensor.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The RotationVectorSensor class is used for registering callbacks for the rotation vector sensor and getting the rotation vector data. /// + /// 3 public sealed class RotationVectorSensor : Sensor { private static string RotationVectorKey = "http://tizen.org/feature/sensor.rotation_vector"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs index f2a3be7..c8cb810 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/RunningActivityDetector.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The RunningActivityDetector class is used for registering callbacks for running the activity detector and getting the running state. /// + /// 3 public sealed class RunningActivityDetector : ActivityDetector { private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs index 7ac0b46..65d06d6 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/SleepMonitor.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The SleepMonitor class is used for registering callbacks for the sleep monitor and getting the sleep data. /// + /// 3 public sealed class SleepMonitor : Sensor { private static string SleepMonitorKey = "http://tizen.org/feature/sensor.sleep_monitor"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs index 79ebddb..98cf01a 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/StationaryActivityDetector.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The StationaryActivityDetector class is used for registering callbacks for the stationary activity detector and getting the stationary state. /// + /// 3 public sealed class StationaryActivityDetector : ActivityDetector { private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs index b7dcfb8..2518e70 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/TemperatureSensor.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The TemperatureSensor class is used for registering callbacks for the temperature sensor and getting the temperature data. /// + /// 3 public sealed class TemperatureSensor : Sensor { private static string TemperatureSensorKey = "http://tizen.org/feature/sensor.temperature"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs index 491716a..ec80d52 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UltravioletSensor.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The UltravioletSensor class is used for registering callbacks for the ultraviolet sensor and getting the ultraviolet data. /// + /// 3 public sealed class UltravioletSensor : Sensor { private static string UltravioletSensorKey = "http://tizen.org/feature/sensor.ultraviolet"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs index 58d90ae..ff1e28c 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedGyroscope.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The UncalibratedGyroscope sensor class is used for registering callbacks for the uncalibrated gyroscope and getting the uncalibrated gyroscope data. /// + /// 3 public sealed class UncalibratedGyroscope : Sensor { private static string UncalibratedGyroscopeKey = "http://tizen.org/feature/sensor.gyroscope.uncalibrated"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs index 8eb53e9..948e863 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/UncalibratedMagnetometer.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The UncalibratedMagnetometer sensor class is used for registering callbacks for the uncalibrated magnetometer and getting the uncalibrated magnetometer data. /// + /// 3 public sealed class UncalibratedMagnetometer : Sensor { private static string UncalibratedMagnetometerKey = "http://tizen.org/feature/sensor.magnetometer.uncalibrated"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs index d2b7906..0a28317 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/WalkingActivityDetector.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The WalkingActivityDetector class is used for registering callbacks for the walking activity detector and getting the walking state. /// + /// 3 public sealed class WalkingActivityDetector : ActivityDetector { private static string ActivityDetectorKey = "http://tizen.org/feature/sensor.activity_recognition"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs b/src/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs index b4a3636..93ab50d 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Plugins/WristUpGestureDetector.cs @@ -21,6 +21,7 @@ namespace Tizen.Sensor /// /// The WristUpGestureDetector class is used for registering callbacks for the wrist up gesture detector and getting the wrist up state. /// + /// 3 public sealed class WristUpGestureDetector : Sensor { private static string WristUpKey = "http://tizen.org/feature/sensor.wrist_up"; diff --git a/src/Tizen.Sensor/Tizen.Sensor/Sensor.cs b/src/Tizen.Sensor/Tizen.Sensor/Sensor.cs index e514f3e..0910188 100755 --- a/src/Tizen.Sensor/Tizen.Sensor/Sensor.cs +++ b/src/Tizen.Sensor/Tizen.Sensor/Sensor.cs @@ -27,6 +27,7 @@ namespace Tizen.Sensor /// /// The Sensor class is used for storing the hardware information about a particular sensor. /// + /// 3 public abstract class Sensor : IDisposable { private string _name; @@ -357,6 +358,7 @@ namespace Tizen.Sensor /// /// Destroy the current object. /// + /// 3 public void Dispose() { Dispose(true); @@ -370,6 +372,7 @@ namespace Tizen.Sensor /// true if managed resources should be disposed /// otherwise, false. /// + /// 3 protected virtual void Dispose(bool disposing) { if (_disposed) diff --git a/src/Tizen.System.Feedback/Feedback/Feedback.cs b/src/Tizen.System.Feedback/Feedback/Feedback.cs index 00deff3..a9a3f25 100755 --- a/src/Tizen.System.Feedback/Feedback/Feedback.cs +++ b/src/Tizen.System.Feedback/Feedback/Feedback.cs @@ -83,6 +83,7 @@ namespace Tizen.System /// bool res = feedback.IsSupportedPattern(FeedbackType.Vibration, "Tap"); /// /// + /// 3 public class Feedback { private const string LogTag = "Tizen.System.Feedback"; diff --git a/src/Tizen.System.Information/Common/Information.cs b/src/Tizen.System.Information/Common/Information.cs index 06ddf37..b9f2b17 100644 --- a/src/Tizen.System.Information/Common/Information.cs +++ b/src/Tizen.System.Information/Common/Information.cs @@ -22,6 +22,7 @@ namespace Tizen.System /// /// The Information class provides functions to obtain various system information. /// + /// 4 public static class Information { internal const string HttpPrefix = "http://"; diff --git a/src/Tizen.System.Information/RuntimeInfo/Enumerations.cs b/src/Tizen.System.Information/RuntimeInfo/Enumerations.cs index dfab9f1..925a0ca 100644 --- a/src/Tizen.System.Information/RuntimeInfo/Enumerations.cs +++ b/src/Tizen.System.Information/RuntimeInfo/Enumerations.cs @@ -84,6 +84,7 @@ namespace Tizen.System /// /// Enumeration for the GPS status. /// + /// 3 public enum GpsStatus { /// @@ -103,6 +104,7 @@ namespace Tizen.System /// /// Enumeration for the type of audio jack connected. /// + /// 3 public enum AudioJackConnectionType { /// diff --git a/src/Tizen.System.Information/RuntimeInfo/RuntimeFeatureStatusChangedEventArgs.cs b/src/Tizen.System.Information/RuntimeInfo/RuntimeFeatureStatusChangedEventArgs.cs index dbfacd8..6f6a457 100755 --- a/src/Tizen.System.Information/RuntimeInfo/RuntimeFeatureStatusChangedEventArgs.cs +++ b/src/Tizen.System.Information/RuntimeInfo/RuntimeFeatureStatusChangedEventArgs.cs @@ -21,12 +21,14 @@ namespace Tizen.System /// /// RuntimeFeatureStatusChangedEventArgs is an extended EventArgs class. This class contains event arguments for runtime event listeners. /// + /// 4 public class RuntimeFeatureStatusChangedEventArgs : EventArgs { /// /// The key indicating the runtime system preference which was changed. /// It includes the prefix "http://" though you don't use for registering callback. /// + /// 4 public String Key { get; internal set; } } } diff --git a/src/Tizen.System.Information/SystemInfo/SystemInfo.cs b/src/Tizen.System.Information/SystemInfo/SystemInfo.cs index f47c0a8..7fbe5d2 100755 --- a/src/Tizen.System.Information/SystemInfo/SystemInfo.cs +++ b/src/Tizen.System.Information/SystemInfo/SystemInfo.cs @@ -23,6 +23,7 @@ namespace Tizen.System /// The SystemInfo class provides static system feature. /// Please use Tizen.System.Information class. Information class supports same function. /// + /// 3 [Obsolete("Use class Tizen.System.Information")] [EditorBrowsable(EditorBrowsableState.Never)] public static class SystemInfo @@ -94,6 +95,7 @@ namespace Tizen.System /// The name of the feature. /// The value of the given feature. /// Returns true on success, otherwise false. + /// 3 public static bool TryGetValue(string key, out T value) { bool res = false; @@ -134,6 +136,7 @@ namespace Tizen.System /// The name of the feature. /// The value of the given feature. /// Returns true on success, otherwise false. + /// 3 public static bool TryGetValue(string key, out bool value) { Interop.SystemInfo.SystemInfoValueType valueType; @@ -167,6 +170,7 @@ namespace Tizen.System /// The name of the feature. /// The value of the given feature. /// Returns true on success, otherwise false. + /// 3 public static bool TryGetValue(string key, out int value) { Interop.SystemInfo.SystemInfoValueType valueType; @@ -201,6 +205,7 @@ namespace Tizen.System /// The name of the feature. /// The value of the given feature. /// Returns true on success, otherwise false. + /// 3 public static bool TryGetValue(string key, out double value) { Interop.SystemInfo.SystemInfoValueType valueType; @@ -235,6 +240,7 @@ namespace Tizen.System /// The name of the feature. /// The value of the given feature. /// Returns true on success, otherwise false. + /// 3 public static bool TryGetValue(string key, out string value) { Interop.SystemInfo.SystemInfoValueType valueType; diff --git a/src/Tizen.System.Information/Usage/ProcessCpuUsage.cs b/src/Tizen.System.Information/Usage/ProcessCpuUsage.cs index 75a579c..f42fee9 100755 --- a/src/Tizen.System.Information/Usage/ProcessCpuUsage.cs +++ b/src/Tizen.System.Information/Usage/ProcessCpuUsage.cs @@ -25,6 +25,7 @@ namespace Tizen.System /// /// The class for CPU usage per process. /// + /// 3 public class ProcessCpuUsage { private int[] Pids; diff --git a/src/Tizen.System.Information/Usage/ProcessMemoryUsage.cs b/src/Tizen.System.Information/Usage/ProcessMemoryUsage.cs index c10c8c9..02c03bb 100755 --- a/src/Tizen.System.Information/Usage/ProcessMemoryUsage.cs +++ b/src/Tizen.System.Information/Usage/ProcessMemoryUsage.cs @@ -25,6 +25,7 @@ namespace Tizen.System /// /// The class for memory information per process. /// + /// 4 public class ProcessMemoryUsage { private int[] Pids; diff --git a/src/Tizen.System.Information/Usage/SystemCpuUsage.cs b/src/Tizen.System.Information/Usage/SystemCpuUsage.cs index d72b462..a248275 100755 --- a/src/Tizen.System.Information/Usage/SystemCpuUsage.cs +++ b/src/Tizen.System.Information/Usage/SystemCpuUsage.cs @@ -22,6 +22,7 @@ namespace Tizen.System /// /// The class for system CPU usage. /// + /// 4 public class SystemCpuUsage { private Interop.RuntimeInfo.CpuUsage Usage; diff --git a/src/Tizen.System.Information/Usage/SystemMemoryUsage.cs b/src/Tizen.System.Information/Usage/SystemMemoryUsage.cs index 41ec78f..4819afa 100755 --- a/src/Tizen.System.Information/Usage/SystemMemoryUsage.cs +++ b/src/Tizen.System.Information/Usage/SystemMemoryUsage.cs @@ -21,6 +21,7 @@ namespace Tizen.System /// /// The class for system memory information. /// + /// 4 public class SystemMemoryUsage { private Interop.RuntimeInfo.MemoryInfo Info; diff --git a/src/Tizen.System.MediaKey/Tizen.System/MediaKey.cs b/src/Tizen.System.MediaKey/Tizen.System/MediaKey.cs index 38a69c5..86df6f1 100755 --- a/src/Tizen.System.MediaKey/Tizen.System/MediaKey.cs +++ b/src/Tizen.System.MediaKey/Tizen.System/MediaKey.cs @@ -21,6 +21,7 @@ namespace Tizen.System /// /// The class for event arguments of the media key. /// + /// 3 public class MediaKeyEventArgs : EventArgs { /// @@ -118,6 +119,7 @@ namespace Tizen.System /// /// The class for receiving events of media keys. /// + /// 3 public static class MediaKey { private static EventHandler s_eventHandler; diff --git a/src/Tizen.System.PlatformConfig/Tizen.System/PlatformConfig.cs b/src/Tizen.System.PlatformConfig/Tizen.System/PlatformConfig.cs index 093f3b2..373c70b 100755 --- a/src/Tizen.System.PlatformConfig/Tizen.System/PlatformConfig.cs +++ b/src/Tizen.System.PlatformConfig/Tizen.System/PlatformConfig.cs @@ -21,6 +21,7 @@ using System.ComponentModel; namespace Tizen.System { + /// 4 [EditorBrowsable(EditorBrowsableState.Never)] public class PlatformConfig { @@ -29,6 +30,7 @@ namespace Tizen.System return Interop.PlatformConfig.GetId(name); } + /// 4 public static string GetEnv(string name) { return Interop.PlatformConfig.GetEnv(Interop.PlatformConfig.GetId(name)); diff --git a/src/Tizen.System.Storage/Storage/Storage.cs b/src/Tizen.System.Storage/Storage/Storage.cs index adc6359..67b327d 100644 --- a/src/Tizen.System.Storage/Storage/Storage.cs +++ b/src/Tizen.System.Storage/Storage/Storage.cs @@ -21,6 +21,7 @@ namespace Tizen.System /// /// The class to access the storage device information. /// + /// 3 public class Storage { private const string LogTag = "Tizen.System"; diff --git a/src/Tizen.System.Storage/Storage/StorageManager.cs b/src/Tizen.System.Storage/Storage/StorageManager.cs index 0335b2e..740f47d 100644 --- a/src/Tizen.System.Storage/Storage/StorageManager.cs +++ b/src/Tizen.System.Storage/Storage/StorageManager.cs @@ -22,6 +22,7 @@ namespace Tizen.System /// /// The StorageManager provides the properties or methods to access storage in the device. /// + /// 3 public static class StorageManager { private const string LogTag = "Tizen.System"; diff --git a/src/Tizen.System.SystemSettings/Tizen.System.SystemSettings/SystemSettings.cs b/src/Tizen.System.SystemSettings/Tizen.System.SystemSettings/SystemSettings.cs index 965ac07..ebce594 100755 --- a/src/Tizen.System.SystemSettings/Tizen.System.SystemSettings/SystemSettings.cs +++ b/src/Tizen.System.SystemSettings/Tizen.System.SystemSettings/SystemSettings.cs @@ -25,6 +25,7 @@ namespace Tizen.System /// The System Settings API provides functions for getting the system configuration related to user preferences. /// The main features of the System Settings API include accessing system-wide configurations, such as ringtones, wallpapers, and so on. /// + /// 3 public static class SystemSettings { /// @@ -38,6 +39,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static string IncomingCallRingtone { get @@ -71,6 +73,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static string WallpaperHomeScreen { get @@ -104,6 +107,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static string WallpaperLockScreen { get @@ -136,6 +140,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static SystemSettingsFontSize FontSize { get @@ -168,6 +173,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static string FontType { get @@ -200,6 +206,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static bool MotionActivationEnabled { get @@ -233,6 +240,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static string EmailAlertRingtone { get @@ -264,6 +272,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static bool UsbDebuggingEnabled { get @@ -296,6 +305,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static bool Data3GNetworkEnabled { get @@ -329,6 +339,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 4 public static string LockScreenApp { get @@ -361,6 +372,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static string DefaultFontType { get @@ -387,6 +399,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static string LocaleCountry { get @@ -421,6 +434,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static string LocaleLanguage { get @@ -454,6 +468,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static bool LocaleTimeFormat24HourEnabled { get @@ -486,6 +501,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static string LocaleTimeZone { get @@ -518,6 +534,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static int Time { get @@ -541,6 +558,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static bool SoundLockEnabled { get @@ -565,6 +583,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static bool SoundSilentModeEnabled { get @@ -589,6 +608,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static bool SoundTouchEnabled { get @@ -613,6 +633,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static bool DisplayScreenRotationAutoEnabled { get @@ -637,6 +658,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static string DeviceName { get @@ -660,6 +682,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static bool MotionEnabled { get @@ -685,6 +708,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static bool NetworkWifiNotificationEnabled { get @@ -709,6 +733,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static bool NetworkFlightModeEnabled { get @@ -733,6 +758,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static int ScreenBacklightTime { get @@ -766,6 +792,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static string SoundNotification { get @@ -798,6 +825,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static int SoundNotificationRepetitionPeriod { get @@ -830,6 +858,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static SystemSettingsIdleLockState LockState { get @@ -862,6 +891,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static string AdsId { get @@ -896,6 +926,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static SystemSettingsUdsState UltraDataSave { get @@ -920,6 +951,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 4 public static bool AccessibilityTtsEnabled { get @@ -953,6 +985,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler IncomingCallRingtoneChanged { add @@ -1000,6 +1033,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler WallpaperHomeScreenChanged { add @@ -1047,6 +1081,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler WallpaperLockScreenChanged { add @@ -1093,6 +1128,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler FontSizeChanged { add @@ -1139,6 +1175,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler FontTypeChanged { add @@ -1185,6 +1222,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler MotionActivationSettingChanged { add @@ -1232,6 +1270,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler EmailAlertRingtoneChanged { add @@ -1278,6 +1317,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler UsbDebuggingSettingChanged { add @@ -1324,6 +1364,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler Data3GNetworkSettingChanged { add @@ -1371,6 +1412,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 4 public static event EventHandler LockScreenAppChanged { add @@ -1417,6 +1459,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler LocaleCountryChanged { add @@ -1463,6 +1506,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler LocaleLanguageChanged { add @@ -1509,6 +1553,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler LocaleTimeFormat24HourSettingChanged { add @@ -1555,6 +1600,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler LocaleTimeZoneChanged { add @@ -1602,6 +1648,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler TimeChanged { add @@ -1648,6 +1695,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler SoundLockSettingChanged { add @@ -1694,6 +1742,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler SoundSilentModeSettingChanged { add @@ -1740,6 +1789,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler SoundTouchSettingChanged { add @@ -1787,6 +1837,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler DisplayScreenRotationAutoSettingChanged { add @@ -1833,6 +1884,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler DeviceNameChanged { add @@ -1879,6 +1931,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler MotionSettingChanged { add @@ -1926,6 +1979,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler NetworkWifiNotificationSettingChanged { add @@ -1972,6 +2026,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler NetworkFlightModeSettingChanged { add @@ -2018,6 +2073,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler ScreenBacklightTimeChanged { add @@ -2065,6 +2121,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler SoundNotificationChanged { add @@ -2111,6 +2168,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler SoundNotificationRepetitionPeriodChanged { add @@ -2157,6 +2215,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler LockStateChanged { add @@ -2203,6 +2262,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler AdsIdChanged { add @@ -2250,6 +2310,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler UltraDataSaveChanged { add @@ -2297,6 +2358,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public static event EventHandler UltraDataSavePackageListChanged { add @@ -2343,6 +2405,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 4 public static event EventHandler AccessibilityTtsSettingChanged { add diff --git a/src/Tizen.System.SystemSettings/Tizen.System.SystemSettings/SystemSettingsEnums.cs b/src/Tizen.System.SystemSettings/Tizen.System.SystemSettings/SystemSettingsEnums.cs index c708d6b..7e66bf1 100755 --- a/src/Tizen.System.SystemSettings/Tizen.System.SystemSettings/SystemSettingsEnums.cs +++ b/src/Tizen.System.SystemSettings/Tizen.System.SystemSettings/SystemSettingsEnums.cs @@ -19,6 +19,7 @@ namespace Tizen.System /// /// Enumeration for all the available system settings. /// + /// 3 public enum SystemSettingsKeys : int { /// @@ -60,6 +61,7 @@ namespace Tizen.System /// /// GET (string) Indicates the lock-screen application package name. /// + /// 4 LockScreenApp = Data3GNetworkEnabled + 2, /// /// GET (string) The current system default font type (only supports Get). @@ -153,11 +155,13 @@ namespace Tizen.System /// /// GET (bool) Indicates whether the the accessibility TTS is enabled on the device. /// + /// 4 AccessibilityTtsEnabled, } /// /// Enumeration for the Idle Lock State. /// + /// 3 public enum SystemSettingsIdleLockState : int { /// @@ -176,6 +180,7 @@ namespace Tizen.System /// /// Enumeration for the font size. /// + /// 3 public enum SystemSettingsFontSize : int { /// @@ -202,6 +207,7 @@ namespace Tizen.System /// /// Enumeration for the ultra data save. /// + /// 3 public enum SystemSettingsUdsState : int { /// diff --git a/src/Tizen.System.SystemSettings/Tizen.System.SystemSettings/SystemSettingsEventArgs.cs b/src/Tizen.System.SystemSettings/Tizen.System.SystemSettings/SystemSettingsEventArgs.cs index ac3bb0c..ff91fc9 100755 --- a/src/Tizen.System.SystemSettings/Tizen.System.SystemSettings/SystemSettingsEventArgs.cs +++ b/src/Tizen.System.SystemSettings/Tizen.System.SystemSettings/SystemSettingsEventArgs.cs @@ -29,6 +29,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class IncomingCallRingtoneChangedEventArgs : EventArgs { private readonly string _incomingCallRingtone = null; @@ -40,6 +41,7 @@ namespace Tizen.System /// /// The file path of the current ringtone. /// + /// 3 public string Value { get @@ -60,6 +62,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class WallpaperHomeScreenChangedEventArgs : EventArgs { private readonly string _wallpaperHomeScreen = null; @@ -71,6 +74,7 @@ namespace Tizen.System /// /// The file path of the current home screen wallpaper. /// + /// 3 public string Value { get @@ -91,6 +95,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class WallpaperLockScreenChangedEventArgs : EventArgs { private readonly string _wallpaperLockScreen = null; @@ -102,6 +107,7 @@ namespace Tizen.System /// /// The file path of the current lock screen wallpaper. /// + /// 3 public string Value { get @@ -121,6 +127,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class FontSizeChangedEventArgs : EventArgs { private readonly SystemSettingsFontSize _fontSize; @@ -132,6 +139,7 @@ namespace Tizen.System /// /// The current system font size. /// + /// 3 public SystemSettingsFontSize Value { get @@ -151,6 +159,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class FontTypeChangedEventArgs : EventArgs { private readonly string _fontType = null; @@ -162,6 +171,7 @@ namespace Tizen.System /// /// The current system font type. /// + /// 3 public string Value { get @@ -181,6 +191,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class MotionActivationSettingChangedEventArgs : EventArgs { private readonly bool _motionActivation; @@ -192,6 +203,7 @@ namespace Tizen.System /// /// Indicates whether the motion service is activated. /// + /// 3 public bool Value { get @@ -212,6 +224,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class EmailAlertRingtoneChangedEventArgs : EventArgs { private readonly string _emailAlertRingtone = null; @@ -223,6 +236,7 @@ namespace Tizen.System /// /// The file path of the current email alert ringtone. /// + /// 3 public string Value { get @@ -242,6 +256,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class UsbDebuggingSettingChangedEventArgs : EventArgs { private readonly bool _usbDebuggingEnabled; @@ -253,6 +268,7 @@ namespace Tizen.System /// /// Indicates whether the USB debugging is enabled. /// + /// 3 public bool Value { get @@ -272,6 +288,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class Data3GNetworkSettingChangedEventArgs : EventArgs { private readonly bool _data3GNetworkEnabled; @@ -283,6 +300,7 @@ namespace Tizen.System /// /// Indicates whether the 3G data network is enabled. /// + /// 3 public bool Value { get @@ -303,6 +321,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 4 public class LockScreenAppChangedEventArgs : EventArgs { private readonly string _lockscreenApp = null; @@ -314,6 +333,7 @@ namespace Tizen.System /// /// Indicates the lock screen application package name. /// + /// 4 public string Value { get @@ -333,6 +353,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class LocaleCountryChangedEventArgs : EventArgs { private readonly string _localeCountry = null; @@ -345,6 +366,7 @@ namespace Tizen.System /// Indicates the current country setting in the <LANGUAGE>_<REGION> syntax. /// The country setting is in the ISO 639-2 format, and the region setting is in the ISO 3166-1 alpha-2 format. /// + /// 3 public string Value { get @@ -364,6 +386,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class LocaleLanguageChangedEventArgs : EventArgs { private readonly string _localeLanguage = null; @@ -376,6 +399,7 @@ namespace Tizen.System /// Indicates the current language setting in the <LANGUAGE>_<REGION> syntax. /// The language setting is in the ISO 639-2 format and the region setting is in the ISO 3166-1 alpha-2 format. /// + /// 3 public string Value { get @@ -395,6 +419,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class LocaleTimeFormat24HourSettingChangedEventArgs : EventArgs { private readonly bool _localeTimeFormat24Hour; @@ -406,6 +431,7 @@ namespace Tizen.System /// /// Indicates whether the 24-hour clock is used. If the value is false, the 12-hour clock is used. /// + /// 3 public bool Value { get @@ -425,6 +451,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class LocaleTimeZoneChangedEventArgs : EventArgs { private readonly string _localeTimeZone = null; @@ -436,6 +463,7 @@ namespace Tizen.System /// /// Indicates the current time zone. /// + /// 3 public string Value { get @@ -455,6 +483,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class TimeChangedEventArgs : EventArgs { private readonly int _time; @@ -466,6 +495,7 @@ namespace Tizen.System /// /// Indicates the current time. /// + /// 3 public int Value { get @@ -485,6 +515,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class SoundLockSettingChangedEventArgs : EventArgs { private readonly bool _soundLock; @@ -496,6 +527,7 @@ namespace Tizen.System /// /// Indicates whether the screen lock sound is enabled on the device, for example, the LCD on or off sound. /// + /// 3 public bool Value { get @@ -515,6 +547,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class SoundSilentModeSettingChangedEventArgs : EventArgs { private readonly bool _soundSilentMode; @@ -526,6 +559,7 @@ namespace Tizen.System /// /// Indicates whether the device is in the silent mode. /// + /// 3 public bool Value { get @@ -545,6 +579,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class SoundTouchSettingChangedEventArgs : EventArgs { private readonly bool _soundTouch; @@ -556,6 +591,7 @@ namespace Tizen.System /// /// Indicates whether the screen touch sound is enabled on the device. /// + /// 3 public bool Value { get @@ -575,6 +611,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class DisplayScreenRotationAutoSettingChangedEventArgs : EventArgs { private readonly bool _displayScreenRotationAuto; @@ -586,6 +623,7 @@ namespace Tizen.System /// /// Indicates whether the rotation control is automatic. /// + /// 3 public bool Value { get @@ -605,6 +643,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class DeviceNameChangedEventArgs : EventArgs { private readonly string _deviceName = null; @@ -616,6 +655,7 @@ namespace Tizen.System /// /// Indicates the device name. /// + /// 3 public string Value { get @@ -635,6 +675,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class MotionSettingChangedEventArgs : EventArgs { private readonly bool _motionEnabled; @@ -646,6 +687,7 @@ namespace Tizen.System /// /// Indicates whether the device user has enabled the motion feature. /// + /// 3 public bool Value { get @@ -666,6 +708,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class NetworkWifiNotificationSettingChangedEventArgs : EventArgs { private readonly bool _networkWifiNotification; @@ -677,6 +720,7 @@ namespace Tizen.System /// /// Indicates whether Wi-Fi-related notifications are enabled on the device. /// + /// 3 public bool Value { get @@ -696,6 +740,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class NetworkFlightModeSettingChangedEventArgs : EventArgs { private readonly bool _networkFlightMode; @@ -707,6 +752,7 @@ namespace Tizen.System /// /// Indicates whether the device is in the flight mode. /// + /// 3 public bool Value { get @@ -726,6 +772,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class ScreenBacklightTimeChangedEventArgs : EventArgs { private readonly int _screenBacklightTime; @@ -737,6 +784,7 @@ namespace Tizen.System /// /// Indicates the backlight time (in seconds). /// + /// 3 public int Value { get @@ -757,6 +805,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class SoundNotificationChangedEventArgs : EventArgs { private readonly string _soundNotification = null; @@ -768,6 +817,7 @@ namespace Tizen.System /// /// Indicates the file path of the current notification tone set by the user. /// + /// 3 public string Value { get @@ -787,6 +837,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class SoundNotificationRepetitionPeriodChangedEventArgs : EventArgs { private readonly int _soundNotificationRepetitionPeriod; @@ -798,6 +849,7 @@ namespace Tizen.System /// /// Indicates the time period for notification repetitions. /// + /// 3 public int Value { get @@ -818,6 +870,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class LockStateChangedEventArgs : EventArgs { private readonly SystemSettingsIdleLockState _lockState; @@ -829,6 +882,7 @@ namespace Tizen.System /// /// Indicates the current lock state. /// + /// 3 public SystemSettingsIdleLockState Value { get @@ -848,6 +902,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class AdsIdChangedEventArgs : EventArgs { private readonly string _adsId = null; @@ -859,6 +914,7 @@ namespace Tizen.System /// /// Indicates the current lock state. /// + /// 3 public string Value { get @@ -879,6 +935,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class UltraDataSaveChangedEventArgs : EventArgs { private readonly SystemSettingsUdsState _ultraDataSave = SystemSettingsUdsState.UdsOff; @@ -890,6 +947,7 @@ namespace Tizen.System /// /// Indicates the current lock state. /// + /// 3 public SystemSettingsUdsState Value { get @@ -910,6 +968,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 3 public class UltraDataSavePackageListChangedEventArgs : EventArgs { private readonly string _ultraDataSavePackageList = null; @@ -921,6 +980,7 @@ namespace Tizen.System /// /// Indicates the current lock state. /// + /// 3 public string Value { get @@ -939,6 +999,7 @@ namespace Tizen.System /// Not Supported feature /// Invalid operation /// Thrown when application does not have privilege to access this method. + /// 4 public class AccessibilityTtsSettingChangedEventArgs : EventArgs { private readonly bool _AccessibilityTts; @@ -950,6 +1011,7 @@ namespace Tizen.System /// /// Indicates whether the screen touch sound is enabled on the device. /// + /// 4 public bool Value { get diff --git a/src/Tizen.System.Usb/Usb/EndpointDirection.cs b/src/Tizen.System.Usb/Usb/EndpointDirection.cs index 3405fdd..597cf39 100644 --- a/src/Tizen.System.Usb/Usb/EndpointDirection.cs +++ b/src/Tizen.System.Usb/Usb/EndpointDirection.cs @@ -19,6 +19,7 @@ namespace Tizen.System.Usb /// /// Enumeration of transfer direction for Endpoints. /// + /// 4 public enum EndpointDirection { /// diff --git a/src/Tizen.System.Usb/Usb/HotPluggedEventArgs.cs b/src/Tizen.System.Usb/Usb/HotPluggedEventArgs.cs index 89c7504..48e94ea 100644 --- a/src/Tizen.System.Usb/Usb/HotPluggedEventArgs.cs +++ b/src/Tizen.System.Usb/Usb/HotPluggedEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.System.Usb /// /// Event arguments for Hot Plugged event for USB devices. /// + /// 4 public class HotPluggedEventArgs : EventArgs { internal HotPluggedEventArgs(UsbDevice device, HotplugEventType type) @@ -32,11 +33,13 @@ namespace Tizen.System.Usb /// /// USB Device /// + /// 4 public UsbDevice Device { get; } /// /// Event Type /// + /// 4 public HotplugEventType EventType { get; } } } diff --git a/src/Tizen.System.Usb/Usb/HotplugEventType.cs b/src/Tizen.System.Usb/Usb/HotplugEventType.cs index 358b513..1f47cf8 100644 --- a/src/Tizen.System.Usb/Usb/HotplugEventType.cs +++ b/src/Tizen.System.Usb/Usb/HotplugEventType.cs @@ -19,6 +19,7 @@ namespace Tizen.System.Usb /// /// Enumeration of hot plugged event type for USB devices. /// + /// 4 public enum HotplugEventType { /// diff --git a/src/Tizen.System.Usb/Usb/SynchronizationType.cs b/src/Tizen.System.Usb/Usb/SynchronizationType.cs index b523087..4f2cc86 100644 --- a/src/Tizen.System.Usb/Usb/SynchronizationType.cs +++ b/src/Tizen.System.Usb/Usb/SynchronizationType.cs @@ -19,6 +19,7 @@ namespace Tizen.System.Usb /// /// Enumeration of isochronous endpoint's synchronization type. /// + /// 4 public enum SynchronizationType { /// diff --git a/src/Tizen.System.Usb/Usb/UsageType.cs b/src/Tizen.System.Usb/Usb/UsageType.cs index eb4af52..e0384e6 100644 --- a/src/Tizen.System.Usb/Usb/UsageType.cs +++ b/src/Tizen.System.Usb/Usb/UsageType.cs @@ -19,6 +19,7 @@ namespace Tizen.System.Usb /// /// Enumeration of an endpoint's usage type. /// + /// 4 public enum UsageType { /// diff --git a/src/Tizen.System.Usb/Usb/UsbBulkEndpoint.cs b/src/Tizen.System.Usb/Usb/UsbBulkEndpoint.cs index 0637109..282509a 100644 --- a/src/Tizen.System.Usb/Usb/UsbBulkEndpoint.cs +++ b/src/Tizen.System.Usb/Usb/UsbBulkEndpoint.cs @@ -21,6 +21,7 @@ namespace Tizen.System.Usb /// /// USB Bulk Endpoint class. /// + /// 4 public class UsbBulkEndpoint : UsbEndpoint { internal UsbBulkEndpoint(UsbInterface parent, Interop.UsbEndpointHandle handle) : base(parent, handle) @@ -42,6 +43,7 @@ namespace Tizen.System.Usb /// Number of bytes actually transferred. /// Throws exception if device is disconnected or not opened for operation. /// Throws exception if transfer timed-out. + /// 4 public int Transfer(byte[] buffer, int length, uint timeout) { return TransferImpl(buffer, length, timeout); diff --git a/src/Tizen.System.Usb/Usb/UsbConfiguration.cs b/src/Tizen.System.Usb/Usb/UsbConfiguration.cs index 7fe8304..53acadb 100755 --- a/src/Tizen.System.Usb/Usb/UsbConfiguration.cs +++ b/src/Tizen.System.Usb/Usb/UsbConfiguration.cs @@ -23,6 +23,7 @@ namespace Tizen.System.Usb /// /// Class to manage USB Configuration. /// + /// 4 public class UsbConfiguration : IDisposable { internal readonly Interop.UsbConfigHandle _handle; @@ -38,6 +39,7 @@ namespace Tizen.System.Usb /// /// Checks if device is self-powered in given configuration. /// + /// 4 public bool IsSelfPowered { get @@ -50,6 +52,7 @@ namespace Tizen.System.Usb /// /// Checks if device in given configuration supports remote wakeup. /// + /// 4 public bool SupportRemoteWakeup { get @@ -62,6 +65,7 @@ namespace Tizen.System.Usb /// /// Gets maximum power required in given configuration, in mA. /// + /// 4 public int MaximumPowerRequired { get @@ -74,6 +78,7 @@ namespace Tizen.System.Usb /// /// Dictionary mapping interfaces Ids to interface instances for given configuration. /// + /// 4 public IReadOnlyDictionary Interfaces { get @@ -98,6 +103,7 @@ namespace Tizen.System.Usb /// /// Configuration string. /// + /// 4 public string ConfigurationString { get @@ -113,6 +119,7 @@ namespace Tizen.System.Usb /// /// Throws exception if device is disconnected or not opened for operation or busy as its interfaces are currently claimed. /// + /// 4 public void SetAsActive() { ThrowIfDisposed(); @@ -131,6 +138,7 @@ namespace Tizen.System.Usb /// /// Releases all resources used by the ConnectionProfile. /// It should be called after finished using of the object. + /// 4 protected virtual void Dispose(bool disposing) { if (!disposedValue) @@ -151,6 +159,7 @@ namespace Tizen.System.Usb /// /// Releases all resources used by the ConnectionProfile. /// It should be called after finished using of the object. + /// 4 public void Dispose() { Dispose(true); diff --git a/src/Tizen.System.Usb/Usb/UsbControlEndpoint.cs b/src/Tizen.System.Usb/Usb/UsbControlEndpoint.cs index 2e1e7d4..959b3b5 100644 --- a/src/Tizen.System.Usb/Usb/UsbControlEndpoint.cs +++ b/src/Tizen.System.Usb/Usb/UsbControlEndpoint.cs @@ -21,6 +21,7 @@ namespace Tizen.System.Usb /// /// USB Control Endpoint class. /// + /// 4 public class UsbControlEndpoint : UsbEndpoint { private readonly UsbDevice _device; @@ -33,6 +34,7 @@ namespace Tizen.System.Usb /// /// Gets number of this endpoint. /// + /// 4 public new int Id { get @@ -44,6 +46,7 @@ namespace Tizen.System.Usb /// /// Gets direction of this endpoint. /// + /// 4 public new EndpointDirection Direction { get @@ -55,6 +58,7 @@ namespace Tizen.System.Usb /// /// Gets max packet size of given endpoint. /// + /// 4 public new int MaxPacketSize { get @@ -80,6 +84,7 @@ namespace Tizen.System.Usb /// Transferred Number of transferred bytes. /// Throws exception if device is disconnected or not opened for operation. /// Throws exception if transfer timed-out. + /// 4 public int Transfer(byte requestType, byte request, ushort value, ushort index, byte[] data, ushort length, uint timeout) { _device.ThrowIfDisposed(); diff --git a/src/Tizen.System.Usb/Usb/UsbDevice.cs b/src/Tizen.System.Usb/Usb/UsbDevice.cs index df6e9d7..6d7bf01 100755 --- a/src/Tizen.System.Usb/Usb/UsbDevice.cs +++ b/src/Tizen.System.Usb/Usb/UsbDevice.cs @@ -23,6 +23,7 @@ namespace Tizen.System.Usb /// /// Class to manage USB host devices. This class contains operations for enumerating, opening and closing devices. /// + /// 4 public class UsbDevice : IDisposable { internal readonly Interop.HostDeviceHandle _handle; @@ -47,6 +48,7 @@ namespace Tizen.System.Usb /// Number of the bus, this device is connected to. /// /// Throws exception if user has insufficient permission on device. + /// 4 public int BusId { get { @@ -58,6 +60,7 @@ namespace Tizen.System.Usb /// /// Address of device on the bus. /// + /// 4 public int Address { get @@ -70,6 +73,7 @@ namespace Tizen.System.Usb /// /// List of available port numbers from a device. /// + /// 4 public IEnumerable Ports { get @@ -82,6 +86,7 @@ namespace Tizen.System.Usb /// /// Checks if device is opened. /// + /// 4 public bool IsOpened { get @@ -94,6 +99,7 @@ namespace Tizen.System.Usb /// /// Control endpoint (endpoint 0). /// + /// 4 public UsbControlEndpoint ControlEndpoint { get @@ -107,6 +113,7 @@ namespace Tizen.System.Usb /// Active configuration for the device. /// /// Throws exception if device is disconnected. + /// 4 public UsbConfiguration ActiveConfiguration { get @@ -121,6 +128,7 @@ namespace Tizen.System.Usb /// /// Dictionary mapping configuration Ids to configuration instances for this device. /// + /// 4 public IReadOnlyDictionary Configurations { get @@ -133,6 +141,7 @@ namespace Tizen.System.Usb /// /// Device information such as version, class, subclass etc. /// + /// 4 public UsbDeviceInformation DeviceInformation { get @@ -145,6 +154,7 @@ namespace Tizen.System.Usb /// /// String associated with device. /// + /// 4 public UsbDeviceStrings Strings { get @@ -160,6 +170,7 @@ namespace Tizen.System.Usb /// Throws exception in case of insufficient memory. /// Throws exception if device is disconnected. /// Throws exception if user has insufficient permission on device. + /// 4 public void Open() { ThrowIfDisposed(); @@ -170,6 +181,7 @@ namespace Tizen.System.Usb /// Closes device for operations. /// /// Throws exception if device is not opened for operation. + /// 4 public void Close() { ThrowIfDisposed(); @@ -190,6 +202,7 @@ namespace Tizen.System.Usb /// /// Releases all resources used by the ConnectionProfile. /// It should be called after finished using of the object. + /// 4 protected virtual void Dispose(bool disposing) { if (!disposedValue) @@ -218,6 +231,7 @@ namespace Tizen.System.Usb /// /// Releases all resources used by the ConnectionProfile. /// It should be called after finished using of the object. + /// 4 public void Dispose() { Dispose(true); diff --git a/src/Tizen.System.Usb/Usb/UsbDeviceInformation.cs b/src/Tizen.System.Usb/Usb/UsbDeviceInformation.cs index a671022..3761897 100755 --- a/src/Tizen.System.Usb/Usb/UsbDeviceInformation.cs +++ b/src/Tizen.System.Usb/Usb/UsbDeviceInformation.cs @@ -21,6 +21,7 @@ namespace Tizen.System.Usb /// /// Device information for USB device. /// + /// 4 public class UsbDeviceInformation { private readonly UsbDevice _device; @@ -34,6 +35,7 @@ namespace Tizen.System.Usb /// USB specification release number as binary-coded decimal. /// /// Throws exception if user has insufficient permission on device. + /// 4 public int UsbVersion { get @@ -46,6 +48,7 @@ namespace Tizen.System.Usb /// /// Gets device class. /// + /// 4 public int Class { get @@ -58,6 +61,7 @@ namespace Tizen.System.Usb /// /// Gets device sub class. /// + /// 4 public int Subclass { get @@ -70,6 +74,7 @@ namespace Tizen.System.Usb /// /// Gets device protocol. /// + /// 4 public int Protocol { get @@ -82,6 +87,7 @@ namespace Tizen.System.Usb /// /// Gets vendor id. /// + /// 4 public int VendorId { get @@ -94,6 +100,7 @@ namespace Tizen.System.Usb /// /// Gets product id. /// + /// 4 public int ProductId { get @@ -106,6 +113,7 @@ namespace Tizen.System.Usb /// /// Gets device release number in binary-coded decimal. /// + /// 4 public int DeviceVersion { get diff --git a/src/Tizen.System.Usb/Usb/UsbDeviceStrings.cs b/src/Tizen.System.Usb/Usb/UsbDeviceStrings.cs index cc9eb01..d5ac067 100755 --- a/src/Tizen.System.Usb/Usb/UsbDeviceStrings.cs +++ b/src/Tizen.System.Usb/Usb/UsbDeviceStrings.cs @@ -21,6 +21,7 @@ namespace Tizen.System.Usb /// /// String information for USB device. /// + /// 4 public class UsbDeviceStrings { private readonly UsbDevice _device; @@ -37,6 +38,7 @@ namespace Tizen.System.Usb /// /// Throws exception if device is disconnected or not opened for operation. /// Throws exception if user has insufficient permission on device. + /// 4 public string Manufacturer { get @@ -51,6 +53,7 @@ namespace Tizen.System.Usb /// /// Throws exception if device is not opened for operation. /// Throws exception if user has insufficient permission on device. + /// 4 public string Product { get @@ -65,6 +68,7 @@ namespace Tizen.System.Usb /// /// Throws exception if device is not opened for operation. /// Throws exception if user has insufficient permission on device. + /// 4 public string Serial { get diff --git a/src/Tizen.System.Usb/Usb/UsbEndpoint.cs b/src/Tizen.System.Usb/Usb/UsbEndpoint.cs index 8eaba21..e06716e 100755 --- a/src/Tizen.System.Usb/Usb/UsbEndpoint.cs +++ b/src/Tizen.System.Usb/Usb/UsbEndpoint.cs @@ -21,6 +21,7 @@ namespace Tizen.System.Usb /// /// USB Endpoint class. /// + /// 4 public class UsbEndpoint { internal readonly Interop.UsbEndpointHandle _handle; @@ -35,6 +36,7 @@ namespace Tizen.System.Usb /// /// Gets number of this endpoint. /// + /// 4 public int Id { get @@ -47,6 +49,7 @@ namespace Tizen.System.Usb /// /// Gets direction of this endpoint. /// + /// 4 public EndpointDirection Direction { get @@ -59,6 +62,7 @@ namespace Tizen.System.Usb /// /// Gets max packet size of given endpoint. /// + /// 4 public int MaxPacketSize { get diff --git a/src/Tizen.System.Usb/Usb/UsbInterface.cs b/src/Tizen.System.Usb/Usb/UsbInterface.cs index f0f327c..1fd26d2 100755 --- a/src/Tizen.System.Usb/Usb/UsbInterface.cs +++ b/src/Tizen.System.Usb/Usb/UsbInterface.cs @@ -22,6 +22,7 @@ namespace Tizen.System.Usb /// /// Class to manage USB Interfaces. /// + /// 4 public class UsbInterface { internal readonly Interop.UsbInterfaceHandle _handle; @@ -38,6 +39,7 @@ namespace Tizen.System.Usb /// /// Gets number of given interface. /// + /// 4 public int Id { get @@ -50,6 +52,7 @@ namespace Tizen.System.Usb /// /// Sets alternative setting. Use index of new alternative setting for given interface. /// + /// 4 public int AlternateSetting { set @@ -62,6 +65,7 @@ namespace Tizen.System.Usb /// /// Dictionary mapping endpoint Ids to endpoint instances for given interface. /// + /// 4 public IReadOnlyDictionary Endpoints { get @@ -88,6 +92,7 @@ namespace Tizen.System.Usb /// Gets string describing an interface. /// /// + /// 4 public string InterfaceString() { ThrowIfDisposed(); @@ -101,6 +106,7 @@ namespace Tizen.System.Usb /// /// Throws exception if device is disconnected or not opened for operation or another program or driver has claimed the interface. /// + /// 4 public void Claim(bool force) { ThrowIfDisposed(); @@ -115,6 +121,7 @@ namespace Tizen.System.Usb /// /// Throws exception if device is disconnected or not opened for operation. /// Throws exception if user has insufficient permission on device. + /// 4 public void Release() { ThrowIfDisposed(); diff --git a/src/Tizen.System.Usb/Usb/UsbInterruptEndpoint.cs b/src/Tizen.System.Usb/Usb/UsbInterruptEndpoint.cs index 53a4a73..4cbd76c 100755 --- a/src/Tizen.System.Usb/Usb/UsbInterruptEndpoint.cs +++ b/src/Tizen.System.Usb/Usb/UsbInterruptEndpoint.cs @@ -21,6 +21,7 @@ namespace Tizen.System.Usb /// /// USB Interrupt Endpoint class. /// + /// 4 public class UsbInterruptEndpoint : UsbEndpoint { internal UsbInterruptEndpoint(UsbInterface parent, Interop.UsbEndpointHandle handle) : base(parent, handle) @@ -30,6 +31,7 @@ namespace Tizen.System.Usb /// /// Gets interval for polling endpoint for data transfers, in frame counts (refer to USB protocol specification). /// + /// 4 public int PollingInterval { get @@ -54,6 +56,7 @@ namespace Tizen.System.Usb /// Number of bytes actually transferred. /// Throws exception if device is disconnected or not opened for operation. /// Throws exception if transfer timed-out. + /// 4 public int Transfer(byte[] buffer, int length, uint timeout) { return TransferImpl(buffer, length, timeout); diff --git a/src/Tizen.System.Usb/Usb/UsbIsochronousEndpoint.cs b/src/Tizen.System.Usb/Usb/UsbIsochronousEndpoint.cs index 1544c43..6367815 100644 --- a/src/Tizen.System.Usb/Usb/UsbIsochronousEndpoint.cs +++ b/src/Tizen.System.Usb/Usb/UsbIsochronousEndpoint.cs @@ -19,6 +19,7 @@ namespace Tizen.System.Usb /// /// USB Isochronous Endpoint class. /// + /// 4 public class UsbIsochronousEndpoint : UsbEndpoint { internal UsbIsochronousEndpoint(UsbInterface parent, Interop.UsbEndpointHandle handle) : base(parent, handle) @@ -28,6 +29,7 @@ namespace Tizen.System.Usb /// /// Gets synchronization type of this endpoint. /// + /// 4 public SynchronizationType SynchronizationType { get @@ -40,6 +42,7 @@ namespace Tizen.System.Usb /// /// Gets usage type of this endpoint. /// + /// 4 public UsageType UsageType { get diff --git a/src/Tizen.System.Usb/Usb/UsbManager.cs b/src/Tizen.System.Usb/Usb/UsbManager.cs index cdaaaa1..bb3211e 100755 --- a/src/Tizen.System.Usb/Usb/UsbManager.cs +++ b/src/Tizen.System.Usb/Usb/UsbManager.cs @@ -23,6 +23,7 @@ namespace Tizen.System.Usb /// /// USB Manager class. /// + /// 4 public class UsbManager : IDisposable { private readonly Interop.UsbContextHandle _context = null; @@ -32,6 +33,7 @@ namespace Tizen.System.Usb /// /// USB Manager Constructor. /// + /// 4 public UsbManager() { _context = Interop.UsbContextHandle.GetContextHandle(); @@ -50,6 +52,7 @@ namespace Tizen.System.Usb /// Throws exception if USB host feature is not enabled. /// Throws exception in case of insufficient memory. /// Throws exception if user has insufficient permission on device. + /// 4 public IEnumerable AvailableDevices { get @@ -62,6 +65,7 @@ namespace Tizen.System.Usb /// /// Event handler for events when a USB device is attached or detached. /// + /// 4 public event EventHandler DeviceHotPlugged; internal void HostHotplugCallback(IntPtr devHandle, IntPtr userData) @@ -113,6 +117,7 @@ namespace Tizen.System.Usb Dispose(false); } + /// 4 public void Dispose() { Dispose(true); diff --git a/src/Tizen.System/Device/Battery.cs b/src/Tizen.System/Device/Battery.cs index a81bc6b..5c9ebe0 100755 --- a/src/Tizen.System/Device/Battery.cs +++ b/src/Tizen.System/Device/Battery.cs @@ -71,6 +71,7 @@ namespace Tizen.System /// Console.WriteLine("battery Charging state is: {0}", Tizen.System.Battery.IsCharging); /// Console.WriteLine("battery Percent is: {0}", Tizen.System.Battery.Percent); /// + /// 3 public static class Battery { private static readonly object s_lock = new object(); diff --git a/src/Tizen.System/Device/DeviceEventArgs.cs b/src/Tizen.System/Device/DeviceEventArgs.cs index 53a75bb..81e149c 100644 --- a/src/Tizen.System/Device/DeviceEventArgs.cs +++ b/src/Tizen.System/Device/DeviceEventArgs.cs @@ -21,6 +21,7 @@ namespace Tizen.System /// /// BatteryPercentChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryPercentChanged event from the battery class. /// + /// 3 public class BatteryPercentChangedEventArgs : EventArgs { internal BatteryPercentChangedEventArgs(){} @@ -35,6 +36,7 @@ namespace Tizen.System /// /// BatteryLevelChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryLevelChanged event from the battery class. /// + /// 3 public class BatteryLevelChangedEventArgs : EventArgs { internal BatteryLevelChangedEventArgs(){} @@ -48,6 +50,7 @@ namespace Tizen.System /// /// BatteryChargingStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryChargingStateChanged event from the battery class. /// + /// 3 public class BatteryChargingStateChangedEventArgs : EventArgs { internal BatteryChargingStateChangedEventArgs() {} @@ -61,6 +64,7 @@ namespace Tizen.System /// /// DisplayStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the DisplayStateChanged event from the display class. /// + /// 3 public class DisplayStateChangedEventArgs : EventArgs { internal DisplayStateChangedEventArgs() {} @@ -74,6 +78,7 @@ namespace Tizen.System /// /// LedBrightnessChangedEventArgs is an extended EventArgs class. This class contains event arguments for the LedBrightnessChanged event from the LED class. /// + /// 3 public class LedBrightnessChangedEventArgs : EventArgs { internal LedBrightnessChangedEventArgs() {} diff --git a/src/Tizen.System/Device/Display.cs b/src/Tizen.System/Device/Display.cs index 4533185..a44caee 100755 --- a/src/Tizen.System/Device/Display.cs +++ b/src/Tizen.System/Device/Display.cs @@ -60,6 +60,7 @@ namespace Tizen.System /// Console.WriteLine("Total number of Displays are: {0}", Tizen.System.Display.NumberOfDisplays); /// /// + /// 3 public class Display { private readonly int _displayId; diff --git a/src/Tizen.System/Device/Haptic.cs b/src/Tizen.System/Device/Haptic.cs index 38374df..4bc49e3 100755 --- a/src/Tizen.System/Device/Haptic.cs +++ b/src/Tizen.System/Device/Haptic.cs @@ -34,6 +34,7 @@ namespace Tizen.System /// Console.WriteLine("Total number of Vibrators are: {0}", Tizen.System.Vibrator.NumberOfVibrators); /// /// + /// 3 public class Vibrator : IDisposable { private readonly int _vibratorId; diff --git a/src/Tizen.System/Device/IR.cs b/src/Tizen.System/Device/IR.cs index efd8664..67b0274 100755 --- a/src/Tizen.System/Device/IR.cs +++ b/src/Tizen.System/Device/IR.cs @@ -32,6 +32,7 @@ namespace Tizen.System /// Console.WriteLine("IR availability for this device is: {0}", IR.IsAvailable); /// /// + /// 3 public static class IR { /// diff --git a/src/Tizen.System/Device/Led.cs b/src/Tizen.System/Device/Led.cs index bcc0d2f..8811f31 100755 --- a/src/Tizen.System/Device/Led.cs +++ b/src/Tizen.System/Device/Led.cs @@ -40,15 +40,16 @@ namespace Tizen.System /// Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness); /// /// + /// 3 public static class Led { /// /// Gets the maximum brightness value of the LED that is located next to the camera. + /// /// 3 /// When an invalid parameter value is set. /// If the privilege is not set. /// In case the device does not support this behavior. - /// public static int MaxBrightness { get diff --git a/src/Tizen.System/Device/Power.cs b/src/Tizen.System/Device/Power.cs index 4c8c526..a69288f 100755 --- a/src/Tizen.System/Device/Power.cs +++ b/src/Tizen.System/Device/Power.cs @@ -28,6 +28,7 @@ namespace Tizen.System /// /// http://tizen.org/privilege/display /// + /// 3 public static class Power { /// diff --git a/src/Tizen.Telephony/Tizen.Telephony/Call.cs b/src/Tizen.Telephony/Tizen.Telephony/Call.cs index 2e0f127..bc7634a 100644 --- a/src/Tizen.Telephony/Tizen.Telephony/Call.cs +++ b/src/Tizen.Telephony/Tizen.Telephony/Call.cs @@ -25,6 +25,7 @@ namespace Tizen.Telephony /// 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. /// + /// 3 public class Call { internal IntPtr _handle; diff --git a/src/Tizen.Telephony/Tizen.Telephony/CallHandle.cs b/src/Tizen.Telephony/Tizen.Telephony/CallHandle.cs index ca85423..71a2f04 100644 --- a/src/Tizen.Telephony/Tizen.Telephony/CallHandle.cs +++ b/src/Tizen.Telephony/Tizen.Telephony/CallHandle.cs @@ -22,6 +22,7 @@ namespace Tizen.Telephony /// /// This class provides the APIs to get the information about calls. /// + /// 3 public class CallHandle { private IntPtr _callHandle; @@ -29,6 +30,7 @@ namespace Tizen.Telephony /// /// Enumeration for the call status. /// + /// 3 public enum CallStatus { /// @@ -64,6 +66,7 @@ namespace Tizen.Telephony /// /// Enumeration for the call type. /// + /// 3 public enum CallType { /// @@ -87,6 +90,7 @@ namespace Tizen.Telephony /// /// Enumeration for the call direction. /// + /// 3 public enum CallDirection { /// diff --git a/src/Tizen.Telephony/Tizen.Telephony/ChangeNotificationEventArgs.cs b/src/Tizen.Telephony/Tizen.Telephony/ChangeNotificationEventArgs.cs index 0c4b6de..01abf67 100644 --- a/src/Tizen.Telephony/Tizen.Telephony/ChangeNotificationEventArgs.cs +++ b/src/Tizen.Telephony/Tizen.Telephony/ChangeNotificationEventArgs.cs @@ -20,6 +20,7 @@ namespace Tizen.Telephony /// /// This class contains the data related to the Notification event. /// + /// 3 public class ChangeNotificationEventArgs : EventArgs { internal ChangeNotificationEventArgs(Notification noti, object data) @@ -31,6 +32,7 @@ namespace Tizen.Telephony /// /// Enumeration for the Telephony Notification. /// + /// 3 public enum Notification { /// diff --git a/src/Tizen.Telephony/Tizen.Telephony/Modem.cs b/src/Tizen.Telephony/Tizen.Telephony/Modem.cs index ea19eeb..2451b53 100644 --- a/src/Tizen.Telephony/Tizen.Telephony/Modem.cs +++ b/src/Tizen.Telephony/Tizen.Telephony/Modem.cs @@ -21,6 +21,7 @@ namespace Tizen.Telephony /// /// This class provides APIs to obtain information from the modem. /// + /// 3 public class Modem { internal IntPtr _handle; @@ -50,6 +51,7 @@ namespace Tizen.Telephony /// /// Enumeration for the Modem Power Status. /// + /// 3 public enum PowerStatus { /// diff --git a/src/Tizen.Telephony/Tizen.Telephony/Network.cs b/src/Tizen.Telephony/Tizen.Telephony/Network.cs index 5f078c0..8496a2d 100644 --- a/src/Tizen.Telephony/Tizen.Telephony/Network.cs +++ b/src/Tizen.Telephony/Tizen.Telephony/Network.cs @@ -21,6 +21,7 @@ namespace Tizen.Telephony /// /// The Network class provides APIs to obtain information about the current telephony service network. /// + /// 3 public class Network { internal IntPtr _handle; @@ -51,6 +52,7 @@ namespace Tizen.Telephony /// Enumeration for the RSSI (Receive Signal Strength Indicator). /// Rssi6 indicates the highest strength. /// + /// 3 public enum Rssi { /// @@ -90,6 +92,7 @@ namespace Tizen.Telephony /// /// Enumeration for the network types. /// + /// 3 public enum Type { /// @@ -157,6 +160,7 @@ namespace Tizen.Telephony /// /// Enumeration for the PS types. /// + /// 3 public enum PsType { /// @@ -184,6 +188,7 @@ namespace Tizen.Telephony /// /// Enumeration for the network service states. /// + /// 3 public enum ServiceState { /// @@ -207,6 +212,7 @@ namespace Tizen.Telephony /// /// Enumeration for the network name priority. /// + /// 3 public enum NameOption { /// @@ -230,6 +236,7 @@ namespace Tizen.Telephony /// /// Enumeration for the possible 'default' Data Subscriptions for the Packet Switched(PS). /// + /// 3 public enum DefaultDataSubscription { /// @@ -249,6 +256,7 @@ namespace Tizen.Telephony /// /// Enumeration for defining the possible 'default' Subscriptions for the Circuit Switched(CS). /// + /// 3 public enum DefaultSubscription { /// @@ -268,6 +276,7 @@ namespace Tizen.Telephony /// /// Enumeration for the network selection modes. /// + /// 3 public enum SelectionMode { /// diff --git a/src/Tizen.Telephony/Tizen.Telephony/Sim.cs b/src/Tizen.Telephony/Tizen.Telephony/Sim.cs index afd6828..0ef4b7f 100644 --- a/src/Tizen.Telephony/Tizen.Telephony/Sim.cs +++ b/src/Tizen.Telephony/Tizen.Telephony/Sim.cs @@ -22,6 +22,7 @@ namespace Tizen.Telephony /// /// This class provides APIs that allow you to extract the information stored on a SIM card. /// + /// 3 public class Sim { internal IntPtr _handle; @@ -51,6 +52,7 @@ namespace Tizen.Telephony /// /// Enumeration for the state of the SIM card. /// + /// 3 public enum State { /// @@ -74,6 +76,7 @@ namespace Tizen.Telephony /// /// Enumeration for the lock state of the SIM card. /// + /// 3 public enum LockState { /// @@ -101,6 +104,7 @@ namespace Tizen.Telephony /// /// Enumeration for the type of the SIM card. /// + /// 3 public enum ApplicationType { /// diff --git a/src/Tizen.Telephony/Tizen.Telephony/SlotHandle.cs b/src/Tizen.Telephony/Tizen.Telephony/SlotHandle.cs index 613b6e0..e372b52 100644 --- a/src/Tizen.Telephony/Tizen.Telephony/SlotHandle.cs +++ b/src/Tizen.Telephony/Tizen.Telephony/SlotHandle.cs @@ -23,6 +23,7 @@ namespace Tizen.Telephony /// /// This class provides APIs that provide functionality related to the slot handle. /// + /// 3 public class SlotHandle { internal IntPtr _handle; @@ -37,6 +38,7 @@ namespace Tizen.Telephony /// The event handler for receiving the Telephony state changes. /// This event will be triggered for the NotificationIds given in the SetNotificationId API. /// + /// 3 public event EventHandler ChangeNotification; internal IntPtr Handle diff --git a/src/Tizen.Telephony/Tizen.Telephony/StateEventArgs.cs b/src/Tizen.Telephony/Tizen.Telephony/StateEventArgs.cs index 44b67f5..88fb0cd 100644 --- a/src/Tizen.Telephony/Tizen.Telephony/StateEventArgs.cs +++ b/src/Tizen.Telephony/Tizen.Telephony/StateEventArgs.cs @@ -20,6 +20,7 @@ namespace Tizen.Telephony /// /// This class contains the data related to the State changed event. /// + /// 3 public class StateEventArgs : EventArgs { internal StateEventArgs(State s) diff --git a/src/Tizen.Telephony/Tizen.Telephony/Telephony.cs b/src/Tizen.Telephony/Tizen.Telephony/Telephony.cs index d26b7d5..ba67408 100644 --- a/src/Tizen.Telephony/Tizen.Telephony/Telephony.cs +++ b/src/Tizen.Telephony/Tizen.Telephony/Telephony.cs @@ -24,6 +24,7 @@ namespace Tizen.Telephony /// /// Enumeration for the telephony states. /// + /// 3 public enum State { /// @@ -43,6 +44,7 @@ namespace Tizen.Telephony /// /// Enumeration for the preferred voice call subscription. /// + /// 3 public enum CallPreferredVoiceSubscription { /// @@ -71,6 +73,7 @@ namespace Tizen.Telephony /// 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. /// + /// 3 public static class Manager { internal static List _telephonyHandle = new List(); diff --git a/src/Tizen.Tracer/Tizen/Tracer.cs b/src/Tizen.Tracer/Tizen/Tracer.cs index 020c97f..cfa77fd 100755 --- a/src/Tizen.Tracer/Tizen/Tracer.cs +++ b/src/Tizen.Tracer/Tizen/Tracer.cs @@ -21,6 +21,7 @@ namespace Tizen /// /// Provides functions for writing a trace message to the system trace buffer. /// + /// 3 public static class Tracer { /// @@ -31,6 +32,7 @@ namespace Tizen /// /// The name of an event (optionally containing format specifiers). /// + /// 3 public static void Begin (String name) { Interop.Tracer.Begin (name); @@ -44,6 +46,7 @@ namespace Tizen /// The specific error code can be obtained using the Tizen.Internals.Errors.ErrorFacts.GetLastResult() method. /// /// + /// 3 public static void End () { Interop.Tracer.End (); @@ -58,6 +61,7 @@ namespace Tizen /// An unique identifier for distinguishing simultaneous events. /// The name of an event (optionally containing format specifiers). /// + /// 3 public static void AsyncBegin (int cookie, String name) { Interop.Tracer.AsyncBegin (cookie, name); @@ -73,6 +77,7 @@ namespace Tizen /// An unique identifier for distinguishing simultaneous events. /// The name of an event (optionally containing format specifiers). /// + /// 3 public static void AsyncEnd (int cookie, String name) { Interop.Tracer.AsyncEnd (cookie, name); @@ -86,6 +91,7 @@ namespace Tizen /// /// The integer variable to trace. /// The name of an event (optionally containing format specifiers). + /// 3 public static void TraceValue (int value, String name) { Interop.Tracer.TraceValue (value, name); diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/AccessibilityStateChangedEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/AccessibilityStateChangedEventArgs.cs index 45277e4..d772cd3 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/AccessibilityStateChangedEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/AccessibilityStateChangedEventArgs.cs @@ -19,6 +19,7 @@ namespace Tizen.Uix.InputMethod /// /// This Class contains data related to AccessibilityStateChanged Event /// + /// 4 public class AccessibilityStateChangedEventArgs { internal AccessibilityStateChangedEventArgs(bool state) @@ -29,6 +30,7 @@ namespace Tizen.Uix.InputMethod /// /// Accessibility option state /// + /// 4 public bool State { get; diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/CursorPositionUpdatedEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/CursorPositionUpdatedEventArgs.cs index 55e818e..d21c828 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/CursorPositionUpdatedEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/CursorPositionUpdatedEventArgs.cs @@ -19,6 +19,7 @@ namespace Tizen.Uix.InputMethod /// /// This Class contains data related to CursorPositionUpdated Event /// + /// 4 public class CursorPositionUpdatedEventArgs { internal CursorPositionUpdatedEventArgs(int cursorPos) @@ -29,6 +30,7 @@ namespace Tizen.Uix.InputMethod /// /// The cursor position /// + /// 4 public int CursorPosition { get; diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DataSetEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DataSetEventArgs.cs index c1a722d..7a80346 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DataSetEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DataSetEventArgs.cs @@ -19,6 +19,7 @@ namespace Tizen.Uix.InputMethod /// /// This Class contains data related to DataSet Event /// + /// 4 public class SetDataEventArgs { internal SetDataEventArgs(byte[] destination, uint dataLength) @@ -30,6 +31,7 @@ namespace Tizen.Uix.InputMethod /// /// The specific data to be set to the input panel /// + /// 4 public byte[] Data { get; @@ -39,6 +41,7 @@ namespace Tizen.Uix.InputMethod /// /// The length of data, in bytes, to send to the input panel /// + /// 4 public uint DataLength { get; diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DisplayLanguageChangedEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DisplayLanguageChangedEventArgs.cs index b022a35..9295fa5 100644 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DisplayLanguageChangedEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/DisplayLanguageChangedEventArgs.cs @@ -19,6 +19,7 @@ namespace Tizen.Uix.InputMethod /// /// This Class contains data related to DisplayLanguageChanged Event /// + /// 4 public class DisplayLanguageChangedEventArgs { internal DisplayLanguageChangedEventArgs(string language) @@ -29,6 +30,7 @@ namespace Tizen.Uix.InputMethod /// /// The language code /// + /// 4 public string Language { get; diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/EditorWindow.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/EditorWindow.cs index 5599186..4dff275 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/EditorWindow.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/EditorWindow.cs @@ -24,6 +24,7 @@ namespace Tizen.Uix.InputMethod /// /// The Editor window class /// + /// 4 public class EditorWindow : Window { internal static IntPtr _handle = IntPtr.Zero; @@ -37,6 +38,7 @@ namespace Tizen.Uix.InputMethod /// /// This API creates handle for editor window. /// + /// 4 protected override IntPtr CreateHandle(EvasObject parent) { return _handle; @@ -45,6 +47,7 @@ namespace Tizen.Uix.InputMethod /// /// This API gets handle for editor window. /// + /// 4 public IntPtr GetHandle() { return _handle; @@ -65,6 +68,7 @@ namespace Tizen.Uix.InputMethod /// 1) The application does not have the privilege to call this function /// 2) IME main loop isn't started yet /// + /// 4 public static void SetSize(int portraitWidth, int portraitHeight, int landscapeWidth, int landscapeHeight) { ErrorCode error = ImeSetSize(portraitWidth, portraitHeight, landscapeWidth, landscapeHeight); diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/FocusedInEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/FocusedInEventArgs.cs index 77dad6d..cd7741c 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/FocusedInEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/FocusedInEventArgs.cs @@ -19,6 +19,7 @@ namespace Tizen.Uix.InputMethod /// /// This Class contains data related to FocusedIn Event /// + /// 4 public class FocusedInEventArgs { internal FocusedInEventArgs(int contextId) @@ -29,6 +30,7 @@ namespace Tizen.Uix.InputMethod /// /// The input context identification value of an associated text input UI control /// + /// 4 public int ContextId { get; diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/FocusedOutEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/FocusedOutEventArgs.cs index 9990cea..013f7c6 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/FocusedOutEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/FocusedOutEventArgs.cs @@ -19,6 +19,7 @@ namespace Tizen.Uix.InputMethod /// /// This Class contains data related to FocusedOut Event /// + /// 4 public class FocusedOutEventArgs { internal FocusedOutEventArgs(int contextId) @@ -29,6 +30,7 @@ namespace Tizen.Uix.InputMethod /// /// The input context identification value of an associated text input UI control /// + /// 4 public int ContextId { get; diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodContext.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodContext.cs index 6b573c7..f9d8fd4 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodContext.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodContext.cs @@ -23,6 +23,7 @@ namespace Tizen.Uix.InputMethod /// /// Enumeration for Input Panel Layout /// + /// 4 public enum InputPanelLayout { /// @@ -94,6 +95,7 @@ namespace Tizen.Uix.InputMethod /// /// Enumeration for Layout Variation /// + /// 4 public enum LayoutVariation { /// @@ -141,6 +143,7 @@ namespace Tizen.Uix.InputMethod /// /// Enumeration for AutoCapital Type /// + /// 4 public enum AutoCapitalization { /// @@ -168,6 +171,7 @@ namespace Tizen.Uix.InputMethod /// /// Enumeration for InputPanel ReturnKey Type /// + /// 4 public enum InputPanelReturnKey { /// @@ -215,6 +219,7 @@ namespace Tizen.Uix.InputMethod /// /// Enumeration for InputHints /// + /// 4 public enum InputHints { /// @@ -242,6 +247,7 @@ namespace Tizen.Uix.InputMethod /// /// Enumeration for BiDi Direction /// + /// 4 public enum BiDirection { /// @@ -265,6 +271,7 @@ namespace Tizen.Uix.InputMethod /// /// Enumeration for InputPanel Language /// + /// 4 public enum InputPanelLanguage { /// @@ -284,6 +291,7 @@ namespace Tizen.Uix.InputMethod /// /// This class represents the context of InputMethodEditor /// + /// 4 public class InputMethodContext { private IntPtr _handle; @@ -295,6 +303,7 @@ namespace Tizen.Uix.InputMethod /// /// Gets the layout information. /// + /// 4 public InputPanelLayout Layout { get @@ -313,6 +322,7 @@ namespace Tizen.Uix.InputMethod /// /// Gets the layout variation information. /// + /// 4 public LayoutVariation LayoutVariation { get @@ -331,6 +341,7 @@ namespace Tizen.Uix.InputMethod /// /// Gets the cursor position information. /// + /// 4 public int CursorPosition { get @@ -349,6 +360,7 @@ namespace Tizen.Uix.InputMethod /// /// Gets the autocapital type information. /// + /// 4 public AutoCapitalization AutoCapitalization { get @@ -367,6 +379,7 @@ namespace Tizen.Uix.InputMethod /// /// Gets the Return key label type information. /// + /// 4 public InputPanelReturnKey ReturnKey { get @@ -385,6 +398,7 @@ namespace Tizen.Uix.InputMethod /// /// Gets the Return key state information. /// + /// 4 public bool ReturnKeyState { get @@ -403,6 +417,7 @@ namespace Tizen.Uix.InputMethod /// /// Gets the prediction mode information. /// + /// 4 public bool PredictionMode { get @@ -421,6 +436,7 @@ namespace Tizen.Uix.InputMethod /// /// Gets the password mode information. /// + /// 4 public bool PasswordMode { get @@ -439,6 +455,7 @@ namespace Tizen.Uix.InputMethod /// /// Gets the input hint information. /// + /// 4 public InputHints InputHint { get @@ -457,6 +474,7 @@ namespace Tizen.Uix.InputMethod /// /// Gets the text bidirectional information. /// + /// 4 public BiDirection BiDirection { get @@ -475,6 +493,7 @@ namespace Tizen.Uix.InputMethod /// /// Gets the preferred language information. /// + /// 4 public InputPanelLanguage Language { get diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodDeviceInformation.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodDeviceInformation.cs index 51464a8..a706d64 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodDeviceInformation.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodDeviceInformation.cs @@ -24,6 +24,7 @@ namespace Tizen.Uix.InputMethod /// /// Enumeration for Device Class /// + /// 4 public enum DeviceClass { /// @@ -67,6 +68,7 @@ namespace Tizen.Uix.InputMethod /// /// Enumeration for Device SubClass /// + /// 4 public enum DeviceSubclass { /// @@ -122,6 +124,7 @@ namespace Tizen.Uix.InputMethod /// /// this class gives the device information, like the name, class and subclass /// + /// 4 public class InputMethodDeviceInformation { private IntPtr _handle; @@ -133,6 +136,7 @@ namespace Tizen.Uix.InputMethod /// /// Gets the device name of the key event. /// + /// 4 public string Name { get @@ -151,6 +155,7 @@ namespace Tizen.Uix.InputMethod /// /// Gets the device class of the key event. /// + /// 4 public DeviceClass DeviceClass { get @@ -169,6 +174,7 @@ namespace Tizen.Uix.InputMethod /// /// Gets the device subclass of the key event. /// + /// 4 public DeviceSubclass DeviceSubclass { get diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodEditor.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodEditor.cs index 3aef83b..bcd453b 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodEditor.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/InputMethodEditor.cs @@ -27,6 +27,7 @@ namespace Tizen.Uix.InputMethod /// If keycode & 0xff000000 == 0x01000000 then this key code is directly encoded 24-bit UCS character.The UCS value is keycode & 0x00ffffff. /// Defines the list of keys supported by the system.Note that certain keys may not be available on all devices. /// + /// 4 public enum KeyCode { /// @@ -907,6 +908,7 @@ namespace Tizen.Uix.InputMethod /// Enumeration of the key masks. /// The key masks indicate which modifier keys is pressed down during the keyboard hit.The special MASK_RELEASED indicates the key release event. /// + /// 4 public enum KeyMask { /// @@ -954,6 +956,7 @@ namespace Tizen.Uix.InputMethod /// /// This class contains api's related to IME(Input method editor) /// + /// 4 public static class InputMethodEditor { private static Object thisLock = new Object(); @@ -1021,6 +1024,7 @@ namespace Tizen.Uix.InputMethod /// /// Structure representing ContextId /// + /// 4 public struct ContextId : IEquatable { internal ContextId(int id) @@ -1037,6 +1041,7 @@ namespace Tizen.Uix.InputMethod /// /// compare whether ContextId are equal /// + /// 4 public bool Equals(ContextId other) { return this.Id == other.Id; @@ -1046,26 +1051,31 @@ namespace Tizen.Uix.InputMethod /// /// rectangle representing the position and size of UI Control /// + /// 4 public struct Rect { /// /// The x position in screen /// + /// 4 public int x; /// /// The y position in screen /// + /// 4 public int y; /// /// The window width /// + /// 4 public int w; /// /// The window height /// + /// 4 public int h; } @@ -1074,6 +1084,7 @@ namespace Tizen.Uix.InputMethod /// /// Generic Type /// The out parameter + /// 4 public delegate void OutAction(out T a); /// @@ -1081,6 +1092,7 @@ namespace Tizen.Uix.InputMethod /// /// Generic Type /// The out parameter 1 + /// 4 public delegate void OutArrayAction(out T[] a); /// @@ -1093,11 +1105,13 @@ namespace Tizen.Uix.InputMethod /// The Input Parameter 2 /// The Input Parameter 3 /// + /// 4 public delegate bool BoolAction(T a, T1 b, T2 c); /// /// Called when an associated text input UI control has focus. /// + /// 4 public static event EventHandler FocusedIn { add @@ -1132,6 +1146,7 @@ namespace Tizen.Uix.InputMethod /// /// Called when an associated text input UI control loses focus. /// + /// 4 public static event EventHandler FocusedOut { add @@ -1166,6 +1181,7 @@ namespace Tizen.Uix.InputMethod /// /// Called when an associated text input UI control responds to a request with the surrounding text. /// + /// 4 public static event EventHandler SurroundingTextUpdated { add @@ -1200,6 +1216,7 @@ namespace Tizen.Uix.InputMethod /// /// Called to reset the input context of an associated text input UI control. /// + /// 4 public static event EventHandler InputContextReset { add @@ -1233,6 +1250,7 @@ namespace Tizen.Uix.InputMethod /// /// Called when the position of the cursor in an associated text input UI control changes. /// + /// 4 public static event EventHandler CursorPositionUpdated { add @@ -1268,6 +1286,7 @@ namespace Tizen.Uix.InputMethod /// Called to set the preferred language to the input panel. /// It will be only called when the client application changes the edit field's language attribute after the input panel is shown. /// + /// 4 public static event EventHandler LanguageSet { add @@ -1302,6 +1321,7 @@ namespace Tizen.Uix.InputMethod /// /// Called to set the application specific data to deliver to the input panel. /// + /// 4 public static event EventHandler DataSet { add @@ -1339,6 +1359,7 @@ namespace Tizen.Uix.InputMethod /// Called when an associated text input UI control requests the input panel to set its layout. /// It will be only called when the client application changes the edit field's layout attribute after the input panel is shown. /// + /// 4 public static event EventHandler LayoutSet { add @@ -1374,6 +1395,7 @@ namespace Tizen.Uix.InputMethod /// Called when an associated text input UI control requests the input panel to set the Return key label. /// The input panel can show text or image on the Return button according to the Return key action. /// + /// 4 public static event EventHandler ReturnKeySet { add @@ -1408,6 +1430,7 @@ namespace Tizen.Uix.InputMethod /// /// Called when an associated text input UI control requests the input panel to enable or disable the Return key state. /// + /// 4 public static event EventHandler ReturnKeyStateSet { add @@ -1442,6 +1465,7 @@ namespace Tizen.Uix.InputMethod /// /// Called when the system display Language is changed. /// + /// 4 public static event EventHandler DisplayLanguageChanged { add @@ -1476,6 +1500,7 @@ namespace Tizen.Uix.InputMethod /// /// Called when the device is rotated. /// + /// 4 public static event EventHandler RotationChanged { add @@ -1510,6 +1535,7 @@ namespace Tizen.Uix.InputMethod /// /// Called when Accessibility in Settings application is on or off. /// + /// 4 public static event EventHandler AccessibilityStateChanged { add @@ -1547,6 +1573,7 @@ namespace Tizen.Uix.InputMethod /// /// Called when an associated text input UI control requests the language from the input panel, requesting for language code. /// + /// 4 public static void SetLanguageRequestedCallback(OutAction languageRequested) { _imeLanguageRequestedDelegate = (IntPtr userData, out IntPtr langCode) => @@ -1573,6 +1600,7 @@ namespace Tizen.Uix.InputMethod /// The Action is alled when the key event is received from the external devices or SendKey function. /// This Event processes the key event before an associated text input UI control does. /// + /// 4 public static void SetProcessKeyCallback(BoolAction processKey) { _imeProcessKeyDelegate = (KeyCode keyCode, KeyMask keyMask, IntPtr devInfo, IntPtr userData) => @@ -1593,6 +1621,7 @@ namespace Tizen.Uix.InputMethod /// /// Called when an associated text input UI control requests the application specific data from the input panel, requesting for data array and it's length. /// + /// 4 public static void SetDataRequestedCallback(OutArrayAction imDataRequested) { _imeImDataRequestedDelegate = (IntPtr userData, out IntPtr data, out uint dataLength) => @@ -1617,6 +1646,7 @@ namespace Tizen.Uix.InputMethod /// /// Called when an associated text input UI control requests the position and size from the input panel, requesting for x,y,w,h values. /// + /// 4 public static void SetGeometryRequestedCallback(OutAction geometryRequested) { _imeGeometryRequestedDelegate = (IntPtr userData, out int x, out int y, out int w, out int h) => @@ -1661,6 +1691,7 @@ namespace Tizen.Uix.InputMethod /// 1) The application does not have the privilege to call this function /// 2) Operation failed /// + /// 4 public static void Run(Action create, Action terminate, Action show, Action hide) { _userCreate = create; @@ -1699,6 +1730,7 @@ namespace Tizen.Uix.InputMethod /// 1) The application does not have the privilege to call this function /// 2) IME main loop isn't started yet /// + /// 4 public static void SendKeyEvent(KeyCode keyCode, KeyMask keyMask, bool forwardKey = false) { ErrorCode error = ImeSendKeyEvent(keyCode, keyMask, forwardKey); @@ -1721,6 +1753,7 @@ namespace Tizen.Uix.InputMethod /// 1) The application does not have the privilege to call this function /// 2) IME main loop isn't started yet /// + /// 4 public static void CommitString(string str) { ErrorCode error = ImeCommitString(str); @@ -1742,6 +1775,7 @@ namespace Tizen.Uix.InputMethod /// 1) The application does not have the privilege to call this function /// 2) IME main loop isn't started yet /// + /// 4 public static void ShowPreEditString() { ErrorCode error = ImeShowPreeditString(); @@ -1763,6 +1797,7 @@ namespace Tizen.Uix.InputMethod /// 1) The application does not have the privilege to call this function /// 2) IME main loop isn't started yet /// + /// 4 public static void HidePreEditString() { ErrorCode error = ImeHidePreeditString(); @@ -1790,6 +1825,7 @@ namespace Tizen.Uix.InputMethod /// 2) IME main loop isn't started yet /// 3) Invalid Parameter /// + /// 4 public static void UpdatePreEditString(string str, IEnumerable attrs) { IntPtr einaList = IntPtr.Zero; @@ -1833,6 +1869,7 @@ namespace Tizen.Uix.InputMethod /// /// The requested surrounding text can be received using the SurroundingTextUpdated Event, only if it is set. /// + /// 4 public static void RequestSurroundingText(int maxLenBefore, int maxLenAfter) { ErrorCode error = ImeRequestSurroundingText(maxLenBefore, maxLenAfter); @@ -1857,6 +1894,7 @@ namespace Tizen.Uix.InputMethod /// 2) IME main loop isn't started yet /// 3) Invalid Parameter /// + /// 4 public static void DeleteSurroundingText(int offset, int len) { ErrorCode error = ImeDeleteSurroundingText(offset, len); @@ -1884,6 +1922,7 @@ namespace Tizen.Uix.InputMethod /// 3) Invalid Parameter /// 4) Failed to obtain text due to out of memory /// + /// 4 public static void GetSurroundingText(int maxLenBefore, int maxLenAfter, out string text, out int cursorPosition) { IntPtr txt; @@ -1910,6 +1949,7 @@ namespace Tizen.Uix.InputMethod /// 2) IME main loop isn't started yet /// 3) Invalid Parameter /// + /// 4 public static void SetSelection(int start, int end) { ErrorCode error = ImeSetSelection(start, end); @@ -1933,6 +1973,7 @@ namespace Tizen.Uix.InputMethod /// 2) IME main loop isn't started yet /// 3) Operation Failed /// + /// 4 public static EditorWindow GetMainWindow() { EditorWindow._handle = ImeGetMainWindow(); @@ -1957,6 +1998,7 @@ namespace Tizen.Uix.InputMethod /// 1) The application does not have the privilege to call this function /// 2) Operation Failed /// + /// 4 public static void Create() { ErrorCode error = ImeInitialize(); @@ -1987,6 +2029,7 @@ namespace Tizen.Uix.InputMethod /// 1) The application does not have the privilege to call this function /// 2) Operation Failed /// + /// 4 public static void Destroy() { ErrorCode error = ImeFinalize(); diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/LanguageSetSetEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/LanguageSetSetEventArgs.cs index 9cbf06b..aa78887 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/LanguageSetSetEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/LanguageSetSetEventArgs.cs @@ -19,6 +19,7 @@ namespace Tizen.Uix.InputMethod /// /// This Class contains data related to LanguageSet Event /// + /// 4 public class LanguageSetEventArgs { internal LanguageSetEventArgs(InputPanelLanguage language) @@ -29,6 +30,7 @@ namespace Tizen.Uix.InputMethod /// /// The preferred language that the client application wants /// + /// 4 public InputPanelLanguage Language { get; diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/LayoutSetEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/LayoutSetEventArgs.cs index 8257701..0d7ebeb 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/LayoutSetEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/LayoutSetEventArgs.cs @@ -19,6 +19,7 @@ namespace Tizen.Uix.InputMethod /// /// This Class contains data related to LayoutSet Event /// + /// 4 public class LayoutSetEventArgs { internal LayoutSetEventArgs(InputPanelLayout layout) @@ -29,6 +30,7 @@ namespace Tizen.Uix.InputMethod /// /// The input panel layout /// + /// 4 public InputPanelLayout Layout { get; diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/PreEditAttribute.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/PreEditAttribute.cs index e10dbf3..c2d026f 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/PreEditAttribute.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/PreEditAttribute.cs @@ -23,6 +23,7 @@ namespace Tizen.Uix.InputMethod /// /// Enumeration for Attribute Type /// + /// 4 public enum AttributeType { /// @@ -37,11 +38,13 @@ namespace Tizen.Uix.InputMethod /// /// This class represents the attributes for preedit string. /// + /// 4 public class PreEditAttribute { /// /// The start position in the string of this attribute /// + /// 4 public uint Start { get; @@ -51,6 +54,7 @@ namespace Tizen.Uix.InputMethod /// /// The character length of this attribute, the range is [Start, Start+Length] /// + /// 4 public uint Length { get; @@ -60,6 +64,7 @@ namespace Tizen.Uix.InputMethod /// /// The type of this attribute /// + /// 4 public AttributeType Type { get; @@ -69,6 +74,7 @@ namespace Tizen.Uix.InputMethod /// /// The value of this attribute /// + /// 4 public uint Value { get; diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/ReturnKeyStateSetEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/ReturnKeyStateSetEventArgs.cs index 57894aa..2424f76 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/ReturnKeyStateSetEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/ReturnKeyStateSetEventArgs.cs @@ -19,6 +19,7 @@ namespace Tizen.Uix.InputMethod /// /// This Class contains data related to ReturnKeyStateSet Event /// + /// 4 public class ReturnKeyStateSetEventArgs { internal ReturnKeyStateSetEventArgs(bool state) @@ -29,6 +30,7 @@ namespace Tizen.Uix.InputMethod /// /// The bool state to disable Return key. The Return key is enabled by default /// + /// 4 public bool State { get; diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/ReturnKeyTypeSetEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/ReturnKeyTypeSetEventArgs.cs index 339f4a0..7060d26 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/ReturnKeyTypeSetEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/ReturnKeyTypeSetEventArgs.cs @@ -19,6 +19,7 @@ namespace Tizen.Uix.InputMethod /// /// This Class contains data related to ReturnKeySet Event /// + /// 4 public class ReturnKeySetEventArgs { internal ReturnKeySetEventArgs(InputPanelReturnKey type) @@ -29,6 +30,7 @@ namespace Tizen.Uix.InputMethod /// /// The type of Return key on the input panel /// + /// 4 public InputPanelReturnKey Type { get; diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/RotationChangedEventArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/RotationChangedEventArgs.cs index de4b207..6b316f3 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/RotationChangedEventArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/RotationChangedEventArgs.cs @@ -19,6 +19,7 @@ namespace Tizen.Uix.InputMethod /// /// This Class contains data related to RotationChanged Event /// + /// 4 public class RotationChangedEventArgs { internal RotationChangedEventArgs(int degree) @@ -29,6 +30,7 @@ namespace Tizen.Uix.InputMethod /// /// The rotation degree /// + /// 4 public int Degree { get; diff --git a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/SurroundingTextUpdatedArgs.cs b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/SurroundingTextUpdatedArgs.cs index 90b533b..6999069 100755 --- a/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/SurroundingTextUpdatedArgs.cs +++ b/src/Tizen.Uix.InputMethod/Tizen.Uix.InputMethod/SurroundingTextUpdatedArgs.cs @@ -19,6 +19,7 @@ namespace Tizen.Uix.InputMethod /// /// This Class contains data related to SurroundingTextUpdated Event /// + /// 4 public class SurroundingTextUpdatedEventArgs { internal SurroundingTextUpdatedEventArgs(int contextId, string text, int cursorPos) @@ -31,6 +32,7 @@ namespace Tizen.Uix.InputMethod /// /// The input context identification value of an associated text input UI control /// + /// 4 public int ContextId { get; @@ -40,6 +42,7 @@ namespace Tizen.Uix.InputMethod /// /// The cursor position /// + /// 4 public int CursorPosition { get; @@ -49,6 +52,7 @@ namespace Tizen.Uix.InputMethod /// /// The string requested /// + /// 4 public string Text { get; diff --git a/src/Tizen.Uix.InputMethodManager/Tizen.Uix.InputMethodManager/InputMethodManager.cs b/src/Tizen.Uix.InputMethodManager/Tizen.Uix.InputMethodManager/InputMethodManager.cs index 28489d4..82a0d46 100755 --- a/src/Tizen.Uix.InputMethodManager/Tizen.Uix.InputMethodManager/InputMethodManager.cs +++ b/src/Tizen.Uix.InputMethodManager/Tizen.Uix.InputMethodManager/InputMethodManager.cs @@ -25,6 +25,7 @@ namespace Tizen.Uix.InputMethodManager /// The manager is a module for managing the installed IMEs. /// IME developers can use this module to open the installed IME list or the selector menu after their IME installation, and then guide to select the installed IME. /// + /// 3 public static class Manager { /// @@ -39,6 +40,7 @@ namespace Tizen.Uix.InputMethodManager /// 1) The application does not have the privilege to call this function. /// 2) Operation failed. /// + /// 3 public static void ShowIMEList() { ErrorCode error = ImeManagerShowImeList(); @@ -61,6 +63,7 @@ namespace Tizen.Uix.InputMethodManager /// 1) The application does not have the privilege to call this function. /// 2) Operation failed. /// + /// 3 public static void ShowIMESelector() { ErrorCode error = ImeManagerShowImeSelector(); @@ -88,6 +91,7 @@ namespace Tizen.Uix.InputMethodManager /// 1) The application does not have the privilege to call this function. /// 2) Operation failed. /// + /// 3 public static bool IsIMEEnabled(string appId) { bool isIMEEnabled; @@ -115,6 +119,7 @@ namespace Tizen.Uix.InputMethodManager /// 1) The application does not have the privilege to call this function. /// 2) Operation failed. /// + /// 3 public static string GetActiveIME() { string activeIME; @@ -142,6 +147,7 @@ namespace Tizen.Uix.InputMethodManager /// 1) The application does not have the privilege to call this function. /// 2) Operation failed. /// + /// 3 public static int GetEnabledIMECount() { int activeIME = ImeManagerGetEnabledImeCount(); diff --git a/src/Tizen.Uix.Stt/Tizen.Uix.Stt/ErrorOccurredEventArgs.cs b/src/Tizen.Uix.Stt/Tizen.Uix.Stt/ErrorOccurredEventArgs.cs index 64c1e31..514400c 100755 --- a/src/Tizen.Uix.Stt/Tizen.Uix.Stt/ErrorOccurredEventArgs.cs +++ b/src/Tizen.Uix.Stt/Tizen.Uix.Stt/ErrorOccurredEventArgs.cs @@ -23,7 +23,7 @@ namespace Tizen.Uix.Stt /// /// This class holds information related to the STT ErrorOccurred event. /// - /// 3 + /// 4 public class ErrorOccurredEventArgs { private IntPtr _handle; @@ -159,7 +159,7 @@ namespace Tizen.Uix.Stt /// /// The error value. /// - /// 3 + /// 4 public Error ErrorValue { get; @@ -169,7 +169,7 @@ namespace Tizen.Uix.Stt /// /// Gets the current error message. /// - /// 3 + /// 4 /// /// String error message. /// diff --git a/src/Tizen.Uix.Stt/Tizen.Uix.Stt/SttClient.cs b/src/Tizen.Uix.Stt/Tizen.Uix.Stt/SttClient.cs index 5f33ed1..17cb9ec 100755 --- a/src/Tizen.Uix.Stt/Tizen.Uix.Stt/SttClient.cs +++ b/src/Tizen.Uix.Stt/Tizen.Uix.Stt/SttClient.cs @@ -461,7 +461,7 @@ namespace Tizen.Uix.Stt /// /// Event to be invoked when an error occurs. /// - /// 3 + /// 4 public event EventHandler ErrorOccurred { add @@ -1016,7 +1016,7 @@ namespace Tizen.Uix.Stt /// The language is specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code. /// For example, "ko_KR" for Korean, "en_US" for American English. /// - /// 3 + /// 4 /// /// http://tizen.org/privilege/recorder /// diff --git a/src/Tizen.Uix.SttEngine/Tizen.Uix.SttEngine/SttEngine.cs b/src/Tizen.Uix.SttEngine/Tizen.Uix.SttEngine/SttEngine.cs index 5a95ea1..7b4a684 100755 --- a/src/Tizen.Uix.SttEngine/Tizen.Uix.SttEngine/SttEngine.cs +++ b/src/Tizen.Uix.SttEngine/Tizen.Uix.SttEngine/SttEngine.cs @@ -23,6 +23,7 @@ namespace Tizen.Uix.SttEngine /// /// Enumeration for audio type. /// + /// 4 public enum AudioType { /// @@ -38,6 +39,7 @@ namespace Tizen.Uix.SttEngine /// /// Enumeration for result. /// + /// 4 public enum ResultEvent { /// @@ -57,6 +59,7 @@ namespace Tizen.Uix.SttEngine /// /// Enumeration for result time. /// + /// 4 public enum TimeEvent { /// @@ -76,6 +79,7 @@ namespace Tizen.Uix.SttEngine /// /// Enumeration for speech status. /// + /// 4 public enum SpeechStatus { /// @@ -91,6 +95,7 @@ namespace Tizen.Uix.SttEngine /// /// Enumeration representing the result message /// + /// 4 public enum ResultMessage { /// @@ -127,6 +132,7 @@ namespace Tizen.Uix.SttEngine /// /// Enum for Error values that can occur /// + /// 4 public enum Error { /// @@ -182,6 +188,7 @@ namespace Tizen.Uix.SttEngine /// /// This Class represents the Stt Engine which has to be inherited to make the engine. /// + /// 4 public abstract class Engine { private CallbackStructGCHandle _callbackStructGCHandle = new CallbackStructGCHandle(); @@ -199,6 +206,7 @@ namespace Tizen.Uix.SttEngine /// The Input Parameter 1 /// The Input Parameter 2 /// Error Value + /// 4 public delegate Error Action(T a, T b); /// @@ -208,6 +216,7 @@ namespace Tizen.Uix.SttEngine /// The Input Parameter 1 /// The Input Parameter 2 /// Error Value + /// 4 public delegate Error OutAction(T a, out T b); /// @@ -222,6 +231,7 @@ namespace Tizen.Uix.SttEngine /// The User data /// true to continue with the next iteration of the loop, false to break out of the loop /// SendResult() should be called. + /// 4 public delegate bool ResultTime(int index, TimeEvent resultEvent, string text, long startTime, long endTime, IntPtr userData); /// @@ -234,6 +244,7 @@ namespace Tizen.Uix.SttEngine /// The User data /// true to continue with the next iteration of the loop, false to break out of the loop /// ForEachSupportedLanguages() should be called + /// 4 public delegate bool SupportedLanguages(string language, IntPtr userData); /// @@ -252,6 +263,7 @@ namespace Tizen.Uix.SttEngine /// 2. OperationFailed /// 3. InvalidParameter /// + /// 4 public abstract Error GetInformation(out string engineUuid, out string engineName, out string engineSetting, out bool useNetwork); /// @@ -265,6 +277,7 @@ namespace Tizen.Uix.SttEngine /// 3. InvalidState /// 4. OperationFailed /// + /// 4 public abstract Error Initialize(); /// @@ -276,6 +289,7 @@ namespace Tizen.Uix.SttEngine /// 1. None /// 2. InvalidState /// + /// 4 public abstract Error Deinitialize(); /// @@ -296,6 +310,7 @@ namespace Tizen.Uix.SttEngine /// /// This callback function invokes SupportedLanguages repeatedly for getting supported languages. /// + /// 4 public abstract Error ForEachSupportedLanguages(SupportedLanguages callback, IntPtr userData); /// @@ -309,12 +324,14 @@ namespace Tizen.Uix.SttEngine /// 1. None /// 2. InvalidParameter /// + /// 4 public abstract Error IsValidLanguage(string language, out bool isValid); /// /// Called when the engine service user checks whether Stt engine supports silence detection. /// /// true to support silence detection, false not to support silence detection + /// 4 public abstract bool SupportSilenceDetection(); /// @@ -328,6 +345,7 @@ namespace Tizen.Uix.SttEngine /// 1. None /// 2. InvalidParameter /// + /// 4 public abstract Error SupportRecognitionType(string type, out bool isSupported); /// @@ -342,6 +360,7 @@ namespace Tizen.Uix.SttEngine /// 1. None /// 2. InvalidState /// + /// 4 public abstract Error GetRecordingFormat(out AudioType types, out int rate, out int channels); /// @@ -355,6 +374,7 @@ namespace Tizen.Uix.SttEngine /// 2. InvalidState /// 3. NotSupportedFeature /// + /// 4 public abstract Error SetSilenceDetection(bool isSet); /// @@ -370,12 +390,14 @@ namespace Tizen.Uix.SttEngine /// 2. InvalidState /// 3. NotSupportedFeature /// + /// 4 public abstract Error CheckAppAgreed(string appid, out bool isAgreed); /// /// Called when the engine service user checks whether Stt engine needs the application's credential. /// /// true if Stt engine needs the application's credential, otherwise false + /// 4 public abstract bool NeedAppCredential(); /// @@ -401,6 +423,7 @@ namespace Tizen.Uix.SttEngine /// /// This function invokes ResultTime repeatedly for getting result time information. /// + /// 4 public abstract Error ForEachResultTime(IntPtr timeInfo, ResultTime callback, IntPtr userData); /// @@ -426,6 +449,7 @@ namespace Tizen.Uix.SttEngine /// /// The engine is not in recognition processing. /// + /// 4 public abstract Error Start(string language, string type, string appid, string credential, IntPtr userData); /// @@ -446,6 +470,7 @@ namespace Tizen.Uix.SttEngine /// Start should succeed /// /// If the engine supports partial result, SendResult() should be invoked. + /// 4 public abstract Error SetRecordingData(string data, uint length); /// @@ -462,6 +487,7 @@ namespace Tizen.Uix.SttEngine /// Start should succeed /// /// After processing of the engine, , SendResult() should be invoked. + /// 4 public abstract Error Stop(); /// @@ -474,6 +500,7 @@ namespace Tizen.Uix.SttEngine /// 2. InvalidState /// /// Stt engine is in recognition processing or recording. + /// 4 public abstract Error Cancel(); /// @@ -483,6 +510,7 @@ namespace Tizen.Uix.SttEngine /// http://tizen.org/feature/speech.recognition /// http://tizen.org/feature/microphone /// + /// 4 public Engine() { _engine = this; @@ -507,6 +535,7 @@ namespace Tizen.Uix.SttEngine /// Thrown in case of Permission denied /// Thrown in case of Not supported /// thrown in case of Operation failure + /// 4 public void EngineMain(int argc, string[] argv) { _callbackStructGCHandle.CallbackStruct.version = 1; @@ -566,6 +595,7 @@ namespace Tizen.Uix.SttEngine /// /// This function invokes ForEachResultTime /// + /// 4 public void SendResult(ResultEvent resultEvent, string type, string[] result, int resultCount, ResultMessage msg, IntPtr timeInfo) { if ((result != null) && (result.Length != 0)) @@ -632,6 +662,7 @@ namespace Tizen.Uix.SttEngine /// /// Main function should be invoked before this function is called. /// + /// 4 public void SendError(Error error, string msg) { Error err = STTESendError(error, msg); @@ -659,6 +690,7 @@ namespace Tizen.Uix.SttEngine /// /// Main function should be invoked before this function is called. Start() and SetRecordingData() will invoke this function. /// + /// 4 public void SendSpeechStatus(SpeechStatus status) { Error error = STTESendSpeechStatus(status, IntPtr.Zero); @@ -698,6 +730,7 @@ namespace Tizen.Uix.SttEngine /// /// Main function should be invoked before this function is called. /// + /// 4 public void SetPrivateDataSetDelegate(Action callback) { if (null == callback) @@ -748,6 +781,7 @@ namespace Tizen.Uix.SttEngine /// /// Main function should be invoked before this function is called. /// + /// 4 public void SetPrivateDataRequestedDelegate(OutAction callback) { if (null == callback) diff --git a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/ErrorOccurredEventArgs.cs b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/ErrorOccurredEventArgs.cs index 0a184db..007995b 100755 --- a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/ErrorOccurredEventArgs.cs +++ b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/ErrorOccurredEventArgs.cs @@ -23,7 +23,7 @@ namespace Tizen.Uix.Tts /// /// This class holds information related to the TTS ErrorOccurred event. /// - /// 3 + /// 4 public class ErrorOccurredEventArgs { private IntPtr _handle; @@ -117,7 +117,7 @@ namespace Tizen.Uix.Tts /// /// The utterance ID. /// - /// 3 + /// 4 public int UtteranceId { get; @@ -127,7 +127,7 @@ namespace Tizen.Uix.Tts /// /// The error value. /// - /// 3 + /// 4 public Error ErrorValue { get; @@ -137,7 +137,7 @@ namespace Tizen.Uix.Tts /// /// Gets the current error message. /// - /// 3 + /// 4 /// /// String error message. /// diff --git a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/TtsClient.cs b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/TtsClient.cs index 1d95595..772a0ef 100755 --- a/src/Tizen.Uix.Tts/Tizen.Uix.Tts/TtsClient.cs +++ b/src/Tizen.Uix.Tts/Tizen.Uix.Tts/TtsClient.cs @@ -370,7 +370,7 @@ namespace Tizen.Uix.Tts /// /// Event to be invoked when an error occurs. /// - /// 3 + /// 4 public event EventHandler ErrorOccurred { add diff --git a/src/Tizen.Uix.TtsEngine/Tizen.Uix.TtsEngine/TtsEngine.cs b/src/Tizen.Uix.TtsEngine/Tizen.Uix.TtsEngine/TtsEngine.cs index a93fcc7..87add04 100755 --- a/src/Tizen.Uix.TtsEngine/Tizen.Uix.TtsEngine/TtsEngine.cs +++ b/src/Tizen.Uix.TtsEngine/Tizen.Uix.TtsEngine/TtsEngine.cs @@ -23,6 +23,7 @@ namespace Tizen.Uix.TtsEngine /// /// Enumeration for audio type. /// + /// 4 public enum AudioType { /// @@ -42,6 +43,7 @@ namespace Tizen.Uix.TtsEngine /// /// Enumeration for result. /// + /// 4 public enum ResultEvent { /// @@ -65,6 +67,7 @@ namespace Tizen.Uix.TtsEngine /// /// Enumeration for Voice Type /// + /// 4 public enum VoiceType { /// @@ -84,6 +87,7 @@ namespace Tizen.Uix.TtsEngine /// /// Enum for Error values that can occur /// + /// 4 public enum Error { /// @@ -135,6 +139,7 @@ namespace Tizen.Uix.TtsEngine /// /// This Class represents the Tts Engine which has to be inherited to make the engine. /// + /// 4 public abstract class Engine { private CallbackStructGCHandle _callbackStructGCHandle = new CallbackStructGCHandle(); @@ -152,6 +157,7 @@ namespace Tizen.Uix.TtsEngine /// The Input Parameter 1 /// The Input Parameter 2 /// Error Value + /// 4 public delegate Error Action(T a, T b); /// @@ -161,6 +167,7 @@ namespace Tizen.Uix.TtsEngine /// The Input Parameter 1 /// The Input Parameter 2 /// Error Value + /// 4 public delegate Error OutAction(T a, out T b); /// @@ -176,6 +183,7 @@ namespace Tizen.Uix.TtsEngine /// The user data passed from ForEachSupportedVoices() /// true to continue with the next iteration of the loop false to break out of the loop /// ForEachSupportedVoices() will invoke this callback function. + /// 4 public delegate bool SupportedVoice(string language, VoiceType type, IntPtr userData); /// @@ -204,6 +212,7 @@ namespace Tizen.Uix.TtsEngine /// 7. PermissionDenied /// /// This function invokes SendResult() + /// 4 public abstract Error StartSynthesis(string language, int type, string text, int speed, string appid, string credential, IntPtr userData); /// @@ -223,6 +232,7 @@ namespace Tizen.Uix.TtsEngine /// 1. None /// 2. InvalidState /// + /// 4 public abstract Error GetInformation(out string engineUuid, out string engineName, out string engineSetting, out bool useNetwork); /// @@ -235,6 +245,7 @@ namespace Tizen.Uix.TtsEngine /// 3. NotSupportedFeature /// 4. PermissionDenied /// + /// 4 public abstract Error Initialize(); /// @@ -248,6 +259,7 @@ namespace Tizen.Uix.TtsEngine /// 1. None /// 2. InvalidState /// + /// 4 public abstract Error Deinitialize(); /// @@ -264,6 +276,7 @@ namespace Tizen.Uix.TtsEngine /// 2. OperationFailed /// /// This callback function invokes SupportedVoice() repeatedly for getting all supported voices. + /// 4 public abstract Error ForEachSupportedVoices(SupportedVoice callback, IntPtr userData); /// @@ -278,6 +291,7 @@ namespace Tizen.Uix.TtsEngine /// 1. None /// 2. InvalidParameter /// + /// 4 public abstract Error IsValidVoice(string language, int type, out bool isValid); /// @@ -291,6 +305,7 @@ namespace Tizen.Uix.TtsEngine /// 3. OperationFailed /// 4. InvalidParameter /// + /// 4 public abstract Error SetPitch(int pitch); /// @@ -308,6 +323,7 @@ namespace Tizen.Uix.TtsEngine /// 5. InvalidParameter /// 6. OutOfMemory /// + /// 4 public abstract Error LoadVoice(string language, int type); /// @@ -324,6 +340,7 @@ namespace Tizen.Uix.TtsEngine /// 4. InvalidVoice /// 5. InvalidParameter /// + /// 4 public abstract Error UnloadVoice(string language, int type); /// @@ -346,12 +363,14 @@ namespace Tizen.Uix.TtsEngine /// 3. NotSupportedFeature /// 4. InvalidParameter /// + /// 4 public abstract Error CheckAppAgreed(string appid, out bool isAgreed); /// /// Called when the engine service user checks whether TTS engine needs the application's credential. /// /// true if TTS engine needs the application's credential, otherwise false + /// 4 public abstract bool NeedAppCredential(); /// @@ -365,6 +384,7 @@ namespace Tizen.Uix.TtsEngine /// /// StartSynthesis should be performed /// + /// 4 public abstract Error CancelSynthesis(); /// @@ -373,6 +393,7 @@ namespace Tizen.Uix.TtsEngine /// /// http://tizen.org/feature/speech.synthesis /// + /// 4 public Engine() { _engine = this; @@ -392,6 +413,7 @@ namespace Tizen.Uix.TtsEngine /// The argument(original) /// Thrown in case of Not supported /// thrown in case of Operation failure + /// 4 public void EngineMain(int argc, string[] argv) { _callbackStructGCHandle.CallbackStruct.version = 1; @@ -433,6 +455,7 @@ namespace Tizen.Uix.TtsEngine /// The maximum speed value /// Thrown in case of Not supported /// thrown in case of Operation failure + /// 4 public void GetSpeedRange(out int min, out int normal, out int max) { Error error = TTSEGetSpeedRange(out min, out normal, out max); @@ -458,6 +481,7 @@ namespace Tizen.Uix.TtsEngine /// The maximum pitch value /// Thrown in case of Not supported /// thrown in case of Operation failure + /// 4 public void GetPitchRange(out int min, out int normal, out int max) { Error error = TTSEGetPitchRange(out min, out normal, out max); @@ -490,6 +514,7 @@ namespace Tizen.Uix.TtsEngine /// /// EngineMain function should be invoked before this function is called. StartSynthesis() will invoke this function. /// + /// 4 public void SendResult(ResultEvent resultEvent, IntPtr data, int dataSize, AudioType audioType, int rate) { Error error = TTSESendResult(resultEvent, data, dataSize, audioType, rate, IntPtr.Zero); @@ -513,6 +538,7 @@ namespace Tizen.Uix.TtsEngine /// /// EngineMain function should be invoked before this function is called. /// + /// 4 public void SendError(Error error, string msg) { Error err = TTSESendError(error, msg); @@ -547,6 +573,7 @@ namespace Tizen.Uix.TtsEngine /// /// Main function should be invoked before this function is called. /// + /// 4 public void SetPrivateDataSetDelegate(Action callback) { if (null == callback) @@ -593,6 +620,7 @@ namespace Tizen.Uix.TtsEngine /// /// Main function should be invoked before this function is called. /// + /// 4 public void SetPrivateDataRequestedDelegate(OutAction callback) { if (null == callback) diff --git a/src/Tizen.WebView/Tizen.WebView/Chromium.cs b/src/Tizen.WebView/Tizen.WebView/Chromium.cs index ca220ed..c6e6288 100644 --- a/src/Tizen.WebView/Tizen.WebView/Chromium.cs +++ b/src/Tizen.WebView/Tizen.WebView/Chromium.cs @@ -19,12 +19,14 @@ namespace Tizen.WebView /// /// This class provides methods to initialize and shutdown Chromium-efl. /// + /// 4 public static class Chromium { /// /// Initializes Chromium's instance. /// /// A reference count of Chromium's instance + /// 4 public static int Initialize() { return Interop.ChromiumEwk.ewk_init(); @@ -34,6 +36,7 @@ namespace Tizen.WebView /// Decreases a reference count of WebKit's instance, possibly destroying it. /// /// A reference count of Chromium's instance + /// 4 public static int Shutdown() { return Interop.ChromiumEwk.ewk_shutdown(); diff --git a/src/Tizen.WebView/Tizen.WebView/Context.cs b/src/Tizen.WebView/Tizen.WebView/Context.cs index 097da62..81cec38 100644 --- a/src/Tizen.WebView/Tizen.WebView/Context.cs +++ b/src/Tizen.WebView/Tizen.WebView/Context.cs @@ -21,6 +21,7 @@ namespace Tizen.WebView /// /// Enumeration that contains option for cache model. /// + /// 4 public enum CacheModel { /// @@ -44,6 +45,7 @@ namespace Tizen.WebView /// Applications have the option of creating a context different from the default one and using it for a group of pages. /// All pages in the same context share the same preferences, visited link set, local storage, and so on. /// + /// 4 public class Context { private IntPtr _handle; @@ -60,6 +62,7 @@ namespace Tizen.WebView /// /// The default cache model is DocumentViewer. /// + /// 4 public CacheModel CacheModel { get @@ -77,6 +80,7 @@ namespace Tizen.WebView /// Gets the CookieManager object for this context. /// /// The CookieManager object + /// 4 public CookieManager GetCookieManager() { if (_cookieManager == null) diff --git a/src/Tizen.WebView/Tizen.WebView/CookieManager.cs b/src/Tizen.WebView/Tizen.WebView/CookieManager.cs index f7ed538..2122f12 100644 --- a/src/Tizen.WebView/Tizen.WebView/CookieManager.cs +++ b/src/Tizen.WebView/Tizen.WebView/CookieManager.cs @@ -20,6 +20,7 @@ namespace Tizen.WebView /// /// Enumeration that contains accept policies for the cookies. /// + /// 4 public enum CookieAcceptPolicy { /// @@ -39,6 +40,7 @@ namespace Tizen.WebView /// /// Enumeration that creates a type name for the storage of persistent cookies. /// + /// 4 public enum CookiePersistentStorage { /// @@ -54,6 +56,7 @@ namespace Tizen.WebView /// /// This class provides methods for the cookie manager. /// + /// 4 public class CookieManager { private IntPtr _handle; @@ -70,6 +73,7 @@ namespace Tizen.WebView /// By default, only cookies set by the main document loaded are accepted. /// /// The cookie acceptance policy + /// 4 public void SetCookieAcceptPolicy(CookieAcceptPolicy policy) { Interop.ChromiumEwk.ewk_cookie_manager_accept_policy_set(_handle, (Interop.ChromiumEwk.CookieAcceptPolicy)policy); @@ -78,6 +82,7 @@ namespace Tizen.WebView /// /// Deletes all the cookies. /// + /// 4 public void ClearCookies() { Interop.ChromiumEwk.ewk_cookie_manager_cookies_clear(_handle); @@ -90,6 +95,7 @@ namespace Tizen.WebView /// http://tizen.org/privilege/externalstorage /// The path where to read/write Cookies /// The type of storage + /// 4 public void SetPersistentStorage(string path, CookiePersistentStorage storage) { Interop.ChromiumEwk.ewk_cookie_manager_persistent_storage_set(_handle, path, (Interop.ChromiumEwk.CookiePersistentStorage)storage); diff --git a/src/Tizen.WebView/Tizen.WebView/JavaScriptMessage.cs b/src/Tizen.WebView/Tizen.WebView/JavaScriptMessage.cs index 8165700..999ae23 100644 --- a/src/Tizen.WebView/Tizen.WebView/JavaScriptMessage.cs +++ b/src/Tizen.WebView/Tizen.WebView/JavaScriptMessage.cs @@ -24,11 +24,13 @@ namespace Tizen.WebView /// The callback function that is invoked when the message is received from the script. /// /// The JavaScriptMessage returned by the script + /// 4 public delegate void JavaScriptMessageHandler(JavaScriptMessage message); /// /// A Script message contains information that sent from JavaScript runtime. /// + /// 4 public class JavaScriptMessage { private string _name; @@ -43,6 +45,7 @@ namespace Tizen.WebView /// /// Obect name in JavaScript. /// + /// 4 public string Name { get @@ -55,6 +58,7 @@ namespace Tizen.WebView /// Gets the value of body as integer type. /// /// The value of body as integer type + /// 4 public int GetBodyAsInteger() { if (_body == IntPtr.Zero) @@ -68,6 +72,7 @@ namespace Tizen.WebView /// Gets the value of body as double type. /// /// The value of body as double type + /// 4 public double GetBodyAsDouble() { if (_body == IntPtr.Zero) @@ -83,6 +88,7 @@ namespace Tizen.WebView /// Gets the value of body as boolean type. /// /// The value of body as boolean type + /// 4 public bool GetBodyAsBoolean() { if (_body == IntPtr.Zero) @@ -96,6 +102,7 @@ namespace Tizen.WebView /// Gets the value of body as string type. /// /// The value of body as string type + /// 4 public string GetBodyAsString() { if (_body == IntPtr.Zero) diff --git a/src/Tizen.WebView/Tizen.WebView/Settings.cs b/src/Tizen.WebView/Tizen.WebView/Settings.cs index b9fcba3..5cd0a9d 100644 --- a/src/Tizen.WebView/Tizen.WebView/Settings.cs +++ b/src/Tizen.WebView/Tizen.WebView/Settings.cs @@ -21,6 +21,7 @@ namespace Tizen.WebView /// /// This class provides properties for setting the preference of a specific WebView. /// + /// 4 public class Settings { private IntPtr _handle; @@ -33,6 +34,7 @@ namespace Tizen.WebView /// /// Whether JavaScript can be executable. /// + /// 4 public bool JavaScriptEnabled { get @@ -49,6 +51,7 @@ namespace Tizen.WebView /// /// Whether images can be loaded automatically. /// + /// 4 public bool LoadImageAutomatically { get @@ -65,6 +68,7 @@ namespace Tizen.WebView /// /// The default text encoding name. /// + /// 4 public string DefaultTextEncodingName { get @@ -81,6 +85,7 @@ namespace Tizen.WebView /// /// The default font size of a pixel. /// + /// 4 public int DefaultFontSize { get diff --git a/src/Tizen.WebView/Tizen.WebView/SmartCallbackArgs.cs b/src/Tizen.WebView/Tizen.WebView/SmartCallbackArgs.cs index 9e0f01d..1bdc513 100644 --- a/src/Tizen.WebView/Tizen.WebView/SmartCallbackArgs.cs +++ b/src/Tizen.WebView/Tizen.WebView/SmartCallbackArgs.cs @@ -22,6 +22,7 @@ namespace Tizen.WebView /// /// Argument from the SmartCallback. /// + /// 4 public class SmartCallbackArgs : EventArgs { private IntPtr _arg; @@ -35,6 +36,7 @@ namespace Tizen.WebView /// Gets argument as integer type. /// /// Argument as integer type + /// 4 public int GetAsInteger() { if (_arg == IntPtr.Zero) @@ -48,6 +50,7 @@ namespace Tizen.WebView /// Gets argument as double type. /// /// Argument as double type + /// 4 public double GetAsDouble() { if (_arg == IntPtr.Zero) @@ -63,6 +66,7 @@ namespace Tizen.WebView /// Gets argument as boolean type. /// /// Argument as boolean type + /// 4 public bool GetAsBoolean() { if (_arg == IntPtr.Zero) @@ -76,6 +80,7 @@ namespace Tizen.WebView /// Gets argument as string type. /// /// Argument as string type + /// 4 public string GetAsString() { if (_arg == IntPtr.Zero) diff --git a/src/Tizen.WebView/Tizen.WebView/SmartCallbackLoadErrorArgs.cs b/src/Tizen.WebView/Tizen.WebView/SmartCallbackLoadErrorArgs.cs index 28323bb..8107192 100644 --- a/src/Tizen.WebView/Tizen.WebView/SmartCallbackLoadErrorArgs.cs +++ b/src/Tizen.WebView/Tizen.WebView/SmartCallbackLoadErrorArgs.cs @@ -22,6 +22,7 @@ namespace Tizen.WebView /// /// Enumeration that provides an option to error codes. /// + /// 4 public enum LoadErrorCode { /// @@ -89,6 +90,7 @@ namespace Tizen.WebView /// /// Argument from the LoadError SmartCallback. /// + /// 4 public class SmartCallbackLoadErrorArgs : EventArgs { IntPtr _handle; @@ -101,6 +103,7 @@ namespace Tizen.WebView /// /// Failing URL for the error. /// + /// 4 public string Url { get @@ -112,6 +115,7 @@ namespace Tizen.WebView /// /// The error code. /// + /// 4 public LoadErrorCode Code { get @@ -123,6 +127,7 @@ namespace Tizen.WebView /// /// The description for the error. /// + /// 4 public string Description { get @@ -134,6 +139,7 @@ namespace Tizen.WebView /// /// Whether the error should be treated as a cancellation. /// + /// 4 public bool Cancellation { get diff --git a/src/Tizen.WebView/Tizen.WebView/WebView.cs b/src/Tizen.WebView/Tizen.WebView/WebView.cs index 71d93f2..a7f218d 100644 --- a/src/Tizen.WebView/Tizen.WebView/WebView.cs +++ b/src/Tizen.WebView/Tizen.WebView/WebView.cs @@ -24,6 +24,7 @@ namespace Tizen.WebView /// /// A view used to render web contents. /// + /// 4 public class WebView: EvasObject { private static IDictionary _javaScriptMessageHandlerMap = new Dictionary(); @@ -49,31 +50,37 @@ namespace Tizen.WebView /// /// Event that occurs when load started. /// + /// 4 public event EventHandler LoadStarted; /// /// Event that occurs when load finished. /// + /// 4 public event EventHandler LoadFinished; /// /// Event that occurs when load error. /// + /// 4 public event EventHandler LoadError; /// /// Event that occurs when title of main frame was changed. /// + /// 4 public event EventHandler TitleChanged; /// /// Event that occurs when URL of main frame was changed. /// + /// 4 public event EventHandler UrlChanged; /// /// Current URL of the main frame. /// + /// 4 public string Url { get @@ -85,6 +92,7 @@ namespace Tizen.WebView /// /// Current title of the main frame. /// + /// 4 public string Title { get @@ -96,6 +104,7 @@ namespace Tizen.WebView /// /// Current user agent string of this view. /// + /// 4 public string UserAgent { get @@ -112,6 +121,7 @@ namespace Tizen.WebView /// /// Whether a view has the focus. /// + /// 4 public bool HasFocus { get @@ -124,6 +134,7 @@ namespace Tizen.WebView /// Create a WebView object. /// /// Parent object of WebView + /// 4 public WebView(EvasObject parent) : base(parent) { InitializeSmartEvent(); @@ -133,6 +144,7 @@ namespace Tizen.WebView /// Gets the Context object of this view. /// /// The Context object of this view + /// 4 public Context GetContext() { if (_context == null) @@ -151,6 +163,7 @@ namespace Tizen.WebView /// Gets the Settings object of this view. /// /// The Settings object of this view + /// 4 public Settings GetSettings() { if (_settings == null) @@ -172,6 +185,7 @@ namespace Tizen.WebView /// You can only be sure that url changed after UrlChanged event. /// /// The uniform resource identifier to load + /// 4 public void LoadUrl(string url) { Interop.ChromiumEwk.ewk_view_url_set(_realHandle, url); @@ -182,6 +196,7 @@ namespace Tizen.WebView /// /// HTML data to load /// Base URL used for relative paths to external objects + /// 4 public void LoadHtml(string html, string baseUrl) { Interop.ChromiumEwk.ewk_view_html_string_load(_realHandle, html, baseUrl, null); @@ -190,6 +205,7 @@ namespace Tizen.WebView /// /// Asks the main frame to stop loading. /// + /// 4 public void StopLoading() { Interop.ChromiumEwk.ewk_view_stop(_realHandle); @@ -198,6 +214,7 @@ namespace Tizen.WebView /// /// Asks the main frame to reload the current document. /// + /// 4 public void Reload() { Interop.ChromiumEwk.ewk_view_reload(_realHandle); @@ -206,6 +223,7 @@ namespace Tizen.WebView /// /// Asks the main frame to navigate back in history. /// + /// 4 public void GoBack() { Interop.ChromiumEwk.ewk_view_back(_realHandle); @@ -214,6 +232,7 @@ namespace Tizen.WebView /// /// Asks the main frame to navigate forward in history. /// + /// 4 public void GoForward() { Interop.ChromiumEwk.ewk_view_forward(_realHandle); @@ -223,6 +242,7 @@ namespace Tizen.WebView /// Checks whether it is possible to navigate backwards one item in history. /// /// Whether it is possible to navigate backwards one item in history + /// 4 public bool CanGoBack() { return Interop.ChromiumEwk.ewk_view_back_possible(_realHandle); @@ -232,6 +252,7 @@ namespace Tizen.WebView /// Checks whether it is possible to navigate forwards one item in history. /// /// Whether it is possible to navigate forwards one item in history + /// 4 public bool CanGoForward() { return Interop.ChromiumEwk.ewk_view_forward_possible(_realHandle); @@ -243,6 +264,7 @@ namespace Tizen.WebView /// The message callback /// The name used to expose the object in JavaScript /// 'true' on success, otherwise 'false' + /// 4 public bool AddJavaScriptMessageHandler(string name, JavaScriptMessageHandler handler) { lock (_javaScriptMessageHandlerMap) @@ -280,6 +302,7 @@ namespace Tizen.WebView /// /// The name used to expose the object in JavaScript /// The result to the JavaScript runtime + /// 4 public void EvalWithResult(string name, string result) { Interop.ChromiumEwk.ewk_view_evaluate_javascript(_realHandle, name, result); @@ -289,6 +312,7 @@ namespace Tizen.WebView /// Requests the execution of the given script. /// /// The JavaScript code string to execute + /// 4 public void Eval(string script) { Interop.ChromiumEwk.ewk_view_script_execute(_realHandle, script, null, IntPtr.Zero); @@ -298,6 +322,7 @@ namespace Tizen.WebView /// Requests to set or unset a view as the currently focused one. /// /// 'true' to set the focus on the view, 'false' to remove the focus from the view + /// 4 public void SetFocus(bool focused) { Interop.ChromiumEwk.ewk_view_focus_set(_realHandle, focused); @@ -308,6 +333,7 @@ namespace Tizen.WebView /// /// Parent EvasObject /// IntPtr of the widget handle + /// 4 protected override IntPtr CreateHandle(EvasObject parent) { // focus dummy diff --git a/src/Tizen/Tizen.Common/Color.cs b/src/Tizen/Tizen.Common/Color.cs index 53224ae..349d9bd 100644 --- a/src/Tizen/Tizen.Common/Color.cs +++ b/src/Tizen/Tizen.Common/Color.cs @@ -21,101 +21,121 @@ namespace Tizen.Common /// /// Structure that represents a color as RGBA. /// + /// 3 public struct Color : IEquatable { /// /// Empty color instance. All components are 0. /// + /// 3 public static readonly Color Empty = FromRgba(0, 0, 0, 0); /// /// Transparent color instance. All components are 0. /// + /// 3 public static readonly Color Transparent = FromRgba(0, 0, 0, 0); /// /// Aqua color instance. Its RGB value is (0, 255, 255). /// + /// 3 public static readonly Color Aqua = FromRgb(0, 255, 255); /// /// Black color instance. Its RGB value is (0, 0, 0). /// + /// 3 public static readonly Color Black = FromRgb(0, 0, 0); /// /// Blue color instance. Its RGB value is (0, 0, 255). /// + /// 3 public static readonly Color Blue = FromRgb(0, 0, 255); /// /// Fuchsia color instance. Its RGB value is (255, 0, 255). /// + /// 3 public static readonly Color Fuchsia = FromRgb(255, 0, 255); /// /// Gray color instance. Its RGB value is (128, 128, 128). /// + /// 3 public static readonly Color Gray = FromRgb(128, 128, 128); /// /// Green color instance. Its RGB value is (0, 128, 0). /// + /// 3 public static readonly Color Green = FromRgb(0, 128, 0); /// /// Lime color instance. Its RGB value is (0, 255, 0). /// + /// 3 public static readonly Color Lime = FromRgb(0, 255, 0); /// /// Maroon color instance. Its RGB value is (128, 0, 0). /// + /// 3 public static readonly Color Maroon = FromRgb(128, 0, 0); /// /// Navy color instance. Its RGB value is (0, 0, 128). /// + /// 3 public static readonly Color Navy = FromRgb(0, 0, 128); /// /// Olive color instance. Its RGB value is (128, 128, 0). /// + /// 3 public static readonly Color Olive = FromRgb(128, 128, 0); /// /// Purple color instance. Its RGB value is (128, 0, 128). /// + /// 3 public static readonly Color Purple = FromRgb(128, 0, 128); /// /// Pink color instance. Its RGB value is (255, 102, 255). /// + /// 3 public static readonly Color Pink = FromRgb(255, 102, 255); /// /// Red color instance. Its RGB value is (255, 0, 0). /// + /// 3 public static readonly Color Red = FromRgb(255, 0, 0); /// /// Silver color instance. Its RGB value is (192, 192, 192). /// + /// 3 public static readonly Color Silver = FromRgb(192, 192, 192); /// /// Teal color instance. Its RGB value is (0, 128, 128). /// + /// 3 public static readonly Color Teal = FromRgb(0, 128, 128); /// /// White color instance. Its RGB value is (255, 255, 255). /// + /// 3 public static readonly Color White = FromRgb(255, 255, 255); /// /// Yellow color instance. Its RGB value is (255, 255, 0). /// + /// 3 public static readonly Color Yellow = FromRgb(255, 255, 0); private int _value; @@ -127,6 +147,7 @@ namespace Tizen.Common /// Green (0 ~ 255) /// Blue (0 ~ 255) /// Alpha (0 ~ 255) + /// 3 public Color(int r, int g, int b, int a) { if (r > 255 || r < 0) @@ -147,6 +168,7 @@ namespace Tizen.Common /// Red (0 ~ 255) /// Green (0 ~ 255) /// Blue (0 ~ 255) + /// 3 public Color(int r, int g, int b) : this(r, g, b, 255) { } @@ -156,6 +178,7 @@ namespace Tizen.Common /// /// Gets the Red component of the color. /// + /// 3 public int R { get { return (byte)(_value >> 24); } @@ -164,6 +187,7 @@ namespace Tizen.Common /// /// Gets the Green component of the color. /// + /// 3 public int G { get { return (byte)(_value >> 16); } @@ -172,6 +196,7 @@ namespace Tizen.Common /// /// Gets the blue component of the color. /// + /// 3 public int B { get { return (byte)(_value >> 8); } @@ -180,6 +205,7 @@ namespace Tizen.Common /// /// Gets the alpha component of the color. /// + /// 3 public int A { get { return (byte)_value; } @@ -195,6 +221,7 @@ namespace Tizen.Common /// The first Color to compare. /// The second Color to compare. /// True if the Colors are equal; False otherwise. + /// 3 public static bool operator ==(Color color1, Color color2) { return color1.Equals(color2); @@ -206,6 +233,7 @@ namespace Tizen.Common /// The first Color to compare. /// The second Color to compare. /// True if the Colors are not equal; False if they are equal. + /// 3 public static bool operator !=(Color color1, Color color2) { return !color1.Equals(color2); @@ -218,6 +246,7 @@ namespace Tizen.Common /// The green component of the color. /// The blue component of the color. /// + /// 3 public static Color FromRgb(int r, int g, int b) { return new Color(r, g, b); @@ -231,6 +260,7 @@ namespace Tizen.Common /// The blue component of the color. /// The alpha component of the color. /// the RGBA color instance. + /// 3 public static Color FromRgba(int r, int g, int b, int a) { return new Color(r, g, b, a); @@ -241,6 +271,7 @@ namespace Tizen.Common /// /// A string that contains the hexadecimal RGB(A) color representation. /// the RGBA color instance. + /// 3 public static Color FromHex(string hex) { if (hex == null) @@ -280,6 +311,7 @@ namespace Tizen.Common /// /// Gets the 32-bits RGBA value of the color. /// + /// 3 public int GetRgba() { return _value; @@ -288,6 +320,7 @@ namespace Tizen.Common /// /// Gets the 32-bits ARGB value of the color. /// + /// 3 public int GetArgb() { return (int)((uint)A << 24 | (uint)R << 16 | (uint)G << 8 | (uint)B); @@ -297,6 +330,7 @@ namespace Tizen.Common /// Returns a string representation in Hex. (ex: \#FFFFFFFF in RGBA order) /// /// The string representation in Hex. + /// 3 public string ToHex() { return "#" + _value.ToString("X8"); @@ -307,6 +341,7 @@ namespace Tizen.Common /// /// The Color to compare this instance to. /// True if the other Color is equal to this instance; False otherwise. + /// 3 public bool Equals(Color other) { return _value == other._value; @@ -317,6 +352,7 @@ namespace Tizen.Common /// /// The Object to compare against. /// True if the Object is equal to this Color; False otherwise. + /// 3 public override bool Equals(object obj) { if (obj is Color) @@ -330,6 +366,7 @@ namespace Tizen.Common /// Returns a string representation of the Color. /// /// The string representation. + /// 3 public override string ToString() { return string.Format("Color [R={0}, G={1}, B={2}, A={3}]", R, G, B, A); @@ -339,6 +376,7 @@ namespace Tizen.Common /// Returns the hash code for this instance. /// /// The hash code. + /// 3 public override int GetHashCode() { return _value.GetHashCode(); diff --git a/src/Tizen/Tizen.Common/DotnetUtil.cs b/src/Tizen/Tizen.Common/DotnetUtil.cs index 1bdd3bd..8fde49a 100644 --- a/src/Tizen/Tizen.Common/DotnetUtil.cs +++ b/src/Tizen/Tizen.Common/DotnetUtil.cs @@ -21,12 +21,14 @@ namespace Tizen.Common /// /// The DotnetUtil class provides the .NET API version. /// + /// 4 public static class DotnetUtil { /// /// Gets the version of Tizen .NET API. /// /// The Tizen .NET API version + /// 4 public static int TizenAPIVersion { get diff --git a/src/Tizen/Tizen.Internals.Errors/ErrorCode.cs b/src/Tizen/Tizen.Internals.Errors/ErrorCode.cs index b9198b0..c237bf3 100644 --- a/src/Tizen/Tizen.Internals.Errors/ErrorCode.cs +++ b/src/Tizen/Tizen.Internals.Errors/ErrorCode.cs @@ -19,6 +19,7 @@ namespace Tizen.Internals.Errors /// /// Error codes used inside Tizen .NET API implementation /// + /// 3 public enum ErrorCode : int { /// diff --git a/src/Tizen/Tizen.Internals.Errors/ErrorFacts.cs b/src/Tizen/Tizen.Internals.Errors/ErrorFacts.cs index 8d099fa..e4d5e60 100644 --- a/src/Tizen/Tizen.Internals.Errors/ErrorFacts.cs +++ b/src/Tizen/Tizen.Internals.Errors/ErrorFacts.cs @@ -22,12 +22,14 @@ namespace Tizen.Internals.Errors /// /// Provides functions that return additional information about the /// + /// 3 public static class ErrorFacts { /// /// Gets the last error code in the thread. /// /// One of + /// 3 public static int GetLastResult() { return Interop.CommonError.GetLastResult(); @@ -38,6 +40,7 @@ namespace Tizen.Internals.Errors /// /// One of /// + /// 3 public static string GetErrorMessage(int errorCode) { IntPtr errorPtr = Interop.CommonError.GetErrorMessage(errorCode);