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

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Tizen.Applications.WatchApplication</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="T:Tizen.Applications.CoreBackend.WatchEventType">\r
   8             <summary>\r
   9             Class that represents the type of event for backends. This class can be converted from string type.\r
  10             </summary>\r
  11         </member>\r
  12         <member name="F:Tizen.Applications.CoreBackend.WatchEventType.TimeTick">\r
  13             <summary>\r
  14             Pre-defined event type. "Created"\r
  15             </summary>\r
  16         </member>\r
  17         <member name="F:Tizen.Applications.CoreBackend.WatchEventType.AmbientTick">\r
  18             <summary>\r
  19             Pre-defined event type. "AmbientTick"\r
  20             </summary>\r
  21         </member>\r
  22         <member name="F:Tizen.Applications.CoreBackend.WatchEventType.AmbientChanged">\r
  23             <summary>\r
  24             Pre-defined event type. "AmbientChanged"\r
  25             </summary>\r
  26         </member>\r
  27         <member name="M:Tizen.Applications.CoreBackend.WatchEventType.#ctor(System.String)">\r
  28             <summary>\r
  29             Initializes the WatchEventType class.\r
  30             </summary>\r
  31             <param name="name">The name of watch event type.</param>\r
  32         </member>\r
  33         <member name="M:Tizen.Applications.CoreBackend.WatchEventType.op_Implicit(System.String)~Tizen.Applications.CoreBackend.WatchEventType">\r
  34             <summary>\r
  35             Converts a string to WatchEventType instance.\r
  36             </summary>\r
  37         </member>\r
  38         <member name="T:Tizen.Applications.AmbientEventArgs">\r
  39             <summary>\r
  40             Arguments for the event that reaised when the device enters or exits the ambient mode.\r
  41             </summary>\r
  42         </member>\r
  43         <member name="P:Tizen.Applications.AmbientEventArgs.Enabled">\r
  44             <summary>\r
  45             The received Ambient mode\r
  46             </summary>\r
  47         </member>\r
  48         <member name="T:Tizen.Applications.AmbientTickType">\r
  49             <summary>\r
  50             Enumeration for Ambient tick type.\r
  51             </summary>\r
  52         </member>\r
  53         <member name="F:Tizen.Applications.AmbientTickType.NoTick">\r
  54             <summary>\r
  55             No peridoic ambient tick.\r
  56             </summary>\r
  57         </member>\r
  58         <member name="F:Tizen.Applications.AmbientTickType.EveryMinute">\r
  59             <summary>\r
  60             Every minute.\r
  61             </summary>\r
  62         </member>\r
  63         <member name="F:Tizen.Applications.AmbientTickType.EveryFiveMinutes">\r
  64             <summary>\r
  65             Every 5 minutes.\r
  66             </summary>\r
  67         </member>\r
  68         <member name="F:Tizen.Applications.AmbientTickType.EveryFiftenMinutes">\r
  69             <summary>\r
  70             Every 15 minutes.\r
  71             </summary>\r
  72         </member>\r
  73         <member name="F:Tizen.Applications.AmbientTickType.EveryThirtyMinutes">\r
  74             <summary>\r
  75             Every 30 minutes.\r
  76             </summary>\r
  77         </member>\r
  78         <member name="F:Tizen.Applications.AmbientTickType.EveryHour">\r
  79             <summary>\r
  80             Every hour.\r
  81             </summary>\r
  82         </member>\r
  83         <member name="F:Tizen.Applications.AmbientTickType.EveryThreeHours">\r
  84             <summary>\r
  85             Every 3 hours.\r
  86             </summary>\r
  87         </member>\r
  88         <member name="F:Tizen.Applications.AmbientTickType.EverySixHours">\r
  89             <summary>\r
  90             Every 6 hours.\r
  91             </summary>\r
  92         </member>\r
  93         <member name="F:Tizen.Applications.AmbientTickType.EveryTwelveHours">\r
  94             <summary>\r
  95             Every 12 hours.\r
  96             </summary>\r
  97         </member>\r
  98         <member name="F:Tizen.Applications.AmbientTickType.EveryDay">\r
  99             <summary>\r
 100             Every day.\r
 101             </summary>\r
 102         </member>\r
 103         <member name="T:Tizen.Applications.TimeEventArgs">\r
 104             <summary>\r
 105             Arguments for the event that reaised when the time tick comes.\r
 106             </summary>\r
 107         </member>\r
 108         <member name="P:Tizen.Applications.TimeEventArgs.Time">\r
 109             <summary>\r
 110             The received WatchTime.\r
 111             </summary>\r
 112         </member>\r
 113         <member name="T:Tizen.Applications.TimeTickResolution">\r
 114             <summary>\r
 115             Enumeration for Time tick resolution.\r
 116             </summary>\r
 117         </member>\r
 118         <member name="F:Tizen.Applications.TimeTickResolution.TimeTicksPerSecond">\r
 119             <summary>\r
 120             1 ~ 60 ticks per second.\r
 121             </summary>\r
 122         </member>\r
 123         <member name="F:Tizen.Applications.TimeTickResolution.TimeTicksPerMinute">\r
 124             <summary>\r
 125             1 ~ 60 ticks per minute.\r
 126             </summary>\r
 127         </member>\r
 128         <member name="F:Tizen.Applications.TimeTickResolution.TimeTicksPerHour">\r
 129             <summary>\r
 130             1 ~ 60 ticks per hour.\r
 131             </summary>\r
 132         </member>\r
 133         <member name="T:Tizen.Applications.WatchApplication">\r
 134             <summary>\r
 135             The class that represents a Tizen watch application.\r
 136             </summary>\r
 137         </member>\r
 138         <member name="M:Tizen.Applications.WatchApplication.#ctor">\r
 139             <summary>\r
 140             Initialize the WatchApplication class\r
 141             </summary>\r
 142             <remarks>\r
 143             Default backend for Watch application will be used.\r
 144             </remarks>\r
 145         </member>\r
 146         <member name="M:Tizen.Applications.WatchApplication.#ctor(Tizen.Applications.CoreBackend.ICoreBackend)">\r
 147             <summary>\r
 148             Initialize the WatchApplication class\r
 149             </summary>\r
 150             <remarks>\r
 151             If want to change the backend , use this constructor\r
 152             </remarks>\r
 153             <param name="backend">The backend instance implementing ICoreBackend interface.</param>\r
 154         </member>\r
 155         <member name="F:Tizen.Applications.WatchApplication.Window">\r
 156             <summary>\r
 157             Instance for the window\r
 158             </summary>\r
 159         </member>\r
 160         <member name="E:Tizen.Applications.WatchApplication.Resumed">\r
 161             <summary>\r
 162             Occurs whenever the application is resumed.\r
 163             </summary>\r
 164         </member>\r
 165         <member name="E:Tizen.Applications.WatchApplication.Paused">\r
 166             <summary>\r
 167             Occurs whenever the application is paused.\r
 168             </summary>\r
 169         </member>\r
 170         <member name="E:Tizen.Applications.WatchApplication.TimeTick">\r
 171             <summary>\r
 172             Occurs whenever the time tick comes.\r
 173             </summary>\r
 174         </member>\r
 175         <member name="E:Tizen.Applications.WatchApplication.AmbientTick">\r
 176             <summary>\r
 177             Occurs whenever the time tick comes in ambient mode.\r
 178             </summary>\r
 179         </member>\r
 180         <member name="E:Tizen.Applications.WatchApplication.AmbientChanged">\r
 181             <summary>\r
 182             Occurs when the ambient mode is changed.\r
 183             </summary>\r
 184         </member>\r
 185         <member name="M:Tizen.Applications.WatchApplication.Run(System.String[])">\r
 186             <summary>\r
 187             Runs the UI applications' main loop.\r
 188             </summary>\r
 189             <param name="args">Arguments from commandline.</param>\r
 190         </member>\r
 191         <member name="M:Tizen.Applications.WatchApplication.OnCreate">\r
 192             <summary>\r
 193             Overrides this method if want to handle behavior when the application is launched.\r
 194             If base.OnCreate() is not called, the event 'Created' will not be emitted.\r
 195             </summary>\r
 196         </member>\r
 197         <member name="M:Tizen.Applications.WatchApplication.OnResume">\r
 198             <summary>\r
 199             Overrides this method if want to handle behavior when the application is resumed.\r
 200             If base.OnResume() is not called, the event 'Resumed' will not be emitted.\r
 201             </summary>\r
 202         </member>\r
 203         <member name="M:Tizen.Applications.WatchApplication.OnPause">\r
 204             <summary>\r
 205             Overrides this method if want to handle behavior when the application is paused.\r
 206             If base.OnPause() is not called, the event 'Paused' will not be emitted.\r
 207             </summary>\r
 208         </member>\r
 209         <member name="M:Tizen.Applications.WatchApplication.OnTick(Tizen.Applications.TimeEventArgs)">\r
 210             <summary>\r
 211             Overrides this method if want to handle behavior when the time tick event comes.\r
 212             If base.OnTick() is not called, the event 'TimeTick' will not be emitted.\r
 213             </summary>\r
 214             <param name="time">The received TimeEventArgs to get time information.</param>\r
 215         </member>\r
 216         <member name="M:Tizen.Applications.WatchApplication.OnAmbientTick(Tizen.Applications.TimeEventArgs)">\r
 217             <summary>\r
 218             Overrides this method if want to handle behavior when the time tick event comes in ambient mode.\r
 219             If base.OnAmbientTick() is not called, the event 'AmbientTick' will not be emitted.\r
 220             </summary>\r
 221             <param name="time">The received TimeEventArgs to get time information.</param>\r
 222             <privilege>http://tizen.org/privilege/alarm.set</privilege>\r
 223         </member>\r
 224         <member name="M:Tizen.Applications.WatchApplication.OnAmbientChanged(Tizen.Applications.AmbientEventArgs)">\r
 225             <summary>\r
 226             Overrides this method if want to handle behavior when the ambient mode is changed.\r
 227             If base.OnAmbientChanged() is not called, the event 'AmbientChanged' will not be emitted.\r
 228             </summary>\r
 229             <param name="mode">The received AmbientEventArgs</param>\r
 230         </member>\r
 231         <member name="M:Tizen.Applications.WatchApplication.GetCurrentTime">\r
 232             <summary>\r
 233             Gets the current time\r
 234             </summary>\r
 235             <returns>WatchTime</returns>\r
 236             <exception cref="T:System.InvalidOperationException">Thrown when failed to get current time because of invalid parameter.</exception>\r
 237             <exception cref="T:System.OutOfMemoryException">Thrown when failed to get current time because memory is not enough.</exception>\r
 238             <example>\r
 239             <code>\r
 240             class MyApp : WatchApplication\r
 241             {\r
 242                 ...\r
 243                 public void TestMethod()\r
 244                 {\r
 245                     WatchTime wt;\r
 246                     try\r
 247                     {\r
 248                         wt = GetCurrentTime();\r
 249                     }\r
 250                     catch\r
 251                     {\r
 252                     }\r
 253                 }\r
 254             }\r
 255             </code>\r
 256             </example>\r
 257         </member>\r
 258         <member name="M:Tizen.Applications.WatchApplication.GetAmbientTickType">\r
 259             <summary>\r
 260             Gets the type of periodic ambient tick.\r
 261             </summary>\r
 262             <returns>AmbientTickType</returns>\r
 263             <exception cref="T:System.InvalidOperationException">Thrown when failed to get ambient tick type.</exception>\r
 264             <example>\r
 265             <code>\r
 266             class MyApp : WatchApplication\r
 267             {\r
 268                 ...\r
 269                 public void TestMethod()\r
 270                 {\r
 271                     AmbientTickType atType;\r
 272                     try\r
 273                     {\r
 274                         atType = GetAmbientTickType();\r
 275                     }\r
 276                     catch\r
 277                     {\r
 278                     }\r
 279                 }\r
 280             }\r
 281             </code>\r
 282             </example>\r
 283         </member>\r
 284         <member name="M:Tizen.Applications.WatchApplication.SetAmbientTickType(Tizen.Applications.AmbientTickType)">\r
 285             <summary>\r
 286             Sets the type of periodic ambient tick.\r
 287             OnAmbientTick will be called following settings.\r
 288             If SetAmbientTickType is not called, OnAmbientTick will be called every minute.\r
 289             </summary>\r
 290             <param name="ambientTickType">the type of ambient tick</param>\r
 291             <exception cref="T:System.InvalidOperationException">Thrown when failed to set ambient tick type.</exception>\r
 292             <example>\r
 293             <code>\r
 294             class MyApp : WatchApplication\r
 295             {\r
 296                 ...\r
 297                 public void TestMethod()\r
 298                 {\r
 299                     try\r
 300                     {\r
 301                         SetAmbientTickType(AmbientTickType.EveryMinute);\r
 302                     }\r
 303                     catch\r
 304                     {\r
 305                     }\r
 306                 }\r
 307             }\r
 308             </code>\r
 309             </example>\r
 310         </member>\r
 311         <member name="M:Tizen.Applications.WatchApplication.SetTimeTickFrequency(System.Int32,Tizen.Applications.TimeTickResolution)">\r
 312             <summary>\r
 313             Sets the frequency of time tick.\r
 314             OnTick will be called following settings.\r
 315             If SetTimeTickFrequency is not called, OnTick will be called every second.\r
 316             </summary>\r
 317             <param name="ticks">Ticks the number of ticks per given resolution type</param>\r
 318             <param name="type">Type of the resolution type</param>\r
 319             <exception cref="T:System.InvalidOperationException">Thrown when failed to set time tick frequency.</exception>\r
 320             <example>\r
 321             <code>\r
 322             class MyApp : WatchApplication\r
 323             {\r
 324                 ...\r
 325                 public void TestMethod()\r
 326                 {\r
 327                     try\r
 328                     {\r
 329                         SetTimeTickFrequency(1, TimeTickResolution.TimeTicksPerMinute);\r
 330                     }\r
 331                     catch\r
 332                     {\r
 333                     }\r
 334                 }\r
 335             }\r
 336             </code>\r
 337             </example>\r
 338         </member>\r
 339         <member name="M:Tizen.Applications.WatchApplication.GetTimeTickFrequency(System.Int32@,Tizen.Applications.TimeTickResolution@)">\r
 340             <summary>\r
 341             Gets the frequency fo time tick.\r
 342             </summary>\r
 343             <param name="ticks">Ticks the number of ticks per given resolution type</param>\r
 344             <param name="type">Type of the resolution type</param>\r
 345             <exception cref="T:System.InvalidOperationException">Thrown when failed to get time tick frequency.</exception>\r
 346             <example>\r
 347             <code>\r
 348             class MyApp : WatchApplication\r
 349             {\r
 350                 ...\r
 351                 public void TestMethod()\r
 352                 {\r
 353                     int tick;\r
 354                     TimeTickResolution tType;\r
 355                     try\r
 356                     {\r
 357                         GetTimeTickFrequency(out tick, out tType);\r
 358                     }\r
 359                     catch\r
 360                     {\r
 361                     }\r
 362                 }\r
 363             }\r
 364             </code>\r
 365             </example>\r
 366         </member>\r
 367         <member name="T:Tizen.Applications.WatchTime">\r
 368             <summary>\r
 369             The information of Watch Time\r
 370             </summary>\r
 371         </member>\r
 372         <member name="P:Tizen.Applications.WatchTime.Year">\r
 373             <summary>\r
 374             The information of year\r
 375             </summary>\r
 376         </member>\r
 377         <member name="P:Tizen.Applications.WatchTime.Month">\r
 378             <summary>\r
 379             The information fo month\r
 380             </summary>\r
 381         </member>\r
 382         <member name="P:Tizen.Applications.WatchTime.Day">\r
 383             <summary>\r
 384             The information of day\r
 385             </summary>\r
 386         </member>\r
 387         <member name="P:Tizen.Applications.WatchTime.DayOfWeek">\r
 388             <summary>\r
 389             The information of day of week\r
 390             </summary>\r
 391         </member>\r
 392         <member name="P:Tizen.Applications.WatchTime.Hour">\r
 393             <summary>\r
 394             The information of hour\r
 395             </summary>\r
 396         </member>\r
 397         <member name="P:Tizen.Applications.WatchTime.Hour24">\r
 398             <summary>\r
 399             The information of hour for 24 hour form\r
 400             </summary>\r
 401         </member>\r
 402         <member name="P:Tizen.Applications.WatchTime.Minute">\r
 403             <summary>\r
 404             The information of Minute\r
 405             </summary>\r
 406         </member>\r
 407         <member name="P:Tizen.Applications.WatchTime.Second">\r
 408             <summary>\r
 409             The information of second\r
 410             </summary>\r
 411         </member>\r
 412         <member name="P:Tizen.Applications.WatchTime.Millisecond">\r
 413             <summary>\r
 414             The information of millisecond\r
 415             </summary>\r
 416         </member>\r
 417         <member name="P:Tizen.Applications.WatchTime.TimeZone">\r
 418             <summary>\r
 419             The information of timezone\r
 420             </summary>\r
 421         </member>\r
 422         <member name="P:Tizen.Applications.WatchTime.UtcTimestamp">\r
 423             <summary>\r
 424             The information of UTC time stamp\r
 425             </summary>\r
 426         </member>\r
 427     </members>\r
 428 </doc>\r