From 98541ac38f8f41c68eabd07d0960e5f86aef16ad Mon Sep 17 00:00:00 2001 From: akwizgran Date: Thu, 22 Mar 2018 14:45:49 +0000 Subject: [PATCH] Update Forum Sharing Client --- Forum-Sharing-Client.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Forum-Sharing-Client.md b/Forum-Sharing-Client.md index fe333af..ba82a28 100644 --- a/Forum-Sharing-Client.md +++ b/Forum-Sharing-Client.md @@ -10,19 +10,19 @@ The client uses a separate BSP group for each pair of contacts. The [group descr The sharing protocol uses five message types. All communication happens between two contacts, who have symmetrical roles. The messages referring to each forum constitute a session. -**0: INVITE** - Sent by the inviter to the invitee. The message body is a BDF list with four elements: `messageType` (int), `previousMessageId` (unique ID or null), `descriptor` (list), and `message` (string or null). +**0: INVITE** - Sent by either party to start or restart a session. The message body is a BDF list with four elements: `messageType` (int), `previousMessageId` (unique ID or null), `descriptor` (list), and `message` (string or null). `previousMessageId` is the ID of the previous message in this session, if any. `descriptor` is the [descriptor of the forum](Forum-Client#group-identifiers) being shared. `message` is an optional message from the inviter to the invitee. The forum ID must be calculated from the descriptor, as it is used by subsequent messages in the session. -The inviter sets the forum's visibility to VISIBLE when sending an invite message. +The sender sets the forum's visibility to VISIBLE when sending an invite message. -**1: ACCEPT** - Sent by the invitee to the inviter in response to an invite. The message body is a BDF list with three elements: `messageType` (int), `forumId` (unique ID), and `previousMessageId` (unique ID). +**1: ACCEPT** - Sent in response to an invite. The message body is a BDF list with three elements: `messageType` (int), `forumId` (unique ID), and `previousMessageId` (unique ID). -The invitee sets the forum's visibility to SHARED when sending an accept message. The inviter sets the forum's visibility to SHARED when receiving an accept message. +The sender sets the forum's visibility to SHARED when sending an accept message. The recipient sets the forum's visibility to SHARED when receiving an accept message. -**2: DECLINE** - Sent by the invitee to the inviter in response to an invite. The message body is a BDF list with three elements: `messageType` (int), `forumId` (unique ID), and `previousMessageId` (unique ID). +**2: DECLINE** - Sent in response to an invite. The message body is a BDF list with three elements: `messageType` (int), `forumId` (unique ID), and `previousMessageId` (unique ID). -The inviter sets the forum's visibility to INVISIBLE when receiving a decline message. +The recipient sets the forum's visibility to INVISIBLE when receiving a decline message. **3: LEAVE** - Sent by either party when unsubscribing from the forum, if the forum's visibility is VISIBLE or SHARED. The message body is a BDF list with three elements: `messageType` (int), `forumId` (unique ID), and `previousMessageId` (unique ID).