Artifacts/bin/public/Tizen.Applications.WidgetControl.xml

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