169
edits
CloudServices/Notifications/Specification: Difference between revisions
CloudServices/Notifications/Specification (view source)
Revision as of 22:01, 16 February 2011
, 16 February 2011→Desired User Flow
| Line 34: | Line 34: | ||
* '''Simple Client Implementation''': Third-party developers ''SHOULD'' be able to implement a notification client with relatively little effort. | * '''Simple Client Implementation''': Third-party developers ''SHOULD'' be able to implement a notification client with relatively little effort. | ||
= | = Use Cases = | ||
== User Use Cases == | |||
The following is a high-level overview of the | |||
# User visits web site | # User visits web site | ||
| Line 41: | Line 45: | ||
## User says yes: | ## User says yes: | ||
### TODO | ### TODO | ||
== Web App Use Cases == | |||
=== Send a Notification === | |||
The web app is able to send a message (i.e. the notification) to a specific user using a '''routing key''' that was given to it by the user's client. The routing key can be thought of as an address that specifies the destination "mailbox" of the message. The process from the point of view of the web app is as follows: | |||
# Web app creates a JSON string of the following form: | |||
#* <pre>{"routing-key": "mailbox identifier", "type": "message type", "timestamp": "unix timestamp in seconds", "payload": "the message contents"}</pre> | |||
# Web app POSTs the JSON object to agent. | |||
= Implementation = | = Implementation = | ||