From fc09df3af54e156cdbd8f6334382bc6b8e543ace Mon Sep 17 00:00:00 2001 From: Luiz Augusto von Dentz Date: Thu, 20 Dec 2012 20:34:27 +0200 Subject: [PATCH] obex-client: Rename org.bluez.obex.PhonebookAccess to PhonebookAccess1 Rename the interface and move it to obexd-api.txt since it now belongs to the same daemon. --- doc/obex-client-api.txt | 130 ---------------------------------------- doc/obexd-api.txt | 129 +++++++++++++++++++++++++++++++++++++++ obexd/client/pbap.c | 2 +- 3 files changed, 130 insertions(+), 131 deletions(-) diff --git a/doc/obex-client-api.txt b/doc/obex-client-api.txt index 335562642..b73d0d0c1 100644 --- a/doc/obex-client-api.txt +++ b/doc/obex-client-api.txt @@ -4,136 +4,6 @@ OBEX client API description Copyright (C) 2007-2010 Marcel Holtmann Copyright (C) 2011-2012 BMW Car IT GmbH. All rights reserved. -Phonebook Access hierarchy -======================= - -Service org.bluez.obex -Interface org.bluez.obex.PhonebookAccess -Object path [variable prefix]/{session0,session1,...} - -Methods void Select(string location, string phonebook) - - Select the phonebook object for other operations. Should - be call before all the other operations. - - location : Where the phonebook is stored, possible - inputs : - "INT" ( "INTERNAL" which is default ) - "SIM" ( "SIM1" ) - "SIM2" - ... - - phonebook : Possible inputs : - "pb" : phonebook for the saved contacts - "ich": incoming call history - "och": outgoing call history - "mch": missing call history - "cch": combination of ich och mch - - object, dict PullAll(string targetfile, dict filters) - - Return the entire phonebook object from the PSE server - in plain string with vcard format, and store it in - a local file. - - If an empty target file is given, a name will be - automatically calculated for the temporary file. - - The returned path represents the newly created transfer, - which should be used to find out if the content has been - successfully transferred or if the operation fails. - - The properties of this transfer are also returned along - with the object path, to avoid a call to GetProperties. - - Possible filters: Format, Order, Offset, MaxCount and - Fields - - array{string vcard, string name} List(dict filters) - - Return an array of vcard-listing data where every entry - consists of a pair of strings containing the vcard - handle and the contact name. For example: - "1.vcf" : "John" - - Possible filters: Order, Offset and MaxCount - - - object, dict - Pull(string vcard, string targetfile, dict filters) - - Given a vcard handle, retrieve the vcard in the current - phonebook object and store it in a local file. - - If an empty target file is given, a name will be - automatically calculated for the temporary file. - - The returned path represents the newly created transfer, - which should be used to find out if the content has been - successfully transferred or if the operation fails. - - The properties of this transfer are also returned along - with the object path, to avoid a call to GetProperties. - - Possbile filters: Format and Fields - - - array{string vcard, string name} - Search(string field, string value, dict filters) - - Search for entries matching the given condition and - return an array of vcard-listing data where every entry - consists of a pair of strings containing the vcard - handle and the contact name. - - vcard : name paired string match the search condition. - - field : the field in the vcard to search with - { "name" (default) | "number" | "sound" } - value : the string value to search for - - - Possible filters: Order, Offset and MaxCount - - uint16 GetSize() - - Return the number of entries in the selected phonebook - object that are actually used (i.e. indexes that - correspond to non-NULL entries). - - array{string} ListFilterFields() - - Return All Available fields that can be used in Fields - filter. - -Filter: string Format: - - Items vcard format - - Possible values: "vcard21" (default) or "vcard30" - - string Order: - - Items order - - Possible values: "indexed" (default), "alphanumeric" or - "phonetic" - - uint16 Offset: - - Offset of the first item, default is 0 - - uint16 MaxCount: - - Maximum number of items, default is unlimited (65535) - - array{string} Fields: - - Item vcard fields, default is all values. - - Possible values can be query with ListFilterFields. - - Synchronization hierarchy ======================= diff --git a/doc/obexd-api.txt b/doc/obexd-api.txt index a27b465b2..c70a7cde9 100644 --- a/doc/obexd-api.txt +++ b/doc/obexd-api.txt @@ -248,3 +248,132 @@ Methods void ChangeFolder(string folder) void Delete(string file) Deletes the specified file/folder. + +Phonebook Access hierarchy +========================= + +Service org.bluez.obex +Interface org.bluez.obex.PhonebookAccess1 +Object path /org/bluez/obex/session{0, 1, 2, ...} + +Methods void Select(string location, string phonebook) + + Select the phonebook object for other operations. Should + be call before all the other operations. + + location : Where the phonebook is stored, possible + inputs : + "INT" ( "INTERNAL" which is default ) + "SIM" ( "SIM1" ) + "SIM2" + ... + + phonebook : Possible inputs : + "pb" : phonebook for the saved contacts + "ich": incoming call history + "och": outgoing call history + "mch": missing call history + "cch": combination of ich och mch + + object, dict PullAll(string targetfile, dict filters) + + Return the entire phonebook object from the PSE server + in plain string with vcard format, and store it in + a local file. + + If an empty target file is given, a name will be + automatically calculated for the temporary file. + + The returned path represents the newly created transfer, + which should be used to find out if the content has been + successfully transferred or if the operation fails. + + The properties of this transfer are also returned along + with the object path, to avoid a call to GetProperties. + + Possible filters: Format, Order, Offset, MaxCount and + Fields + + array{string vcard, string name} List(dict filters) + + Return an array of vcard-listing data where every entry + consists of a pair of strings containing the vcard + handle and the contact name. For example: + "1.vcf" : "John" + + Possible filters: Order, Offset and MaxCount + + + object, dict + Pull(string vcard, string targetfile, dict filters) + + Given a vcard handle, retrieve the vcard in the current + phonebook object and store it in a local file. + + If an empty target file is given, a name will be + automatically calculated for the temporary file. + + The returned path represents the newly created transfer, + which should be used to find out if the content has been + successfully transferred or if the operation fails. + + The properties of this transfer are also returned along + with the object path, to avoid a call to GetProperties. + + Possbile filters: Format and Fields + + + array{string vcard, string name} + Search(string field, string value, dict filters) + + Search for entries matching the given condition and + return an array of vcard-listing data where every entry + consists of a pair of strings containing the vcard + handle and the contact name. + + vcard : name paired string match the search condition. + + field : the field in the vcard to search with + { "name" (default) | "number" | "sound" } + value : the string value to search for + + + Possible filters: Order, Offset and MaxCount + + uint16 GetSize() + + Return the number of entries in the selected phonebook + object that are actually used (i.e. indexes that + correspond to non-NULL entries). + + array{string} ListFilterFields() + + Return All Available fields that can be used in Fields + filter. + +Filter: string Format: + + Items vcard format + + Possible values: "vcard21" (default) or "vcard30" + + string Order: + + Items order + + Possible values: "indexed" (default), "alphanumeric" or + "phonetic" + + uint16 Offset: + + Offset of the first item, default is 0 + + uint16 MaxCount: + + Maximum number of items, default is unlimited (65535) + + array{string} Fields: + + Item vcard fields, default is all values. + + Possible values can be query with ListFilterFields. diff --git a/obexd/client/pbap.c b/obexd/client/pbap.c index cd199c514..432fd7b8a 100644 --- a/obexd/client/pbap.c +++ b/obexd/client/pbap.c @@ -109,7 +109,7 @@ static const char *filter_list[] = { #define FILTER_BIT_MAX 63 #define FILTER_ALL 0xFFFFFFFFFFFFFFFFULL -#define PBAP_INTERFACE "org.bluez.obex.PhonebookAccess" +#define PBAP_INTERFACE "org.bluez.obex.PhonebookAccess1" #define ERROR_INTERFACE "org.bluez.obex.Error" #define PBAP_UUID "0000112f-0000-1000-8000-00805f9b34fb" -- 2.47.3