Artifacts/bin/Tizen.Applications.WidgetControl.xml

   1 <?xml version="1.0"?>
   2 <doc>
   3     <assembly>
   4         <name>Tizen.Applications.WidgetControl</name>
   5     </assembly>
   6     <members>
   7         <member name="T:Tizen.Applications.WidgetControl">
   8             <summary>
   9             The class for receiving widget events and sending data to the widget.
  10             </summary>
  11         </member>
  12         <member name="T:Tizen.Applications.WidgetControl.Instance">
  13             <summary>
  14             Class for the widget instance.
  15             </summary>
  16         </member>
  17         <member name="P:Tizen.Applications.WidgetControl.Instance.Id">
  18             <summary>
  19             The widget ID.
  20             </summary>
  21             <since_tizen> 3 </since_tizen>
  22         </member>
  23         <member name="M:Tizen.Applications.WidgetControl.Instance.GetContent">
  24             <summary>
  25             Gets the widget content.
  26             </summary>
  27             <since_tizen> 3 </since_tizen>
  28             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
  29         </member>
  30         <member name="M:Tizen.Applications.WidgetControl.Instance.ChangeContent(Tizen.Applications.Bundle,System.Boolean)">
  31             <summary>
  32             Changes the content for the widget instance.
  33             </summary>
  34             <since_tizen> 3 </since_tizen>
  35             <param name="content">Content to be changed.</param>
  36             <param name="force"> True if you want to update your widget even if the provider is paused, otherwise false.</param>
  37             <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>
  38             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
  39             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
  40         </member>
  41         <member name="M:Tizen.Applications.WidgetControl.Instance.ChangePeriod(System.Double)">
  42             <summary>
  43             Changes the update period for the widget instance.
  44             </summary>
  45             <since_tizen> 3 </since_tizen>
  46             <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>
  47             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
  48             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
  49         </member>
  50         <member name="T:Tizen.Applications.WidgetControl.Scale">
  51             <summary>
  52             The class for the widget size information.
  53             </summary>
  54         </member>
  55         <member name="T:Tizen.Applications.WidgetControl.Scale.SizeType">
  56             <summary>
  57             Enumeration for the types of widget size.
  58             </summary>
  59             <since_tizen> 3 </since_tizen>
  60         </member>
  61         <member name="F:Tizen.Applications.WidgetControl.Scale.SizeType.Basic1x1">
  62             <summary>
  63             175x175 based on 720x1280 resolution.
  64             </summary>
  65         </member>
  66         <member name="F:Tizen.Applications.WidgetControl.Scale.SizeType.Basic2x1">
  67             <summary>
  68             354x175 based on 720x1280 resolution.
  69             </summary>
  70         </member>
  71         <member name="F:Tizen.Applications.WidgetControl.Scale.SizeType.Basic2x2">
  72             <summary>
  73             354x354 based on 720x1280 resolution.
  74             </summary>
  75         </member>
  76         <member name="F:Tizen.Applications.WidgetControl.Scale.SizeType.Basic4x1">
  77             <summary>
  78             712x175 based on 720x1280 resolution.
  79             </summary>
  80         </member>
  81         <member name="F:Tizen.Applications.WidgetControl.Scale.SizeType.Basic4x2">
  82             <summary>
  83             712x354 based on 720x1280 resolution.
  84             </summary>
  85         </member>
  86         <member name="F:Tizen.Applications.WidgetControl.Scale.SizeType.Basic4x3">
  87             <summary>
  88             712x533 based on 720x1280 resolution.
  89             </summary>
  90         </member>
  91         <member name="F:Tizen.Applications.WidgetControl.Scale.SizeType.Basic4x4">
  92             <summary>
  93             712x712 based on 720x1280 resolution.
  94             </summary>
  95         </member>
  96         <member name="F:Tizen.Applications.WidgetControl.Scale.SizeType.Basic4x5">
  97             <summary>
  98             712x891 based on 720x1280 resolution.
  99             </summary>
 100         </member>
 101         <member name="F:Tizen.Applications.WidgetControl.Scale.SizeType.Basic4x6">
 102             <summary>
 103             712x1070 based on 720x1280 resolution.
 104             </summary>
 105         </member>
 106         <member name="F:Tizen.Applications.WidgetControl.Scale.SizeType.Easy1x1">
 107             <summary>
 108             224x215 based on 720x1280 resolution.
 109             </summary>
 110         </member>
 111         <member name="F:Tizen.Applications.WidgetControl.Scale.SizeType.Easy1x2">
 112             <summary>
 113             680x215 based on 720x1280 resolution.
 114             </summary>
 115         </member>
 116         <member name="F:Tizen.Applications.WidgetControl.Scale.SizeType.Easy1x3">
 117             <summary>
 118             680x653 based on 720x1280 resolution.
 119             </summary>
 120         </member>
 121         <member name="F:Tizen.Applications.WidgetControl.Scale.SizeType.Full">
 122             <summary>
 123             720x1280 based on 720x1280 resolution.
 124             </summary>
 125         </member>
 126         <member name="P:Tizen.Applications.WidgetControl.Scale.Width">
 127             <summary>
 128             Widget width.
 129             </summary>
 130             <since_tizen> 3 </since_tizen>
 131         </member>
 132         <member name="P:Tizen.Applications.WidgetControl.Scale.Height">
 133              <summary>
 134             Widget height.
 135              </summary>
 136              <since_tizen> 3 </since_tizen>
 137         </member>
 138         <member name="P:Tizen.Applications.WidgetControl.Scale.PreviewImagePath">
 139             <summary>
 140             The path for the widget preview image file.
 141             </summary>
 142             <since_tizen> 3 </since_tizen>
 143         </member>
 144         <member name="P:Tizen.Applications.WidgetControl.Scale.Type">
 145             <summary>
 146             The size type of the widget.
 147             </summary>
 148             <since_tizen> 3 </since_tizen>
 149         </member>
 150         <member name="M:Tizen.Applications.WidgetControl.CreateAll(System.String)">
 151             <summary>
 152             Factory method for the WidgetControl.
 153             It will create all the objects of WidgetControl based on the package ID.
 154             </summary>
 155             <since_tizen> 3 </since_tizen>
 156             <param name="pkgId">Package ID.</param>
 157             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
 158             <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>
 159             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
 160             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
 161         </member>
 162         <member name="M:Tizen.Applications.WidgetControl.GetWidgetIds(System.String)">
 163             <summary>
 164             Gets all the widget IDs by the package ID.
 165             </summary>
 166             <since_tizen> 3 </since_tizen>
 167             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
 168             <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid argument.</exception>
 169             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
 170             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
 171         </member>
 172         <member name="P:Tizen.Applications.WidgetControl.Id">
 173             <summary>
 174             The widget ID.
 175             </summary>
 176             <since_tizen> 3 </since_tizen>
 177         </member>
 178         <member name="P:Tizen.Applications.WidgetControl.IsNoDisplay">
 179             <summary>
 180             The flag value for "nodisplay".
 181             </summary>
 182             <since_tizen> 3 </since_tizen>
 183             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
 184         </member>
 185         <member name="E:Tizen.Applications.WidgetControl.Created">
 186             <summary>
 187              The event handler for a created widget instance.
 188             </summary>
 189             <since_tizen> 3 </since_tizen>
 190             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
 191             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
 192         </member>
 193         <member name="E:Tizen.Applications.WidgetControl.Resumed">
 194             <summary>
 195             The event handler for a resumed widget instance.
 196             </summary>
 197             <since_tizen> 3 </since_tizen>
 198             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
 199             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
 200         </member>
 201         <member name="E:Tizen.Applications.WidgetControl.Paused">
 202             <summary>
 203             The event handler for a paused widget instance.
 204             </summary>
 205             <since_tizen> 3 </since_tizen>
 206             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
 207             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
 208         </member>
 209         <member name="E:Tizen.Applications.WidgetControl.Destroyed">
 210             <summary>
 211             The event handler for a destroyed widget instance.
 212             </summary>
 213             <since_tizen> 3 </since_tizen>
 214             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
 215             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
 216         </member>
 217         <member name="M:Tizen.Applications.WidgetControl.#ctor(System.String)">
 218             <summary>
 219             The constructor of the WidgetControl object.
 220             </summary>
 221             <since_tizen> 3 </since_tizen>
 222             <param name="widgetId">Widget ID.</param>
 223         </member>
 224         <member name="M:Tizen.Applications.WidgetControl.Finalize">
 225             <summary>
 226             Finalizer of the WidgetControl class.
 227             </summary>
 228         </member>
 229         <member name="M:Tizen.Applications.WidgetControl.GetInstances">
 230             <summary>
 231             Gets the objects for widget instance information.
 232             </summary>
 233             <since_tizen> 3 </since_tizen>
 234             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
 235             <exception cref="T:System.NotSupportedException">Thrown when the API is not supported in this device.</exception>
 236             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
 237         </member>
 238         <member name="M:Tizen.Applications.WidgetControl.GetScales">
 239             <summary>
 240             Gets the objects for widget scale information.
 241             </summary>
 242             <since_tizen> 3 </since_tizen>
 243             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
 244             <exception cref="T:System.InvalidOperationException">Thrown in case of failed conditions.</exception>
 245             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have the privilege to access this method.</exception>
 246         </member>
 247         <member name="M:Tizen.Applications.WidgetControl.GetName(System.String)">
 248             <summary>
 249             Gets the widget name.
 250             </summary>
 251             <since_tizen> 3 </since_tizen>
 252             <param name="lang">Language.</param>
 253             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
 254             <exception cref="T:System.ArgumentNullException">Thrown when the argument is null.</exception>
 255         </member>
 256         <member name="M:Tizen.Applications.WidgetControl.GetIconPath(System.String)">
 257             <summary>
 258             Gets the widget icon path.
 259             </summary>
 260             <since_tizen> 3 </since_tizen>
 261             <param name="lang">Language.</param>
 262             <privilege>http://tizen.org/privilege/widget.viewer</privilege>
 263             <exception cref="T:System.ArgumentNullException">Thrown when the argument is null.</exception>
 264         </member>
 265         <member name="M:Tizen.Applications.WidgetControl.Dispose">
 266             <summary>
 267             Releases all the resources used by the WidgetControl class.
 268             </summary>
 269             <since_tizen> 3 </since_tizen>
 270         </member>
 271         <member name="T:Tizen.Applications.WidgetLifecycleEventArgs">
 272             <summary>
 273             The class for event arguments of the widget lifecycle.
 274             </summary>
 275         </member>
 276         <member name="T:Tizen.Applications.WidgetLifecycleEventArgs.EventType">
 277             <summary>
 278             Enumeration for the event type.
 279             </summary>
 280         </member>
 281         <member name="F:Tizen.Applications.WidgetLifecycleEventArgs.EventType.Created">
 282             <summary>
 283             The widget is created.
 284             </summary>
 285         </member>
 286         <member name="F:Tizen.Applications.WidgetLifecycleEventArgs.EventType.Destroyed">
 287             <summary>
 288             The widget is destroyed.
 289             </summary>
 290         </member>
 291         <member name="F:Tizen.Applications.WidgetLifecycleEventArgs.EventType.Paused">
 292             <summary>
 293             The widget is paused.
 294             </summary>
 295         </member>
 296         <member name="F:Tizen.Applications.WidgetLifecycleEventArgs.EventType.Resumed">
 297             <summary>
 298             The widget is resumed.
 299             </summary>
 300         </member>
 301         <member name="P:Tizen.Applications.WidgetLifecycleEventArgs.WidgetId">
 302             <summary>
 303              The widget ID.
 304             </summary>
 305         </member>
 306         <member name="P:Tizen.Applications.WidgetLifecycleEventArgs.InstanceId">
 307             <summary>
 308             The widget instance ID.
 309             </summary>
 310         </member>
 311         <member name="P:Tizen.Applications.WidgetLifecycleEventArgs.Type">
 312             <summary>
 313             The event type.
 314             </summary>
 315         </member>
 316     </members>
 317 </doc>