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

[Matias Karhumaa <matias.karhumaa@gmail.com>]

Hi Ajay,

ti 24. jouluk. 2019 klo 7.29 Ajay Kishore (ajay.kishore@intel.com) kirjoitti:
>
> This adds documentation with the conversation listing feature
>
> Signed-off-by: Ajay Kishore <ajay.kishore@intel.com>
Signed-off-by isn't necessary for Bluez patches.

> ---
>  doc/obex-api.txt | 94 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 94 insertions(+)
>
> diff --git a/doc/obex-api.txt b/doc/obex-api.txt
> index f39355a..8f27b40 100644
> --- a/doc/obex-api.txt
> +++ b/doc/obex-api.txt
> @@ -892,3 +892,97 @@ Properties string Folder [readonly]
>                 boolean Protected [readonly]
>
>                         Message protected flag
> +
> +Conversation Access hierarchy
> +==============================
> +
> +Service                org.bluez.obex
> +Interface      org.bluez.obex.Conversation1
> +Object path    [Session object path]
> +
> +Methods                array{object, dict} ListConversations(string folder, dict filter)
I think this does not quite match the implementation. I think
ListConversation belongs to MessageAccess1 interface. Conversation1
interface has similar method than Message1 interface.

> +                       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: MaxListCount, LastActivityBegin, LastActivityEnd,
> +                       ReadStatus, Recipient
> +
> +               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
> +
> +
> +Filter:                uint16 MaxListCount:
Shouldn't this be MaxCount?

> +
> +                       Maximum number of items in the conversations.
> +
> +               string LastActivityBegin:
> +
> +                       Filter conversations by starting period.
> +
> +                       Possible values: Date in "YYYYMMDDTHHMMSS" format.
> +
> +               string LastActivityEnd:
> +
> +                       Filter conversations by ending period.
> +
> +                       Possible values: Date in "YYYYMMDDTHHMMSS" format.
> +
> +               boolean ReadStatus:
> +
> +                       Filter converstions by read flag.
> +
> +                       Possible values: True for read or False for unread
> +
> +               string Recipient:
> +
> +                       Filter conversations by conversation-recipient.
> --
> 2.7.4
>

Best regards,
Matias Karhumaa