Re: [PATCH 6/6] doc/obex-api: Update documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Ajay,

On Mon, Dec 16, 2019 at 1:54 AM Ajay Kishore <ajay.kishore@xxxxxxxxx> wrote:
>
> This adds documentation with the conversation listing feature
>
> Signed-off-by: Ajay Kishore <ajay.kishore@xxxxxxxxx>
> ---
>  doc/obex-api.txt | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 65 insertions(+)
>
> diff --git a/doc/obex-api.txt b/doc/obex-api.txt
> index f39355a..9a76159 100644
> --- a/doc/obex-api.txt
> +++ b/doc/obex-api.txt
> @@ -712,6 +712,71 @@ Methods            void SetFolder(string name)
>                         Possible errors: org.bluez.obex.Error.InvalidArguments
>                                          org.bluez.obex.Error.Failed
>
> +
> +
> +               array{object, dict} listconversations(string folder, dict filter)

It should have been ListConversations to adhere with our D-Bus APIs,
but read bellow.

> +                       Returns an array containing the conversations found in the
> +                       given subfolder of the current folder, or in the current
> +                       folder if folder is empty.
> +
> +                       Possible Filters: LastActivityBegin, LastActivityEnd,
> +                       ReadStatus, Recipient

So here is the big design question, why hasn't this been done as a
filter to ListMessages? We could just have a couple of different
properties to indicate it is a conversation rather than a single
message, in any case we would need something like
org.bluez.obex.Conversation1 to enumerate these objects, something
that is not documented here.


> +
> +                       Properties:
> +
> +                               string id:
> +
> +                                       Conversation unique identification
> +
> +                               string name:
> +
> +                                       Conversation name
> +
> +                               string last_activity:
> +
> +                                       Conversation timestamp for the last activity
> +
> +                               boolean read_status:
> +
> +                                       Conversation read flag
> +
> +                               string version_counter:
> +
> +                                       128 bits version counter.
> +                                       The ‘Conversation-Listing Version Counter’,
> +                                       ‘Conversation Version Counter’, and ‘Folder
> +                                       Version Counter’ are used to detect if something
> +                                       has changed
> +
> +                               string summary:
> +
> +                                       Conversation summary
> +
> +                               string display:
> +
> +                                       Conversation participants name
> +
> +                               string chat_state:
> +
> +                                       Conversation current chat state of the participants
> +
> +                               string presence_availability:
> +
> +                                       Conversation  participants availability
> +
> +                               string presence_text:
> +
> +                                       User defined status of the conversation
> +
> +                               uint16 priority:
> +
> +                                       Conversation participant priority
> +
> +                       Possible errors: org.bluez.obex.Error.InvalidArguments
> +                                        org.bluez.obex.Error.Failed
> +
> +
>                 void UpdateInbox(void)
>
>                         Request remote to update its inbox.
> --
> 2.7.4
>


-- 
Luiz Augusto von Dentz




[Index of Archives]     [Bluez Devel]     [Linux Wireless Networking]     [Linux Wireless Personal Area Networking]     [Linux ATH6KL]     [Linux USB Devel]     [Linux Media Drivers]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [Big List of Linux Books]

  Powered by Linux