Artifacts/bin/platform/Tizen.Applications.Shortcut.xml

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