Release 4.0.0-preview1-00201
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.Context.xml
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Tizen.Context</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Tizen.Context.AppHistory.AppStatistics">\r
8             <summary>\r
9             Base class for application statistics.\r
10             </summary>\r
11         </member>\r
12         <member name="T:Tizen.Context.AppHistory.AppStatisticsData">\r
13             <summary>\r
14             Base class which contains application statistics query result.\r
15             </summary>\r
16         </member>\r
17         <member name="P:Tizen.Context.AppHistory.AppStatisticsData.AppId">\r
18             <summary>\r
19             Gets the application id.\r
20             </summary>\r
21             <value>The application id.</value>\r
22         </member>\r
23         <member name="T:Tizen.Context.AppHistory.BatteryStatistics">\r
24             <summary>\r
25             This class provides APIs to query battery consumption per application.\r
26             </summary>\r
27         </member>\r
28         <member name="M:Tizen.Context.AppHistory.BatteryStatistics.#ctor">\r
29             <summary>\r
30              The default constructor of BatteryStatistics class.\r
31             </summary>\r
32             <feature>http://tizen.org/feature/battery</feature>\r
33             <exception cref="T:System.InvalidOperationException">Thrown when method fail due to internal error.</exception>\r
34             <exception cref="T:System.NotSupportedException">Thrown when the statistics is not supported.</exception>\r
35         </member>\r
36         <member name="M:Tizen.Context.AppHistory.BatteryStatistics.#ctor(Tizen.Context.AppHistory.BatteryStatistics.SortOrderType)">\r
37             <summary>\r
38             The constructor of BatteryStatistics class.\r
39             </summary>\r
40             <param name="order">The criteria of the battery statistics sorted by.</param>\r
41             <feature>http://tizen.org/feature/battery</feature>\r
42             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>\r
43             <exception cref="T:System.InvalidOperationException">Thrown when method fail due to internal error.</exception>\r
44             <exception cref="T:System.NotSupportedException">Thrown when the statistics is not supported.</exception>\r
45         </member>\r
46         <member name="M:Tizen.Context.AppHistory.BatteryStatistics.Query(System.DateTime,System.DateTime)">\r
47             <summary>\r
48             Retrieves a given type of battery statistics.\r
49             </summary>\r
50             <param name="startTime">The start time of the data to be aggregated.</param>\r
51             <param name="endTime">The end time of the data to be aggregated.</param>\r
52             <returns>Battery statistics data retrieved.</returns>\r
53             <privilege>http://tizen.org/privilege/apphistory.read</privilege>\r
54             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>\r
55             <exception cref="T:System.InvalidOperationException">Thrown when invalid operation occurs.</exception>\r
56             <exception cref="T:System.UnauthorizedAccessException">Thrown when the app has no privilege to retrieve app history.</exception>\r
57         </member>\r
58         <member name="M:Tizen.Context.AppHistory.BatteryStatistics.Query(System.DateTime,System.DateTime,System.UInt32)">\r
59             <summary>\r
60             Retrieves a given type of battery statistics.\r
61             </summary>\r
62             <param name="startTime">The start time of the data to be aggregated.</param>\r
63             <param name="endTime">The end time of the data to be aggregated.</param>\r
64             <param name="resultSize">The number of data records to be retrieved.</param>\r
65             <returns>Battery statistics data retrieved.</returns>\r
66             <privilege>http://tizen.org/privilege/apphistory.read</privilege>\r
67             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>\r
68             <exception cref="T:System.InvalidOperationException">Thrown when invalid operation occurs.</exception>\r
69             <exception cref="T:System.UnauthorizedAccessException">Thrown when the app has no privilege to retrieve app history.</exception>\r
70         </member>\r
71         <member name="M:Tizen.Context.AppHistory.BatteryStatistics.GetLastFullyChargedTime">\r
72             <summary>\r
73             Gets the last time when the device was fully charged.\r
74             </summary>\r
75             <returns>The last time when the device was fully charged.</returns>\r
76             <feature>http://tizen.org/feature/battery</feature>\r
77             <exception cref="T:System.NotSupportedException">Thrown when the statistics is not supported.</exception>\r
78         </member>\r
79         <member name="P:Tizen.Context.AppHistory.BatteryStatistics.SortOrder">\r
80             <summary>\r
81             Gets the criteria of battery statistics sorted by.\r
82             </summary>\r
83             <value>The criteria of battery statistics sorted by.</value>\r
84         </member>\r
85         <member name="T:Tizen.Context.AppHistory.BatteryStatistics.SortOrderType">\r
86             <summary>\r
87             Sort order type of battery statistics.\r
88             </summary>\r
89         </member>\r
90         <member name="F:Tizen.Context.AppHistory.BatteryStatistics.SortOrderType.ConsumptionMost">\r
91             <summary>\r
92             Sorts apps by consumption, the most battery consuming apps appear first. (Default)\r
93             </summary>\r
94         </member>\r
95         <member name="T:Tizen.Context.AppHistory.BatteryStatisticsData">\r
96             <summary>\r
97             The class contains battery statistics information retrieved by BatteryStatistics.\r
98             </summary>\r
99         </member>\r
100         <member name="P:Tizen.Context.AppHistory.BatteryStatisticsData.Consumption">\r
101             <summary>\r
102             Gets how many percentage of battery capacity was used by the application.\r
103             </summary>\r
104             <value>Battery consumption used by the application.</value>\r
105         </member>\r
106         <member name="T:Tizen.Context.AppHistory.UsageStatistics">\r
107             <summary>\r
108             This class provides APIs to query application launch history.\r
109             </summary>\r
110         </member>\r
111         <member name="M:Tizen.Context.AppHistory.UsageStatistics.#ctor">\r
112             <summary>\r
113             The default constructor of UsageStatistics class.\r
114             </summary>\r
115             <exception cref="T:System.InvalidOperationException">Thrown when method fail due to internal error.</exception>\r
116         </member>\r
117         <member name="M:Tizen.Context.AppHistory.UsageStatistics.#ctor(Tizen.Context.AppHistory.UsageStatistics.SortOrderType)">\r
118             <summary>\r
119             The constructor of UsageStatistics class.\r
120             </summary>\r
121             <param name="order">The criteria of the usage statistics sorted by.</param>\r
122             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>\r
123             <exception cref="T:System.InvalidOperationException">Thrown when method fail due to internal error.</exception>\r
124         </member>\r
125         <member name="M:Tizen.Context.AppHistory.UsageStatistics.Query(System.DateTime,System.DateTime)">\r
126             <summary>\r
127             Retrieves a given type of usage statistics.\r
128             </summary>\r
129             <param name="startTime">The start time of the data to be aggregated.</param>\r
130             <param name="endTime">The end time of the data to be aggregated.</param>\r
131             <returns>Usage statistics data retrieved.</returns>\r
132             <privilege>http://tizen.org/privilege/apphistory.read</privilege>\r
133             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>\r
134             <exception cref="T:System.InvalidOperationException">Thrown when invalid operation occurs.</exception>\r
135             <exception cref="T:System.UnauthorizedAccessException">Thrown when the app has no privilege to retrieve app history.</exception>\r
136         </member>\r
137         <member name="M:Tizen.Context.AppHistory.UsageStatistics.Query(System.DateTime,System.DateTime,System.UInt32)">\r
138             <summary>\r
139             Retrieves a given type of usage statistics.\r
140             </summary>\r
141             <param name="startTime">The start time of the data to be aggregated.</param>\r
142             <param name="endTime">The end time of the data to be aggregated.</param>\r
143             <param name="resultSize">The number of data records to be retrieved.</param>\r
144             <returns>Usage statistics data retrieved.</returns>\r
145             <privilege>http://tizen.org/privilege/apphistory.read</privilege>\r
146             <exception cref="T:System.ArgumentException">Thrown when an invalid argument is used.</exception>\r
147             <exception cref="T:System.InvalidOperationException">Thrown when invalid operation occurs.</exception>\r
148             <exception cref="T:System.UnauthorizedAccessException">Thrown when the app has no privilege to retrieve app history.</exception>\r
149         </member>\r
150         <member name="P:Tizen.Context.AppHistory.UsageStatistics.SortOrder">\r
151             <summary>\r
152             Gets the criteria of usage statistics sorted by.\r
153             </summary>\r
154             <value>The criteria of usage statistics sorted by.</value>\r
155         </member>\r
156         <member name="T:Tizen.Context.AppHistory.UsageStatistics.SortOrderType">\r
157             <summary>\r
158             Sort order type of usage statistics\r
159             </summary>\r
160         </member>\r
161         <member name="F:Tizen.Context.AppHistory.UsageStatistics.SortOrderType.LastLaunchTimeNewest">\r
162             <summary>\r
163             Sorts apps by the last launch time, the most recently launched apps appear first. (Default)\r
164             </summary>\r
165         </member>\r
166         <member name="F:Tizen.Context.AppHistory.UsageStatistics.SortOrderType.LaunchCountMost">\r
167             <summary>\r
168             Sorts apps by the launch count of being launched, the most frequently launched apps appear first.\r
169             </summary>\r
170         </member>\r
171         <member name="T:Tizen.Context.AppHistory.UsageStatisticsData">\r
172             <summary>\r
173             The class contains application usage statistics information retrieved by UsageStatistics.\r
174             </summary>\r
175         </member>\r
176         <member name="P:Tizen.Context.AppHistory.UsageStatisticsData.Duration">\r
177             <summary>\r
178              Gets the time which the application is being displayed in the foreground in seconds.\r
179             </summary>\r
180             <value>Duration which the application is used in the foreground in seconds.</value>\r
181         </member>\r
182         <member name="P:Tizen.Context.AppHistory.UsageStatisticsData.LaunchCount">\r
183             <summary>\r
184              Gets how many times the application is used in the foreground.\r
185             </summary>\r
186             <value>How many times the application is used in the foreground.</value>\r
187         </member>\r
188         <member name="P:Tizen.Context.AppHistory.UsageStatisticsData.LastLaunchTime">\r
189             <summary>\r
190             Gets the last time when the application has been used.\r
191             </summary>\r
192             <value>The last time when the application has been used.</value>\r
193         </member>\r
194     </members>\r
195 </doc>\r