commit 0fb6f2c1af4afd9bbdae51051e5fe26d2fbe971e
parent 4162b8d944db3dc313b680460c654b11938460e9
Author: Jacki <jacki@thejackimonster.de>
Date: Mon, 14 Oct 2024 14:28:50 +0200
Cleanup sections in Messenger service
Signed-off-by: Jacki <jacki@thejackimonster.de>
Diffstat:
1 file changed, 13 insertions(+), 10 deletions(-)
diff --git a/developers/apis/messenger.rst b/developers/apis/messenger.rst
@@ -85,12 +85,15 @@ Finally, when an application no longer wants to use CADET, it should
call ``GNUNET_MESSENGER_disconnect``. You don't have to explicitly close
the used rooms or leave them.
+Messages
+^^^^^^^^
+
Here is a little summary to the kinds of messages you can send manually:
.. _NAME_002dmessage:
NAME-message
-^^^^^^^^^^^^
+------------
NAME-messages can be used to change the name (or nick) of your identity
inside a room. The selected name can differ from the identifier used to
@@ -99,7 +102,7 @@ select your private key for signing and decrypting messages.
.. _INVITE_002dmessage:
INVITE-message
-^^^^^^^^^^^^^^
+--------------
INVITE-messages can be used to invite other members in a room to a
different room, sharing one potential door and the required key to enter
@@ -111,7 +114,7 @@ doesn't specify its usage.
.. _TEXT_002dmessage:
TEXT-message
-^^^^^^^^^^^^
+------------
TEXT-messages can be used to send simple text-based messages and should
be considered as being in readable form without complex decoding. The
@@ -121,7 +124,7 @@ encoding for most compatibility.
.. _FILE_002dmessage:
FILE-message
-^^^^^^^^^^^^
+------------
FILE-messages can be used to share files inside of a room. They do not
contain the actual file being shared but its original hash, filename,
@@ -134,7 +137,7 @@ combination.
.. _DELETE_002dmessage:
DELETE-message
-^^^^^^^^^^^^^^
+--------------
DELETE-messages can be send via the separate function
``GNUNET_MESSENGER_delete_message`` which will handle linked deletions
@@ -154,7 +157,7 @@ information.
.. _TICKET_002dmessage:
TICKET-message
-^^^^^^^^^^^^^^
+--------------
TICKET-messages can be send privately to other members in the room. The
member will be able to consume the received ticket via
@@ -168,7 +171,7 @@ deletions inside the MESSENGER API.
.. _TAG_002dmessage:
TAG-message
-^^^^^^^^^^^
+-----------
TAG-messages can be used to tag or reject other messages in a
communicative way. Depending on the level of publication the message
@@ -197,7 +200,7 @@ TAG-message.
.. _SUBSCRIBE_002dmessage:
SUBSCRIBE-message
-^^^^^^^^^^^^^^^^^
+-----------------
SUBSCRIBE-messages can be used to subscribe to a selected discourse in
a room. With the ``GNUNET_MESSENGER_FLAG_SUBSCRIPTION_KEEP_ALIVE`` flag
@@ -215,7 +218,7 @@ a discourse. SUBSCRIBE-messages will not be stored locally.
.. _TALK_002dmessage:
TALK-message
-^^^^^^^^^^^^
+------------
TALK-messages can be send while subscribed to a selected discourse. The
messages can contain any sort of binary data. Applications need to work
@@ -229,7 +232,7 @@ locally.
.. _Member-sessions:
Member sessions
----------------
+^^^^^^^^^^^^^^^
A member session is a triple of the room key, the member ID and the
public key of the member's key pair. Member sessions allow that a member
