diff --git a/ForumApp.markdown b/ForumApp.markdown index 2fc894e..4931aa5 100644 --- a/ForumApp.markdown +++ b/ForumApp.markdown @@ -1,4 +1,4 @@ -ForumApp is a [BSP application](BSP) that synchronises forum posts among groups of devices. Any member of a forum can invite non-members to join, and any member can write posts. +ForumApp is a [BSP application](BSP) that synchronises forum posts among groups of devices. Any subscriber to a forum can invite new subscribers, and any subscriber can post to the forum. ### Channel identifiers @@ -14,7 +14,7 @@ The application identifer is random: **0: INVITATION** - The content is a BDF list with three elements: `forum` (list) and `note` (string, may be null). `forum` is a list with two elements, `name` and `salt`, as described above. `note` is an optional note from the inviter to the invitee. -**1: RESPONSE** - The content is a BDF list with three elements: `invitation_id` (raw), `decision` (boolean), and `note` (string, may be null). `invitation_id` is the identifier of an invitation created by the opposite peer. `decision` indicates whether the invitee wishes to join the forum. `note` is an optional note from the invitee to the inviter. +**1: RESPONSE** - The content is a BDF list with three elements: `invitation_id` (raw), `decision` (boolean), and `note` (string, may be null). `invitation_id` is the identifier of an invitation created by the opposite peer. `decision` indicates whether the invitee wishes to subscribe. `note` is an optional note from the invitee to the inviter. **2: DEPARTURE** - The content is a BDF list with one element: `invitation_id` (raw), which is the identifier of an invitation created by either peer. @@ -43,8 +43,8 @@ For the invitation channel: * All remote messages are stored. For forum channels: -* Local messages are stored while the local peer belongs to the forum. -* Remote messages are stored while the local peer belongs to the forum. +* Local messages are stored while the local peer subscribes to the forum. +* Remote messages are stored while the local peer subscribes to the forum. ### Sharing policy @@ -53,5 +53,5 @@ For the invitation channel: * Each remote message is shared with the remote peer that created it. For forum channels: -* Local messages are shared with all remote peers that belong to the forum. -* Remote messages are shared with all remote peers that belong to the forum. +* Local messages are shared with all remote peers that subscribe to the forum. +* Remote messages are shared with all remote peers that subscribe to the forum.