Options
All
  • Public
  • Public/Protected
  • All
Menu

Alarm

Alarms are alerts which can be attached to Reminder and Event objects.

Examples

let list = ReminderList.findOrCreate("Errands");
let reminder = list.createReminder();
reminder.title = "Get more paper towels";

let alarm = Alarm.alarmWithDate((3).days().fromNow());
reminder.addAlarm(alarm);
reminder.update();

Hierarchy

  • Alarm

Index

Methods

Static alarmWithDate

  • alarmWithDate(date: Date): Alarm
  • Alarm set to remind at a specific date/time.

    Parameters

    • date: Date

    Returns Alarm

Static alarmWithOffset

  • alarmWithOffset(seconds: Number): Alarm
  • Alarm set to remind at a specific number of seconds relative to the start date of the event. Note that alarms created with this methods are only supported on Event objects, not Reminder objects.

    Parameters

    • seconds: Number

    Returns Alarm

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc