diff --git a/enum-AlarmPeriod.md b/enum-AlarmPeriod.md new file mode 100644 index 0000000..acb18d4 --- /dev/null +++ b/enum-AlarmPeriod.md @@ -0,0 +1,35 @@ +The AlarmPeriod represents the common alarm intervals used. This can be used as the period argument for the AddAlarm() method. + +``` +enum AlarmPeriod +{ + AlarmPeriod_SingleFire, + AlarmPeriod_Yearly, + AlarmPeriod_Monthly, + AlarmPeriod_Monthly_LastDay, + AlarmPeriod_Weekly, + AlarmPeriod_Daily, + AlarmPeriod_Hourly +}; +``` + +### AlarmPeriod_SingleFire +The alarm will trigger once at the given date and time and then get removed. + +### AlarmPeriod_Yearly +The alarm will trigger once per year at the given date and time. If the first year, month, and day is a leap day in a leap year, it will honor this on subsequent leap years, but it will still trigger on Feb 28th on non-leap years. + +### AlarmPeriod_Monthly +The alarm will trigger once per month on the given day of the month and time. If the first day of the month is greater than a day of the month on subsequent months, then it will still trigger but on last day of that month. + +### AlarmPeriod_Monthly_LastDay +The alarm will trigger once per month on the last day of the month at the given time. + +### AlarmPeriod_Weekly +The alarm will trigger once per week on the same day of the week as the given date and time. + +### AlarmPeriod_Daily +The alarm will trigger once per day at the given time. + +### AlarmPeriod_Hourly +The alarm will trigger once per hour at the given minutes and seconds past the hour.