[Tizen.Context] Added since_tizen tag 13/152113/1
authorSomin Kim <somin926.kim@samsung.com>
Mon, 25 Sep 2017 06:01:11 +0000 (15:01 +0900)
committerSomin Kim <somin926.kim@samsung.com>
Mon, 25 Sep 2017 06:01:11 +0000 (15:01 +0900)
Change-Id: I0dfb16d897845e2cf761ae9a6cde5ecf78b6402a
Signed-off-by: Somin Kim <somin926.kim@samsung.com>
src/Tizen.Context/Tizen.Context.AppHistory/AppStatistics.cs
src/Tizen.Context/Tizen.Context.AppHistory/AppStatisticsData.cs
src/Tizen.Context/Tizen.Context.AppHistory/BatteryStatistics.cs
src/Tizen.Context/Tizen.Context.AppHistory/BatteryStatisticsData.cs
src/Tizen.Context/Tizen.Context.AppHistory/NamespaceDoc.cs [new file with mode: 0644]
src/Tizen.Context/Tizen.Context.AppHistory/UsageStatistics.cs
src/Tizen.Context/Tizen.Context.AppHistory/UsageStatisticsData.cs

index 3cca79dea60512a4f188d51b21087a3d7dd789bf..8a3939263ecbaabd7a6f1b6c0c27988cdb246e51 100644 (file)
@@ -21,6 +21,7 @@ namespace Tizen.Context.AppHistory
     /// <summary>
     /// Base class for application statistics.
     /// </summary>
+    /// <since_tizen> 4 </since_tizen>
     public abstract class AppStatistics
     {
         internal const string AppStatsQueryResult = "QueryResult";
index ed46f8c597d74cd6e91ee2a3a79d3f88729d65a8..6499de1b164fa6187296926471e0739a53801591 100644 (file)
@@ -19,6 +19,7 @@ namespace Tizen.Context.AppHistory
     /// <summary>
     /// Base class which contains application statistics query result.
     /// </summary>
+    /// <since_tizen> 4 </since_tizen>
     public abstract class AppStatisticsData
     {
         internal AppStatisticsData()
@@ -28,6 +29,7 @@ namespace Tizen.Context.AppHistory
         /// <summary>
         /// Gets the application id.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         /// <value>The application id.</value>
         public string AppId { get; protected set; }
     }
index 7f6259062eb1f579463f65ca98876033b7cc5927..bd346b77a15f9fb53018efe2a8c16c7bf2ed3f21 100644 (file)
@@ -22,6 +22,7 @@ namespace Tizen.Context.AppHistory
     /// <summary>
     /// This class provides APIs to query battery consumption per application.
     /// </summary>
+    /// <since_tizen> 4 </since_tizen>
     public class BatteryStatistics : AppStatistics
     {
         private const string AppStatsConsumption = "TotalAmount";
@@ -29,6 +30,7 @@ namespace Tizen.Context.AppHistory
         /// <summary>
         ///  The default constructor of BatteryStatistics class.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         /// <feature>http://tizen.org/feature/app_history</feature>
         /// <feature>http://tizen.org/feature/battery</feature>
         /// <exception cref="InvalidOperationException">Thrown when method fail due to internal error.</exception>
@@ -54,6 +56,7 @@ namespace Tizen.Context.AppHistory
         /// <summary>
         /// The constructor of BatteryStatistics class.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         /// <param name="order">The criteria of the battery statistics sorted by.</param>
         /// <feature>http://tizen.org/feature/app_history</feature>
         /// <feature>http://tizen.org/feature/battery</feature>
@@ -86,6 +89,7 @@ namespace Tizen.Context.AppHistory
         /// <summary>
         /// Retrieves a given type of battery statistics.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         /// <param name="startTime">The start time of the data to be aggregated.</param>
         /// <param name="endTime">The end time of the data to be aggregated.</param>
         /// <returns>Battery statistics data retrieved.</returns>
@@ -106,6 +110,7 @@ namespace Tizen.Context.AppHistory
         /// <summary>
         /// Retrieves a given type of battery statistics.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         /// <param name="startTime">The start time of the data to be aggregated.</param>
         /// <param name="endTime">The end time of the data to be aggregated.</param>
         /// <param name="resultSize">The number of data records to be retrieved.</param>
@@ -153,6 +158,7 @@ namespace Tizen.Context.AppHistory
         /// <summary>
         /// Gets the last time when the device was fully charged.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         /// <returns>The last time when the device was fully charged.</returns>
         /// <feature>http://tizen.org/feature/app_history</feature>
         /// <feature>http://tizen.org/feature/battery</feature>
@@ -195,12 +201,14 @@ namespace Tizen.Context.AppHistory
         /// <summary>
         /// Gets the criteria of battery statistics sorted by.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         /// <value>The criteria of battery statistics sorted by.</value>
         public SortOrderType SortOrder { get; private set; }
 
         /// <summary>
         /// Sort order type of battery statistics.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public enum SortOrderType
         {
             /// <summary>
index 9dd6e4c95036b37785e2340932bbb8cd716c2cab..7b7842d5413378f05f84d9470f2f4109382b742b 100644 (file)
@@ -19,6 +19,7 @@ namespace Tizen.Context.AppHistory
     /// <summary>
     /// The class contains battery statistics information retrieved by BatteryStatistics.
     /// </summary>
+    /// <since_tizen> 4 </since_tizen>
     public class BatteryStatisticsData : AppStatisticsData
     {
         internal BatteryStatisticsData(string appId, double consumption)
@@ -31,6 +32,7 @@ namespace Tizen.Context.AppHistory
         /// Gets how many percentage of battery capacity was used by the application.
         /// </summary>
         /// <value>Battery consumption used by the application.</value>
+        /// <since_tizen> 4 </since_tizen>
         public double Consumption { get; private set; }
     }
 }
diff --git a/src/Tizen.Context/Tizen.Context.AppHistory/NamespaceDoc.cs b/src/Tizen.Context/Tizen.Context.AppHistory/NamespaceDoc.cs
new file mode 100644 (file)
index 0000000..8989d3f
--- /dev/null
@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2017 Samsung Electronics Co., Ltd All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/// <summary>
+/// The Tizen.Context.AppHistory namespace provides classes to retrieve the user's application usage patterns.
+/// </summary>
+/// <remarks>
+/// The Tizen.Context.AppHistory namespace provides classes to retrieve the user's application usage patterns.
+/// </remarks>
+/// <since_tizen> 4 </since_tizen>
+namespace Tizen.Context.AppHistory {}
index 9a96f29c8ed249bc938bbc0508427eaf48846e1e..121808dbbadd3f76bd5a49031b15bb6f6de84e3e 100644 (file)
@@ -22,6 +22,7 @@ namespace Tizen.Context.AppHistory
     /// <summary>
     /// This class provides APIs to query application launch history.
     /// </summary>
+    /// <since_tizen> 4 </since_tizen>
     public class UsageStatistics : AppStatistics
     {
         private const string AppStatsDuration = "TotalDuration";
@@ -31,6 +32,7 @@ namespace Tizen.Context.AppHistory
         /// <summary>
         /// The default constructor of UsageStatistics class.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         /// <feature>http://tizen.org/feature/app_history</feature>
         /// <exception cref="InvalidOperationException">Thrown when method fail due to internal error.</exception>
         /// <exception cref="NotSupportedException">Thrown when the feature is not supported.</exception>
@@ -55,6 +57,7 @@ namespace Tizen.Context.AppHistory
         /// <summary>
         /// The constructor of UsageStatistics class.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         /// <param name="order">The criteria of the usage statistics sorted by.</param>
         /// <feature>http://tizen.org/feature/app_history</feature>
         /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
@@ -86,6 +89,7 @@ namespace Tizen.Context.AppHistory
         /// <summary>
         /// Retrieves a given type of usage statistics.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         /// <param name="startTime">The start time of the data to be aggregated.</param>
         /// <param name="endTime">The end time of the data to be aggregated.</param>
         /// <returns>Usage statistics data retrieved.</returns>
@@ -105,6 +109,7 @@ namespace Tizen.Context.AppHistory
         /// <summary>
         /// Retrieves a given type of usage statistics.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         /// <param name="startTime">The start time of the data to be aggregated.</param>
         /// <param name="endTime">The end time of the data to be aggregated.</param>
         /// <param name="resultSize">The number of data records to be retrieved.</param>
@@ -178,12 +183,14 @@ namespace Tizen.Context.AppHistory
         /// <summary>
         /// Gets the criteria of usage statistics sorted by.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         /// <value>The criteria of usage statistics sorted by.</value>
         public SortOrderType SortOrder { get; private set; }
 
         /// <summary>
         /// Sort order type of usage statistics
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         public enum SortOrderType
         {
             /// <summary>
index c090e901888ed6fad58e052aeaf9d9e7ea6038ca..a1aa0d198fefc4d946238fde356536ced4fa976c 100644 (file)
@@ -21,6 +21,7 @@ namespace Tizen.Context.AppHistory
     /// <summary>
     /// The class contains application usage statistics information retrieved by UsageStatistics.
     /// </summary>
+    /// <since_tizen> 4 </since_tizen>
     public class UsageStatisticsData : AppStatisticsData
     {
         internal UsageStatisticsData(string appId, int duration, int launchCount, DateTime lastLaunchTime)
@@ -34,18 +35,21 @@ namespace Tizen.Context.AppHistory
         /// <summary>
         ///  Gets the time which the application is being displayed in the foreground in seconds.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         /// <value>Duration which the application is used in the foreground in seconds.</value>
         public int Duration { get; private set; }
 
         /// <summary>
         ///  Gets how many times the application is used in the foreground.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         /// <value>How many times the application is used in the foreground.</value>
         public int LaunchCount { get; private set; }
 
         /// <summary>
         /// Gets the last time when the application has been used.
         /// </summary>
+        /// <since_tizen> 4 </since_tizen>
         /// <value>The last time when the application has been used.</value>
         public DateTime LastLaunchTime { get; private set; }
     }