summaryrefslogtreecommitdiff
path: root/doc/obex-api.txt
diff options
context:
space:
mode:
authorLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2014-06-18 11:31:42 +0300
committerLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2014-09-12 14:15:38 +0300
commit2f15797dfa4dddaeb47738f4481f2b756f8a7c07 (patch)
tree137c2940521f485fd8464d9b17d523b37bdea425 /doc/obex-api.txt
parent6f680981e00f9c89d899b6d005740c366b62e31c (diff)
downloadbluez-2f15797dfa4dddaeb47738f4481f2b756f8a7c07.tar.gz
doc/obex-api: Add API for PBAP 1.2 features
These changes add support for PBAP 1.2 features, the idea is that upon connecting the stack will auto retrieve the DatabaseIdentifier which will very likely be used by applications to detect if anything should be done. In case DatabaseIdentifier is present the user application can then request the folder version via GetVersion. Two new filter are added, Operator which should be used along with FilterBy and ResetNewMissedCalls the later can only be used in mch and cch folders.
Diffstat (limited to 'doc/obex-api.txt')
-rw-r--r--doc/obex-api.txt32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/obex-api.txt b/doc/obex-api.txt
index 9542a302d..31afc7455 100644
--- a/doc/obex-api.txt
+++ b/doc/obex-api.txt
@@ -431,6 +431,14 @@ Methods void Select(string location, string phonebook)
Possible errors: org.bluez.obex.Error.Forbidden
org.bluez.obex.Error.Failed
+ uint16, uint16 GetVersion()
+
+ Return the primary and secondary folder version counters
+ for the selected phonebook.
+
+ Possible errors: org.bluez.obex.Error.Forbidden
+ org.bluez.obex.Error.Failed
+
array{string} ListFilterFields()
Return All Available fields that can be used in Fields
@@ -465,6 +473,30 @@ Filter: string Format:
Possible values can be query with ListFilterFields.
+ array{string} FilterBy:
+
+ Filter items by fields. Default do not filter by
+ fields.
+
+ Possible values can be query with ListFilterFields
+ excluding the first item that must be either '&' or
+ '|' that apply AND or OR logic respectively.
+
+ bool ResetNewMissedCalls
+
+ Reset new the missed calls items, shall only be used
+ for folders mch and cch.
+
+Properties string Folder [readonly]
+
+ Current folder.
+
+ string DatabaseIdentifier [readonly]
+
+ 128 bits persistent identifier.
+
+ Value '0' shall be considered as not supported.
+
Synchronization hierarchy
=========================