RemindersFacet

Kind: global class

• RemindersFacet
  • .add(text, time, [opts], [optCb])
  • .complete(reminder, [optCb])
  • .delete(reminder, [optCb])
  • .info(reminder, [optCb])
  • .list([optCb])

remindersFacet.add(text, time, [opts], [optCb])

Creates a reminder.

Kind: instance method of [RemindersFacet](#RemindersFacet)
See: reminders.add

Param	Type	Description
text	?	The content of the reminder
time	?	When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. “in 15 minutes,” or “every Thursday”)
[opts]	Object
opts.user	?	The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.
[optCb]	function	Optional callback, if not using promises.

remindersFacet.complete(reminder, [optCb])

Marks a reminder as complete.

Kind: instance method of [RemindersFacet](#RemindersFacet)
See: reminders.complete

Param	Type	Description
reminder	?	The ID of the reminder to be marked as complete
[optCb]	function	Optional callback, if not using promises.

remindersFacet.delete(reminder, [optCb])

Deletes a reminder.

Kind: instance method of [RemindersFacet](#RemindersFacet)
See: reminders.delete

Param	Type	Description
reminder	?	The ID of the reminder
[optCb]	function	Optional callback, if not using promises.

remindersFacet.info(reminder, [optCb])

Gets information about a reminder.

Kind: instance method of [RemindersFacet](#RemindersFacet)
See: reminders.info

Param	Type	Description
reminder	?	The ID of the reminder
[optCb]	function	Optional callback, if not using promises.

remindersFacet.list([optCb])

Lists all reminders created by or for a given user.

Kind: instance method of [RemindersFacet](#RemindersFacet)
See: reminders.list

Param	Type	Description
[optCb]	function	Optional callback, if not using promises.