Release 4.0.0-preview1-00201
[platform/core/csapi/tizenfx.git] / Artifacts / bin / platform / Tizen.Applications.Shortcut.xml
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Tizen.Applications.Shortcut</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Interop.Shortcut.ErrorCode">\r
8             <summary>\r
9             Enumeration for values of shortcut response types.\r
10             </summary>\r
11         </member>\r
12         <member name="F:Interop.Shortcut.ErrorCode.None">\r
13             <summary>\r
14             Successful\r
15             </summary>\r
16         </member>\r
17         <member name="F:Interop.Shortcut.ErrorCode.InvalidParameter">\r
18             <summary>\r
19             Invalid function parameter\r
20             </summary>\r
21         </member>\r
22         <member name="F:Interop.Shortcut.ErrorCode.OutOfMemory">\r
23             <summary>\r
24             Out of memory\r
25             </summary>\r
26         </member>\r
27         <member name="F:Interop.Shortcut.ErrorCode.PermissionDenied">\r
28             <summary>\r
29             Permission denied\r
30             </summary>\r
31         </member>\r
32         <member name="F:Interop.Shortcut.ErrorCode.IoError">\r
33             <summary>\r
34             I/O Error\r
35             </summary>\r
36         </member>\r
37         <member name="F:Interop.Shortcut.ErrorCode.NotSupported">\r
38             <summary>\r
39             Not supported\r
40             </summary>\r
41         </member>\r
42         <member name="F:Interop.Shortcut.ErrorCode.ResourceBusy">\r
43             <summary>\r
44             Device or resource busy\r
45             </summary>\r
46         </member>\r
47         <member name="F:Interop.Shortcut.ErrorCode.NoSpace">\r
48             <summary>\r
49             There is no space to add a new shortcut\r
50             </summary>\r
51         </member>\r
52         <member name="F:Interop.Shortcut.ErrorCode.Exist">\r
53             <summary>\r
54             Shortcut is already added\r
55             </summary>\r
56         </member>\r
57         <member name="F:Interop.Shortcut.ErrorCode.Fault">\r
58             <summary>\r
59             Unrecoverable error\r
60             </summary>\r
61         </member>\r
62         <member name="F:Interop.Shortcut.ErrorCode.NotExist">\r
63             <summary>\r
64             Not exist shortcut\r
65             </summary>\r
66         </member>\r
67         <member name="F:Interop.Shortcut.ErrorCode.COMM">\r
68             <summary>\r
69             Connection not established or communication problem\r
70             </summary>\r
71         </member>\r
72         <member name="T:Tizen.Applications.Shortcut.HomeShortcutAddedInfo">\r
73             <summary>\r
74             A class that contains shortcut information.\r
75             </summary>\r
76         </member>\r
77         <member name="P:Tizen.Applications.Shortcut.HomeShortcutAddedInfo.AppId">\r
78             <summary>\r
79             Gets the name of application.\r
80             </summary>\r
81         </member>\r
82         <member name="P:Tizen.Applications.Shortcut.HomeShortcutAddedInfo.Uri">\r
83             <summary>\r
84             Gets the specific information for creating a new shortcut.\r
85             </summary>\r
86         </member>\r
87         <member name="T:Tizen.Applications.Shortcut.ShortcutAddedInfo">\r
88             <summary>\r
89             A class for getting information of the Shortcut.\r
90             </summary>\r
91         </member>\r
92         <member name="P:Tizen.Applications.Shortcut.ShortcutAddedInfo.ShortcutName">\r
93             <summary>\r
94             Gets the name of the created shortcut icon.\r
95             </summary>\r
96         </member>\r
97         <member name="P:Tizen.Applications.Shortcut.ShortcutAddedInfo.IconPath">\r
98             <summary>\r
99             Gets the absolute path of an icon file for this shortcut.\r
100             </summary>\r
101         </member>\r
102         <member name="P:Tizen.Applications.Shortcut.ShortcutAddedInfo.IsAllowDuplicate">\r
103             <summary>\r
104             Gets a value indicating whether to allow or not to allow duplication.\r
105             </summary>\r
106         </member>\r
107         <member name="T:Tizen.Applications.Shortcut.ShortcutDeletedInfo">\r
108             <summary>\r
109             A class for getting information of the Shortcut.\r
110             </summary>\r
111         </member>\r
112         <member name="P:Tizen.Applications.Shortcut.ShortcutDeletedInfo.AppId">\r
113             <summary>\r
114             Gets the name of package.\r
115             </summary>\r
116         </member>\r
117         <member name="P:Tizen.Applications.Shortcut.ShortcutDeletedInfo.ShortcutName">\r
118             <summary>\r
119             Gets the name of the created shortcut icon.\r
120             </summary>\r
121         </member>\r
122         <member name="T:Tizen.Applications.Shortcut.ShortcutError">\r
123             <summary>\r
124             Enumeration for values of shortcut response types.\r
125             </summary>\r
126         </member>\r
127         <member name="F:Tizen.Applications.Shortcut.ShortcutError.None">\r
128             <summary>\r
129             Successful.\r
130             </summary>\r
131         </member>\r
132         <member name="F:Tizen.Applications.Shortcut.ShortcutError.InvalidParameter">\r
133             <summary>\r
134             Invalid function parameter.\r
135             </summary>\r
136         </member>\r
137         <member name="F:Tizen.Applications.Shortcut.ShortcutError.OutOfMemory">\r
138             <summary>\r
139             Out of memory.\r
140             </summary>\r
141         </member>\r
142         <member name="F:Tizen.Applications.Shortcut.ShortcutError.IoError">\r
143             <summary>\r
144             I/O Error.\r
145             </summary>\r
146         </member>\r
147         <member name="F:Tizen.Applications.Shortcut.ShortcutError.NoSpace">\r
148             <summary>\r
149             There is no space to add a new shortcut.\r
150             </summary>\r
151         </member>\r
152         <member name="F:Tizen.Applications.Shortcut.ShortcutError.Exist">\r
153             <summary>\r
154             Shortcut is already added.\r
155             </summary>\r
156         </member>\r
157         <member name="F:Tizen.Applications.Shortcut.ShortcutError.NotExist">\r
158             <summary>\r
159             Not exist shortcut.\r
160             </summary>\r
161         </member>\r
162         <member name="T:Tizen.Applications.Shortcut.ShortcutAdded">\r
163             <summary>\r
164             The callback function that is invoked when add request occurred\r
165             </summary>\r
166             <param name="args">Object that contain shortcut info to add.</param>\r
167             <returns>The result of handling a shortcut add request</returns>\r
168         </member>\r
169         <member name="T:Tizen.Applications.Shortcut.ShortcutDeleted">\r
170             <summary>\r
171             The callback function that is invoked when delete request occurred\r
172             </summary>\r
173             <param name="args">Object that contain shortcut info to delete.</param>\r
174             <returns>The result of handling a shortcut delete request</returns>\r
175         </member>\r
176         <member name="T:Tizen.Applications.Shortcut.ShortcutEventManager">\r
177             <summary>\r
178             This class provides a way to register callback function for shortcut add, delete events.\r
179             </summary>\r
180         </member>\r
181         <member name="M:Tizen.Applications.Shortcut.ShortcutEventManager.RegisterEventHandler(Tizen.Applications.Shortcut.ShortcutAdded)">\r
182             <summary>\r
183             Registers a callback function to listen requests from applications.\r
184             </summary>\r
185             <since_tizen> 3 </since_tizen>\r
186             <param name="addedEvent">The callback function pointer that is invoked when Add() is requested</param>\r
187             <feature>http://tizen.org/feature/shortcut</feature>\r
188             <privilege>http://tizen.org/privilege/shortcut</privilege>\r
189             <remarks>\r
190             Previous registered delegate function should be unregister.\r
191             </remarks>\r
192             <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
193             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of permission denied.</exception>\r
194             <exception cref="T:System.NotSupportedException">Thrown when Shortcut is not supported.</exception>\r
195             <exception cref="T:System.OutOfMemoryException">Thrown in case of out of memory.</exception>\r
196             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
197         </member>\r
198         <member name="M:Tizen.Applications.Shortcut.ShortcutEventManager.RegisterEventHandler(Tizen.Applications.Shortcut.ShortcutDeleted)">\r
199             <summary>\r
200             Registers a callback function to listen requests from applications.\r
201             </summary>\r
202             <since_tizen> 3 </since_tizen>\r
203             <param name="deletedEvent">The callback function pointer that is invoked when Delete() is requested</param>\r
204             <feature>http://tizen.org/feature/shortcut</feature>\r
205             <privilege>http://tizen.org/privilege/shortcut</privilege>\r
206             <remarks>\r
207             Previous registered delegate function should be unregister.\r
208             </remarks>\r
209             <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
210             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of permission denied.</exception>\r
211             <exception cref="T:System.NotSupportedException">Thrown when Shortcut is not supported.</exception>\r
212             <exception cref="T:System.OutOfMemoryException">Thrown in case of out of memory.</exception>\r
213             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
214         </member>\r
215         <member name="M:Tizen.Applications.Shortcut.ShortcutEventManager.UnregisterEventHandler(Tizen.Applications.Shortcut.ShortcutAdded)">\r
216             <summary>\r
217             Unregisters a callback for the shortcut request.\r
218             </summary>\r
219             <since_tizen> 3 </since_tizen>\r
220             <param name="addedEvent">The callback function pointer that used for RegisterCallback</param>\r
221             <feature>http://tizen.org/feature/shortcut</feature>\r
222             <privilege>http://tizen.org/privilege/shortcut</privilege>\r
223             <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
224             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of permission denied.</exception>\r
225             <exception cref="T:System.NotSupportedException">Thrown when Shortcut is not supported.</exception>\r
226         </member>\r
227         <member name="M:Tizen.Applications.Shortcut.ShortcutEventManager.UnregisterEventHandler(Tizen.Applications.Shortcut.ShortcutDeleted)">\r
228             <summary>\r
229             Unregisters a callback for the shortcut request.\r
230             </summary>\r
231             <since_tizen> 3 </since_tizen>\r
232             <param name="deletedEvent">The callback function pointer that used for RegisterCallback</param>\r
233             <feature>http://tizen.org/feature/shortcut</feature>\r
234             <privilege>http://tizen.org/privilege/shortcut</privilege>\r
235             <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
236             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of permission denied.</exception>\r
237             <exception cref="T:System.NotSupportedException">Thrown when Shortcut is not supported.</exception>\r
238         </member>\r
239         <member name="M:Tizen.Applications.Shortcut.ShortcutEventManager.GetTemplateList(System.String)">\r
240             <summary>\r
241             Gets the preset list of shortcut template from the installed package.\r
242             </summary>\r
243             <since_tizen> 3 </since_tizen>\r
244             <param name="appId">Application ID.</param>\r
245             <returns>The List of ShortcutTemplate.</returns>\r
246             <feature>http://tizen.org/feature/shortcut</feature>\r
247             <privilege>http://tizen.org/privilege/shortcut</privilege>\r
248             <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
249             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of permission denied.</exception>\r
250             <exception cref="T:System.NotSupportedException">Thrown when Shortcut is not supported.</exception>\r
251             <exception cref="T:System.OutOfMemoryException">Thrown in case of out of memory.</exception>\r
252             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
253         </member>\r
254         <member name="T:Tizen.Applications.Shortcut.ShortcutTemplate">\r
255             <summary>\r
256             A class that contains the preset list of shortcut template from the installed package.\r
257             </summary>\r
258         </member>\r
259         <member name="P:Tizen.Applications.Shortcut.ShortcutTemplate.AppId">\r
260             <summary>\r
261             Gets the Application ID.\r
262             </summary>\r
263         </member>\r
264         <member name="P:Tizen.Applications.Shortcut.ShortcutTemplate.ShortcutName">\r
265             <summary>\r
266             Gets the name of the created shortcut icon.\r
267             </summary>\r
268         </member>\r
269         <member name="P:Tizen.Applications.Shortcut.ShortcutTemplate.IconPath">\r
270             <summary>\r
271             Gets the absolute path of an icon file for this shortcut.\r
272             </summary>\r
273         </member>\r
274         <member name="P:Tizen.Applications.Shortcut.ShortcutTemplate.ExtraKey">\r
275             <summary>\r
276             Gets the user data. A property of shortcut element in manifest file.\r
277             </summary>\r
278         </member>\r
279         <member name="P:Tizen.Applications.Shortcut.ShortcutTemplate.ExtraData">\r
280             <summary>\r
281             Gets the user data. A property of shortcut element in manifest file.\r
282             </summary>\r
283         </member>\r
284         <member name="T:Tizen.Applications.Shortcut.WidgetShortcutAddedInfo">\r
285             <summary>\r
286             A class that contains information about the widget.\r
287             </summary>\r
288         </member>\r
289         <member name="P:Tizen.Applications.Shortcut.WidgetShortcutAddedInfo.WidgetId">\r
290             <summary>\r
291             Gets the Widget ID.\r
292             </summary>\r
293         </member>\r
294         <member name="P:Tizen.Applications.Shortcut.WidgetShortcutAddedInfo.WidgetSize">\r
295             <summary>\r
296             Gets the size of widget.\r
297             </summary>\r
298         </member>\r
299         <member name="P:Tizen.Applications.Shortcut.WidgetShortcutAddedInfo.Period">\r
300             <summary>\r
301             Gets the Update period in seconds.\r
302             </summary>\r
303         </member>\r
304         <member name="T:Tizen.Applications.Shortcut.HomeShortcutInfo">\r
305             <summary>\r
306             A class that contains shortcut information.\r
307             </summary>\r
308         </member>\r
309         <member name="P:Tizen.Applications.Shortcut.HomeShortcutInfo.Uri">\r
310             <summary>\r
311             Gets or sets the specific information for delivering to the viewer for creating a shortcut.\r
312             </summary>\r
313         </member>\r
314         <member name="T:Tizen.Applications.Shortcut.ShortcutWidgetSize">\r
315             <summary>\r
316             Enumeration for sizes of shortcut widget.\r
317             </summary>\r
318         </member>\r
319         <member name="F:Tizen.Applications.Shortcut.ShortcutWidgetSize.WidgetDefault">\r
320             <summary>\r
321             Type mask for the normal mode widget , don't use this value for specific size.\r
322             </summary>\r
323         </member>\r
324         <member name="F:Tizen.Applications.Shortcut.ShortcutWidgetSize.Widget1by1">\r
325             <summary>\r
326             1by1\r
327             </summary>\r
328         </member>\r
329         <member name="F:Tizen.Applications.Shortcut.ShortcutWidgetSize.Widget2by1">\r
330             <summary>\r
331             2by1\r
332             </summary>\r
333         </member>\r
334         <member name="F:Tizen.Applications.Shortcut.ShortcutWidgetSize.Widget2by2">\r
335             <summary>\r
336             2by2\r
337             </summary>\r
338         </member>\r
339         <member name="F:Tizen.Applications.Shortcut.ShortcutWidgetSize.Widget4by1">\r
340             <summary>\r
341             4by1\r
342             </summary>\r
343         </member>\r
344         <member name="F:Tizen.Applications.Shortcut.ShortcutWidgetSize.Widget4by2">\r
345             <summary>\r
346             4by2\r
347             </summary>\r
348         </member>\r
349         <member name="F:Tizen.Applications.Shortcut.ShortcutWidgetSize.Widget4by3">\r
350             <summary>\r
351             4by3\r
352             </summary>\r
353         </member>\r
354         <member name="F:Tizen.Applications.Shortcut.ShortcutWidgetSize.Widget4by4">\r
355             <summary>\r
356             4by4\r
357             </summary>\r
358         </member>\r
359         <member name="F:Tizen.Applications.Shortcut.ShortcutWidgetSize.Widget4by5">\r
360             <summary>\r
361             4by5\r
362             </summary>\r
363         </member>\r
364         <member name="F:Tizen.Applications.Shortcut.ShortcutWidgetSize.Widget4by6">\r
365             <summary>\r
366             4by6\r
367             </summary>\r
368         </member>\r
369         <member name="F:Tizen.Applications.Shortcut.ShortcutWidgetSize.EasyDefault">\r
370             <summary>\r
371             Type mask for the easy mode widget, don't use this value for specific size.\r
372             </summary>\r
373         </member>\r
374         <member name="F:Tizen.Applications.Shortcut.ShortcutWidgetSize.Easy1by1">\r
375             <summary>\r
376             Easy mode 1by1\r
377             </summary>\r
378         </member>\r
379         <member name="F:Tizen.Applications.Shortcut.ShortcutWidgetSize.Easy3by1">\r
380             <summary>\r
381             Easy mode 3by2\r
382             </summary>\r
383         </member>\r
384         <member name="F:Tizen.Applications.Shortcut.ShortcutWidgetSize.Easy3by3">\r
385             <summary>\r
386             Easy mode 3by3\r
387             </summary>\r
388         </member>\r
389         <member name="T:Tizen.Applications.Shortcut.ShortcutType">\r
390             <summary>\r
391             Enumeration for shortcut types.\r
392             </summary>\r
393         </member>\r
394         <member name="F:Tizen.Applications.Shortcut.ShortcutType.LaunchByApp">\r
395             <summary>\r
396             Launch the application itself.\r
397             </summary>\r
398         </member>\r
399         <member name="F:Tizen.Applications.Shortcut.ShortcutType.LaunchByUri">\r
400             <summary>\r
401             Launch the application with the given data(URI).\r
402             </summary>\r
403         </member>\r
404         <member name="T:Tizen.Applications.Shortcut.ShortcutInfo">\r
405             <summary>\r
406             A class to get information of the Shortcut.\r
407             </summary>\r
408         </member>\r
409         <member name="P:Tizen.Applications.Shortcut.ShortcutInfo.ShortcutName">\r
410             <summary>\r
411             Gets or sets the name of the created shortcut icon.\r
412             </summary>\r
413         </member>\r
414         <member name="P:Tizen.Applications.Shortcut.ShortcutInfo.IconPath">\r
415             <summary>\r
416             Gets or sets the absolute path of an icon file for this shortcut.\r
417             </summary>\r
418         </member>\r
419         <member name="P:Tizen.Applications.Shortcut.ShortcutInfo.IsAllowDuplicate">\r
420             <summary>\r
421             Gets or sets a value indicating whether to allow or not to allow duplication.\r
422             </summary>\r
423         </member>\r
424         <member name="T:Tizen.Applications.Shortcut.ShortcutManager">\r
425             <summary>\r
426             This class provides the some functions to add, delete shortcut.\r
427             </summary>\r
428         </member>\r
429         <member name="M:Tizen.Applications.Shortcut.ShortcutManager.Add(Tizen.Applications.Shortcut.HomeShortcutInfo)">\r
430             <summary>\r
431             Adds a shortcut on home-screen.\r
432             </summary>\r
433             <since_tizen> 3 </since_tizen>\r
434             <param name="shortcut">Object that contain shortcut info.</param>\r
435             <feature>http://tizen.org/feature/shortcut</feature>\r
436             <privilege>http://tizen.org/privilege/shortcut</privilege>\r
437             <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
438             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of permission denied.</exception>\r
439             <exception cref="T:System.NotSupportedException">Thrown when Shortcut is not supported.</exception>\r
440             <exception cref="T:System.OutOfMemoryException">Thrown in case of out of memory.</exception>\r
441             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
442         </member>\r
443         <member name="M:Tizen.Applications.Shortcut.ShortcutManager.Add(Tizen.Applications.Shortcut.WidgetShortcutInfo)">\r
444             <summary>\r
445             Adds a shortcut on home-screen.\r
446             </summary>\r
447             <since_tizen> 3 </since_tizen>\r
448             <param name="shortcut">Object that contain shortcut info.</param>\r
449             <feature>http://tizen.org/feature/shortcut</feature>\r
450             <privilege>http://tizen.org/privilege/shortcut</privilege>\r
451             <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
452             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of permission denied.</exception>\r
453             <exception cref="T:System.NotSupportedException">Thrown when Shortcut is not supported.</exception>\r
454             <exception cref="T:System.OutOfMemoryException">Thrown in case of out of memory.</exception>\r
455             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
456         </member>\r
457         <member name="M:Tizen.Applications.Shortcut.ShortcutManager.Delete(System.String)">\r
458             <summary>\r
459             Removes a shortcut from home by ShortcutName.\r
460             </summary>\r
461             <since_tizen> 3 </since_tizen>\r
462             <param name="shortcutName">Shortcut name string.</param>\r
463             <feature>http://tizen.org/feature/shortcut</feature>\r
464             <privilege>http://tizen.org/privilege/shortcut</privilege>\r
465             <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
466             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of permission denied.</exception>\r
467             <exception cref="T:System.NotSupportedException">Thrown when Shortcut is not supported.</exception>\r
468             <exception cref="T:System.OutOfMemoryException">Thrown in case of out of memory.</exception>\r
469             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
470         </member>\r
471         <member name="M:Tizen.Applications.Shortcut.ShortcutManager.Delete(Tizen.Applications.Shortcut.ShortcutInfo)">\r
472             <summary>\r
473             Removes a shortcut from home by ShortcutInfo.\r
474             </summary>\r
475             <since_tizen> 3 </since_tizen>\r
476             <param name="shortcut">Object that contain shortcut info.</param>\r
477             <feature>http://tizen.org/feature/shortcut</feature>\r
478             <privilege>http://tizen.org/privilege/shortcut</privilege>\r
479             <exception cref="T:System.ArgumentException">Thrown when argument is invalid.</exception>\r
480             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of permission denied.</exception>\r
481             <exception cref="T:System.NotSupportedException">Thrown when Shortcut is not supported.</exception>\r
482             <exception cref="T:System.OutOfMemoryException">Thrown in case of out of memory.</exception>\r
483             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
484         </member>\r
485         <member name="T:Tizen.Applications.Shortcut.WidgetShortcutInfo">\r
486             <summary>\r
487             A class that contains information about the widget.\r
488             </summary>\r
489         </member>\r
490         <member name="P:Tizen.Applications.Shortcut.WidgetShortcutInfo.WidgetId">\r
491             <summary>\r
492             Gets or sets the Widget ID.\r
493             </summary>\r
494         </member>\r
495         <member name="P:Tizen.Applications.Shortcut.WidgetShortcutInfo.WidgetSize">\r
496             <summary>\r
497             Gets or sets the size of widget.\r
498             </summary>\r
499         </member>\r
500         <member name="P:Tizen.Applications.Shortcut.WidgetShortcutInfo.Period">\r
501             <summary>\r
502             Gets or sets the Update period in seconds.\r
503             </summary>\r
504         </member>\r
505     </members>\r
506 </doc>\r