Skip to content

D. Actions

Matthew Campbell edited this page Jan 22, 2017 · 18 revisions

Services or actions as they are called in this project determine what can be done with things by the caller of this library. Services are grouped from the perspective of the end-user.

#Caretaker# A caretaker is the legal guardian of a child registered at a daycare. Only daycare staff can issue access to Prenotes. Once the caretaker has confirmed their email then they can notify, reply to notifications, retract notifications and stream notifications. They can also edit their name and even nuke their account.

##Confirmation## Daycare staff issue a confirmation code to caretakers. The expectation is that staff receive a caretaker's email address and then through Prenotes dole out a confirmation email. At least one child registered to the daycare must be associated to the caretaker in the confirmation step (i.e. the handshake). A caretaker registers for Prenotes by giving the confirmation code they will find in an automatic email sent out by Prenotes. During registration the caretaker could be asked to supply their name. Prenotes will not retain anything other than the caretaker's name in their profile. A caretaker may nuke their account. This will completely remove the caretaker from Prenotes except for notifications they have created. Nuking an account does not remove children from Prenotes. A caretaker must ask daycare staff to remove children from Prenotes.

##Streaming## Prenotes streams notifications to the end-user. There is no search function. The idea is that notifications surface in an infinite scroll by order creation time in descending order (i.e. the newest first). The ability to search might be added later. Prenotes acts like a fire hose giving the user the latest notifications upfront. A caretaker can create a notification by providing a message and the children related to the message. At least one child has to be related to a notification. Caretakers can retract a message. This doesn't delete the message rather excludes it from being streamed. Caretakers can also reply to notifications streamed to them.

Clone this wiki locally