diff --git a/inbox/notification-inbox.xml b/inbox/notification-inbox.xml new file mode 100644 index 00000000..654c0dfa --- /dev/null +++ b/inbox/notification-inbox.xml @@ -0,0 +1,176 @@ + + +%ents; +]> + + +
+ Notification Inbox + This document defines a protocol to manage a notification inbox for pending events. + &LEGALNOTICE; + 0298 + Experimental + Standards Track + Standards + + XMPP Core + + + + inbox + + + Valérian + Saliou + vanaryon@gmail.com + vanaryon@jappix.com + http://vanaryon.eu/ + + + 0.1 + 2011-05-06 + vs +

First draft.

 + +
+ + +

When interacting with an user, like replying to some comments or adding photo tags, this remote user has no way to get notifications of what happen about him. This specification defines a method for managing such notifications.

+ + + +

The user who will receive notifications MUST:

+ +

In order to get incoming notifications in real-time, the client MAY advertise support for "urn:xmpp:inbox+notify" in its &xep0115; data.

+

Clients that provide notifications inbox support MAY request all the "urn:xmpp:inbox" node items on the user's PEP service.

+ + + + +

If the event to notify is listed in the following array, the client MUST consider using the defined event type:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Type NameDefinition
commentThe sender replied to some comments.
likeThe sender liked an item.
quoteThe sender quoted the user in a post.
wallThe sender published an entry on the user's wall.
photoThe sender tagged the user in a photo.
videoThe sender tagged the user in a video.
+ + +

If Romeo wants to notify all the users who posted a comment in a comment node, his client MUST send a payload to every user's PEP node.

+

The notification type is stored in the "title" attribute of the "link" element, also containing the URI ("href" attribute) to the target item. The notification text content is stored in the "content" element.

+ + + + + + + + Romeo Montague + xmpp:romeo@montague.lit + + + May I bring my horse? + + 2011-05-06T13:31:51Z + + + + + + ]]> + + +

Juliet tagged Romeo in a photo. Romeo's client gets pushed of the new item:

+ + + + + + + + Juliet Capulet + xmpp:juliet@capulet.lit + + + Hiking with Romeo + + 2011-05-06T14:39:43Z + + + + + + ]]> + + +

Romeo viewed the last notification he received. His client now removes it (as defined in &xep0060;):

+ + + + + + + + ]]> + + +

Romeo wants to clear all the pending notifications. His client purges the "urn:xmpp:inbox" PEP node (as defined in &xep0060;):

+ + + + + + ]]> + + + +

The client SHOULD check that the author informations (provided in the "author" element) are valid, by checking that the "publisher" item attribute value matches the "uri" element value. If there is a difference, the notification MIGHT NOT be displayed, and the client SHOULD remove it (see the Removing a notification section of this document).

+ + +

This specification re-uses the schema for the Atom content format, i.e., the 'http://www.w3.org/2005/Atom' namespace (see RFC 4287).

+ + +

Thanks to Laurent Eschenauer for his initial idea.

+ +