Title here
Summary here
AbstractReminderService
AbstractReminderService ⇐ Abstract
Kind: global abstract class
Extends: Abstract
Service:
Properties
| Name | Type | Description |
|---|---|---|
| padding | number | Reminder padding duration (integer). |
- AbstractReminderService ⇐
Abstract- new AbstractReminderService()
- instance
- .newReminder(properties) ⇒
Reminder - .add(reminder, options) ⇒
Promise.<Reminder, Error> - .remove(reminder, options) ⇒
Promise.<Reminder, Error> - .update(reminder, options) ⇒
Promise.<Reminder, Error> - .find([reminderFilterFunction]) ⇒
Promise.<Array.<Reminder>, Error> - .getReminder(reminderId, [options]) ⇒
Promise.<Recording, Error> - .getReminders([options]) ⇒
Promise - ._onReminderBeforeStart(reminder) ⇒
Promise - ._onReminderStart(reminder) ⇒
Promise - ._onReminderAdd(reminder) ⇒
Promise - ._onReminderRemove(reminder) ⇒
Promise
- .newReminder(properties) ⇒
- static
- .STATE_WAIT :
number - .STATE_BEFORE_START :
number - .STATE_START :
number - .DEFAULT_PADDING :
number
- .STATE_WAIT :
AbstractReminderService()
A service to manage reminders, which are alarms that trigger actions
newReminder(properties) ⇒ Reminder
Create a new reminder model. Always prefer using these method instead of using new $Reminder(), as these method will always create the model with the right implementation.
Kind: instance method of AbstractReminderService
Returns: Reminder - The reminder model
| Param | Type | Description |
|---|---|---|
| properties | Object | The reminder properties |
add(reminder, options) ⇒ Promise.<Reminder, Error>
Add a new reminder to the reminders list (and from the resource where it is stored)
Kind: instance method of AbstractReminderService
Returns: Promise.<Reminder, Error> - A promise (reminder, error)
| Param | Type | Description |
|---|---|---|
| reminder | Reminder | The reminder to add |
| options | Object | options object |
| options.doNotRemovePastReminders | Boolean | => if true, do not remove the past reminders |
remove(reminder, options) ⇒ Promise.<Reminder, Error>
Delete a reminder from the reminders list (and from the resource where it is stored) If the reminder id is null or reminder not exist, return a rejected promise (an error).
Kind: instance method of AbstractReminderService
Returns: Promise.<Reminder, Error> - A promise (reminder, error)
| Param | Type | Description |
|---|---|---|
| reminder | Reminder | The reminder to delete |
| options | Object | options object |
| options.doNotRemovePastReminders | Boolean | => if true, do not remove the past reminders |
update(reminder, options) ⇒ Promise.<Reminder, Error>
Update a reminder (and from the resource where it is stored) If the reminder id is null or reminder not exist, return a rejected promise (an error).
Kind: instance method of AbstractReminderService
Returns: Promise.<Reminder, Error> - A promise (reminder, error)
| Param | Type | Description |
|---|---|---|
| reminder | Reminder | The reminder to update |
| options | Object | options object |
| options.doNotRemovePastReminders | Boolean | => if true, do not remove the past reminders |
find([reminderFilterFunction]) ⇒ Promise.<Array.<Reminder>, Error>
Find reminder(s) using a function as filter. Return all the reminders if reminderFilterFunction is null.
Kind: instance method of AbstractReminderService
Returns: Promise.<Array.<Reminder>, Error> - A promise (reminder
| Param | Type | Description |
|---|---|---|
| [reminderFilterFunction] | function | A function that takes a reminder in arg and return true or false (true mean keep reminder) |
getReminder(reminderId, [options]) ⇒ Promise.<Recording, Error>
Get the reminder referenced by it’s id
Kind: instance method of AbstractReminderService
Returns: Promise.<Recording, Error> - A promise (recording, error)
| Param | Type | Default | Description |
|---|---|---|---|
| reminderId | String | the id of the reminder to get | |
| [options] | Object | Additional options | |
| [options.force] | boolean | false | If true, renew the cache |
getReminders([options]) ⇒ Promise
Return all the reminders.
Kind: instance method of AbstractReminderService
| Param | Type | Default | Description |
|---|---|---|---|
| [options] | Object | Additional options | |
| [options.force] | boolean | false | If true, renew the cache |
_onReminderBeforeStart(reminder) ⇒ Promise
Fired when the before reminder start (padding)
Kind: instance method of AbstractReminderService
Access: protected
| Param | Type |
|---|---|
| reminder | Reminder |
_onReminderStart(reminder) ⇒ Promise
Fired when the reminder start
Kind: instance method of AbstractReminderService
Access: protected
| Param | Type |
|---|---|
| reminder | Reminder |
_onReminderAdd(reminder) ⇒ Promise
Fired when a reminder is added
Kind: instance method of AbstractReminderService
Access: protected
| Param | Type |
|---|---|
| reminder | Reminder |
_onReminderRemove(reminder) ⇒ Promise
Fired when a reminder is removed
Kind: instance method of AbstractReminderService
Access: protected
| Param | Type |
|---|---|
| reminder | Reminder |
STATE_WAIT : number
Kind: static constant of AbstractReminderService
STATE_BEFORE_START : number
Kind: static constant of AbstractReminderService
STATE_START : number
Kind: static constant of AbstractReminderService
DEFAULT_PADDING : number
Kind: static constant of AbstractReminderService