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

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Tizen.Applications.Alarm</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="T:Tizen.Applications.Alarm">\r
   8             <summary>\r
   9             The alarm API allows setting an "alarm clock" for the delivery of a notification at some point in the future.\r
  10             </summary>\r
  11             <example>\r
  12             <code>\r
  13             public class AlarmExample\r
  14             {\r
  15                 /// ...\r
  16                 IEnumerable &lt; Alarm &gt; alarms = AlarmManager.GetAllScheduledAlarms();\r
  17                 alarms[0].Cancel();\r
  18             }\r
  19             </code>\r
  20             </example>\r
  21         </member>\r
  22         <member name="M:Tizen.Applications.Alarm.#ctor(System.Int32)">\r
  23             <summary>\r
  24             Constructor created with the new AlarmId.\r
  25             </summary>\r
  26             <param name="id"></param>\r
  27         </member>\r
  28         <member name="P:Tizen.Applications.Alarm.AlarmId">\r
  29             <summary>\r
  30             The alarm ID uniquely identifies an alarm.\r
  31             </summary>\r
  32         </member>\r
  33         <member name="P:Tizen.Applications.Alarm.WeekFlag">\r
  34             <summary>\r
  35             Gets the recurrence days of the week.\r
  36             </summary>\r
  37             <privilege>http://tizen.org/privilege/alarm.get</privilege>\r
  38             <remarks>\r
  39             week_flag may be a combination of days, like Tuesday | Friday.\r
  40             </remarks>\r
  41         </member>\r
  42         <member name="P:Tizen.Applications.Alarm.ScheduledDate">\r
  43             <summary>\r
  44             Gets the scheduled time.\r
  45             </summary>\r
  46             <privilege>http://tizen.org/privilege/alarm.get</privilege>\r
  47         </member>\r
  48         <member name="P:Tizen.Applications.Alarm.Period">\r
  49             <summary>\r
  50             Gets the period of time between the recurrent alarms.\r
  51             </summary>\r
  52             <privilege>http://tizen.org/privilege/alarm.get</privilege>\r
  53         </member>\r
  54         <member name="P:Tizen.Applications.Alarm.AlarmAppControl">\r
  55             <summary>\r
  56             Gets the AppControl to be invoked when the the alarm is triggered.\r
  57             </summary>\r
  58             <privilege>http://tizen.org/privilege/alarm.get</privilege>\r
  59         </member>\r
  60         <member name="P:Tizen.Applications.Alarm.Global">\r
  61             <summary>\r
  62             Gets whether the alarm will launch global application or not.\r
  63             </summary>\r
  64             <privilege>http://tizen.org/privilege/alarm.set</privilege>\r
  65             <privilege>http://tizen.org/privilege/alarm.get</privilege>\r
  66         </member>\r
  67         <member name="M:Tizen.Applications.Alarm.Cancel">\r
  68             <summary>\r
  69             Cancels the specific alarm.\r
  70             </summary>\r
  71             <exception cref="T:System.ArgumentException">Thrown in case of an invalid parmaeter.</exception>\r
  72             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission denied due to insufficient privileges.</exception>\r
  73             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
  74             <privilege>http://tizen.org/privilege/alarm.set</privilege>\r
  75         </member>\r
  76         <member name="T:Tizen.Applications.AlarmWeekFlag">\r
  77             <summary>\r
  78             Enumeration for alarm week flag, the days of the week.\r
  79             </summary>\r
  80         </member>\r
  81         <member name="F:Tizen.Applications.AlarmWeekFlag.Sunday">\r
  82             <summary>\r
  83             An identifier for Sunday.\r
  84             </summary>\r
  85         </member>\r
  86         <member name="F:Tizen.Applications.AlarmWeekFlag.Monday">\r
  87             <summary>\r
  88             An identifier for Monday.\r
  89             </summary>\r
  90         </member>\r
  91         <member name="F:Tizen.Applications.AlarmWeekFlag.Tuesday">\r
  92             <summary>\r
  93             An identifier for Tuesday.\r
  94             </summary>\r
  95         </member>\r
  96         <member name="F:Tizen.Applications.AlarmWeekFlag.Wednesday">\r
  97             <summary>\r
  98             An identifier for Wednesday.\r
  99             </summary>\r
 100         </member>\r
 101         <member name="F:Tizen.Applications.AlarmWeekFlag.Thursday">\r
 102             <summary>\r
 103             An identifier for Thursday.\r
 104             </summary>\r
 105         </member>\r
 106         <member name="F:Tizen.Applications.AlarmWeekFlag.Friday">\r
 107             <summary>\r
 108             An identifier for Friday.\r
 109             </summary>\r
 110         </member>\r
 111         <member name="F:Tizen.Applications.AlarmWeekFlag.Saturday">\r
 112             <summary>\r
 113             An identifier for Saturday.\r
 114             </summary>\r
 115         </member>\r
 116         <member name="F:Tizen.Applications.AlarmWeekFlag.AllDays">\r
 117             <summary>\r
 118             All days of the week.\r
 119             </summary>\r
 120         </member>\r
 121         <member name="F:Tizen.Applications.AlarmWeekFlag.WeekDays">\r
 122             <summary>\r
 123             Only weekdays.\r
 124             </summary>\r
 125         </member>\r
 126         <member name="T:Tizen.Applications.AlarmManager">\r
 127             <summary>\r
 128             Mobile devices typically give constant access to information from various sources. Some of this information is best delivered through alarms.\r
 129             The most obvious case is a calendar scheduling application, which lets you know when a meeting is about to start. Alarms are certainly better than actively waiting in a loop.\r
 130             They are also better than putting an interface to sleep because they do not block your main UI thread.\r
 131             Use of alarms helps build smooth user experiences and implements unattended data synchronization tasks.\r
 132             If an application is installed after setting the alarm, your alarm is canceled automatically.\r
 133             </summary>\r
 134             <example>\r
 135             <code>\r
 136             public class AlarmManagerExample\r
 137             {\r
 138                 /// ...\r
 139                 Alarm alarm = AlarmManager.CreateAlarm(24000,1000,null);\r
 140                 AlarmManager.CancelAll();\r
 141             }\r
 142             </code>\r
 143             </example>\r
 144         </member>\r
 145         <member name="M:Tizen.Applications.AlarmManager.CreateAlarm(System.Int32,System.Int32,Tizen.Applications.AppControl)">\r
 146             <summary>\r
 147             Sets an alarm to be triggered after a specific time.\r
 148             The alarm will first go off delay seconds later and then will go off every certain amount of time defined using period seconds.\r
 149             </summary>\r
 150             <param name="delay">The amount of time before the first execution (in seconds).</param>\r
 151             <param name="period"> The amount of time between subsequent alarms (in seconds). This value does not guarantee the accuracy.\r
 152             The actual interval is calculated by the OS. The minimum value is 600sec.</param>\r
 153             <param name="appControl"> The destination AppControl is used to perform a specific task when the alarm is triggered. </param>\r
 154             <returns> An alarm instance is created with the set param values.</returns>\r
 155             <exception cref="T:System.ArgumentException">Thrown in case of an invalid parameter.</exception>\r
 156             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission denied.</exception>\r
 157             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
 158             <privilege>http://tizen.org/privilege/alarm.set</privilege>\r
 159         </member>\r
 160         <member name="M:Tizen.Applications.AlarmManager.CreateAlarm(System.Int32,Tizen.Applications.AppControl)">\r
 161             <summary>\r
 162             Sets an alarm to be triggered after a specific time.\r
 163             The alarm will go off delay seconds later.\r
 164             </summary>\r
 165             <param name="delay"> The amount of time before the execution (in seconds). </param>\r
 166             <param name="appControl"> The destination AppControl to perform a specific task when the alarm is triggered. </param>\r
 167             <returns> An alarm instance is created with the set param values.</returns>\r
 168             <exception cref="T:System.ArgumentException">Thrown in case of an invalid parameter.</exception>\r
 169             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission denied.</exception>\r
 170             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
 171             <privilege>http://tizen.org/privilege/alarm.set</privilege>\r
 172         </member>\r
 173         <member name="M:Tizen.Applications.AlarmManager.CreateAlarm(System.DateTime,Tizen.Applications.AppControl)">\r
 174             <summary>\r
 175             Sets an alarm to be triggered at a specific time.\r
 176             The date describes the time of the first occurrence.\r
 177             </summary>\r
 178             <param name="value"> The first active alarm time. </param>\r
 179             <param name="appControl"> The destination AppControl to perform specific work when the alarm is triggered. </param>\r
 180             <returns> An alarm instance is created with the set param values.</returns>\r
 181             <remarks>This operation is permitted with the UI application appcontrol only.</remarks>\r
 182             <exception cref="T:System.ArgumentException">Thrown in case of an invalid parameter.</exception>\r
 183             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission denied.</exception>\r
 184             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
 185             <privilege>http://tizen.org/privilege/alarm.set</privilege>\r
 186         </member>\r
 187         <member name="M:Tizen.Applications.AlarmManager.CreateAlarm(System.DateTime,Tizen.Applications.AlarmWeekFlag,Tizen.Applications.AppControl)">\r
 188             <summary>\r
 189             Sets an alarm to be triggered periodically, starting at a specific time.\r
 190             The date describes the time of the first occurrence.\r
 191             The weekFlag is the repeat value of the days of the week.\r
 192             If the weekFlag is AlarmWeekFlag.Tuesday, the alarm will repeat every Tuesday at a specific time.\r
 193             </summary>\r
 194             <remarks>This operation is permitted with UI application appcontrol only.</remarks>\r
 195             <param name="value"> The first active alarm time. </param>\r
 196             <param name="weekFlag"> The day of the week, AlarmWeekFlag may be a combination of days, like AlarmWeekFlag.Sunday | AlarmWeekFlag.Monday.</param>\r
 197             <param name="appControl"> The destination AppControl to perform specific work when the alarm is triggered. </param>\r
 198             <returns> An alarm instance is created with the set param values.</returns>\r
 199             <exception cref="T:System.ArgumentException">Thrown in case of an invalid parameter.</exception>\r
 200             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission denied.</exception>\r
 201             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
 202             <privilege>http://tizen.org/privilege/alarm.set</privilege>\r
 203         </member>\r
 204         <member name="M:Tizen.Applications.AlarmManager.CreateAlarm(System.DateTime,Tizen.Applications.Notifications.Notification)">\r
 205             <summary>\r
 206             Sets a notification alarm to be triggered at a specific time.\r
 207             The date describes the time of the first occurrence.\r
 208             </summary>\r
 209             <param name="dateTime"> The first active alarm time. </param>\r
 210             <param name="notification"> The notification to be posted when the alarm is triggered. </param>\r
 211             <returns> An alarm instance is created with the set param values.</returns>\r
 212             <exception cref="T:System.ArgumentException">Thrown in case of an invalid parameter.</exception>\r
 213             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission denied.</exception>\r
 214             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
 215             <privilege>http://tizen.org/privilege/alarm.set</privilege>\r
 216             <privilege>http://tizen.org/privilege/notification</privilege>\r
 217         </member>\r
 218         <member name="M:Tizen.Applications.AlarmManager.CreateAlarm(System.Int32,System.Int32,Tizen.Applications.Notifications.Notification)">\r
 219             <summary>\r
 220             Sets a notification alarm to be triggered after a specific time.\r
 221             The alarm will first go off delay seconds later and then will go off every certain amount of time defined using period seconds.\r
 222             </summary>\r
 223             <param name="delay">The amount of time before the first execution (in seconds). </param>\r
 224             <param name="period"> The amount of time between subsequent alarms (in seconds). This value does not guarantee the accuracy. </param>\r
 225             <param name="notification"> The notification to be posted when the alarm is triggered. </param>\r
 226             <returns> An alarm instance is created with the set param values.</returns>\r
 227             <exception cref="T:System.ArgumentException">Thrown in case of an invalid parameter.</exception>\r
 228             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission denied.</exception>\r
 229             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
 230             <privilege>http://tizen.org/privilege/alarm.set</privilege>\r
 231             <privilege>http://tizen.org/privilege/notification</privilege>\r
 232         </member>\r
 233         <member name="M:Tizen.Applications.AlarmManager.CreateAlarm(System.DateTime,Tizen.Applications.AlarmWeekFlag,Tizen.Applications.Notifications.Notification)">\r
 234             <summary>\r
 235             Sets a notification alarm to be triggered periodically, starting at a specific time.\r
 236             The date describes the time of the first occurrence.\r
 237             The weekFlag is the repeat value of the days of the week.\r
 238             If the weekFlag is AlarmWeekFlag.Tuesday, the alarm will repeat every Tuesday at a specific time.\r
 239             </summary>\r
 240             <param name="dateTime"> The first active alarm time. </param>\r
 241             <param name="weekFlag"> The day of the week, AlarmWeekFlag may be a combination of days,\r
 242                                     like AlarmWeekFlag.Sunday | AlarmWeekFlag.Monday.</param>\r
 243             <param name="notification"> The notification to be posted when the alarm is triggered. </param>\r
 244             <returns> An alarm instance is created with the set param values.</returns>\r
 245             <exception cref="T:System.ArgumentException">Thrown in case of an invalid parameter.</exception>\r
 246             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission denied.</exception>\r
 247             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
 248             <privilege>http://tizen.org/privilege/alarm.set</privilege>\r
 249             <privilege>http://tizen.org/privilege/notification</privilege>\r
 250         </member>\r
 251         <member name="M:Tizen.Applications.AlarmManager.CreateAlarm(System.Int32,Tizen.Applications.Notifications.Notification)">\r
 252             <summary>\r
 253             Sets a notification alarm to be triggered after a specific time.\r
 254             The alarm will go off delay seconds later.\r
 255             </summary>\r
 256             <param name="delay">The amount of time before the first execution (in seconds).</param>\r
 257             <param name="notification"> The notification to be posted when the alarm is triggered. </param>\r
 258             <returns> An alarm instance is created with the set param values.</returns>\r
 259             <exception cref="T:System.ArgumentException">Thrown in case of an invalid parameter.</exception>\r
 260             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission denied.</exception>\r
 261             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
 262             <privilege>http://tizen.org/privilege/alarm.set</privilege>\r
 263             <privilege>http://tizen.org/privilege/notification</privilege>\r
 264         </member>\r
 265         <member name="M:Tizen.Applications.AlarmManager.CancelAll">\r
 266             <summary>\r
 267             Cancels all scheduled alarms that are registered by the application that calls this API.\r
 268             </summary>\r
 269             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission denied.</exception>\r
 270             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
 271             <privilege>http://tizen.org/privilege/alarm.set</privilege>\r
 272         </member>\r
 273         <member name="M:Tizen.Applications.AlarmManager.GetAllScheduledAlarms">\r
 274             <summary>\r
 275             Retrieves all registered alarms.\r
 276             </summary>\r
 277             <returns>List of all alarm instances.</returns>\r
 278             <exception cref="T:System.UnauthorizedAccessException">Thrown in case of a permission denied.</exception>\r
 279             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
 280             <privilege>http://tizen.org/privilege/alarm.get</privilege>\r
 281         </member>\r
 282         <member name="M:Tizen.Applications.AlarmManager.GetCurrentTime">\r
 283             <summary>\r
 284             Gets the current system time.\r
 285             </summary>\r
 286             <returns>The current system time.</returns>\r
 287             <exception cref="T:System.InvalidOperationException">Thrown in case of any internal error.</exception>\r
 288         </member>\r
 289     </members>\r
 290 </doc>\r