diff mbox series

[v1] Doc: Obex Implement support for message listing format version 1.1

Message ID 20241220125927.84698-1-quic_amisjain@quicinc.com
State Superseded
Headers show
Series [v1] Doc: Obex Implement support for message listing format version 1.1 | expand

Commit Message

Amisha Jain (QUIC) Dec. 20, 2024, 12:59 p.m. UTC 
Add the documentation for the ‘Messages-Listing Format Version 1.1’
feature for MCE.

---
 doc/org.bluez.obex.Message.rst | 39 ++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

Comments

Luiz Augusto von Dentz Dec. 20, 2024, 3 p.m. UTC | #1 
Hi Amisha,

On Fri, Dec 20, 2024 at 7:59 AM Amisha Jain <quic_amisjain@quicinc.com> wrote:
>
> Add the documentation for the ‘Messages-Listing Format Version 1.1’
> feature for MCE.
>
> ---
>  doc/org.bluez.obex.Message.rst | 39 ++++++++++++++++++++++++++++++++++
>  1 file changed, 39 insertions(+)
>
> diff --git a/doc/org.bluez.obex.Message.rst b/doc/org.bluez.obex.Message.rst
> index 082f87271..260445970 100644
> --- a/doc/org.bluez.obex.Message.rst
> +++ b/doc/org.bluez.obex.Message.rst
> @@ -137,3 +137,42 @@ boolean Protected [readonly]
>  ````````````````````````````
>
>         Message protected flag
> +
> +string DeliveryStatus [readonly]
> +````````````````````````````````

This probably needs to be marked as optional since not all protocols
may have a delivery status, also I don't think you have marked the
entire label with '`' so rst2man will probably fail to parse it.

> +
> +       Message delivery status
> +
> +       Possible values:
> +
> +       :"delivered":
> +       :"sent":
> +       :"unknown":
> +
> +uint64 ConversationId [readonly]
> +````````````````````````````````
> +
> +       Message conversation id
> +       Identification of the conversation

This is a server side ID, is it unique or per folder?

> +
> +string ConversationName [readonly]
> +````````````````````````````````
> +
> +       Human readable name of the conversation
> +
> +string Direction [readonly]
> +````````````````````````````````
> +
> +       Indicate the direction of the message
> +
> +       Possible values:
> +
> +       :"incoming":
> +       :"outgoing":
> +       :"outgoingdraft":
> +       :"outgoingpending":

The last 2 I would just enumerate as "draft" and "pending".

> +
> +string AttachmentMimeTypes [readonly]
> +````````````````````````````````
> +
> +       MIME type of the attachment
> \ No newline at end of file
> --
> 2.34.1
>
>
diff mbox series

Patch

diff --git a/doc/org.bluez.obex.Message.rst b/doc/org.bluez.obex.Message.rst
index 082f87271..260445970 100644
--- a/doc/org.bluez.obex.Message.rst
+++ b/doc/org.bluez.obex.Message.rst
@@ -137,3 +137,42 @@  boolean Protected [readonly]
 ````````````````````````````
 
 	Message protected flag
+
+string DeliveryStatus [readonly]
+````````````````````````````````
+
+	Message delivery status
+
+	Possible values:
+
+	:"delivered":
+	:"sent":
+	:"unknown":
+
+uint64 ConversationId [readonly]
+````````````````````````````````
+
+	Message conversation id
+	Identification of the conversation
+
+string ConversationName [readonly]
+````````````````````````````````
+
+	Human readable name of the conversation
+
+string Direction [readonly]
+````````````````````````````````
+
+	Indicate the direction of the message
+
+	Possible values:
+
+	:"incoming":
+	:"outgoing":
+	:"outgoingdraft":
+	:"outgoingpending":
+
+string AttachmentMimeTypes [readonly]
+````````````````````````````````
+
+	MIME type of the attachment
\ No newline at end of file