1ORG.BLUEZ.OBEX.PHONEBOOKACCLEiSnSu(x5)System AdminisOtRrGa.tBiLoUnEZ.OBEX.PHONEBOOKACCESS(5)
2
3
4

NAME

6       org.bluez.obex.PhonebookAccess  -  BlueZ D-Bus OBEX PhonebookAccess API
7       documentation
8

INTERFACE

10       Service
11              org.bluez.obex
12
13       Interface
14              org.bluez.obex.PhonebookAccess1
15
16       Object path
17              [Session object path]
18
19   Methods
20   void Select(string location, string phonebook)
21          Selects the phonebook object for other operations.  Should  be  call
22          before all the other operations.
23
24          Possible location values:
25
26          "int", "internal" (default)
27                 Store in the Internal memory.
28
29          "sim{#}"
30                 Store in the sim number.
31
32          Possible phonebook values:
33
34          "pb"   Store as contact.
35
36          "ich"  Store as incoming call.
37
38          "och"  Store as outgoing call.
39
40          "mch"  Store as missing call.
41
42          "cch"  Store  as  a  combination  of  incoming, outgoing and missing
43                 call.
44
45          "spd":
46              Store as speed dials entry ( only for "internal" )
47
48          "fav":
49              Store as favorites entry ( only for "internal" )
50
51          Possible errors:
52
53          org.bluez.obex.Error.InvalidArguments
54
55          org.bluez.obex.Error.Failed
56
57   object, dict PullAll(string targetfile, dict filters)
58          Returns the entire phonebook object from the  PSE  server  in  plain
59          string with vcard format, and store it in a local file.
60
61          If  an empty target file is given, a name will be automatically gen‐
62          erated for the temporary file.
63
64          The returned path  represents  the  newly  created  transfer,  which
65          should  be  used  to  find  out if the content has been successfully
66          transferred or if the operation fails.
67
68          The properties of this transfer are also returned along with the ob‐
69          ject    path,    to    avoid    a   call   to   GetProperties,   see
70          org.bluez.obex.Transfer(5) for the possible list of properties.
71
72          Possible filters:
73
74          string Format
75                 Items vcard format.
76
77                 Possible values:
78
79                 "vcard21" (default)
80
81                 "vcard30"
82
83          string Order
84                 Items order.
85
86                 Possible values:
87
88                 ""
89
90                 "indexed"
91
92                 "alphanumeric"
93
94                 "phonetic"
95
96          uint16 Offset (default 0)
97                 Offset of the first item.
98
99          uint16 MaxCount (default 65535)
100                 Maximum number of items.
101
102          array{string} Fields (default all fields)
103                 Item vcard fields.
104
105                 See ListFilterFields() for possible values.
106
107          array{string} FilterAll
108                 Filter items by fields using AND logic, cannot  be  used  to‐
109                 gether with FilterAny.
110
111                 See ListFilterFields() for possible values.
112
113          array{string} FilterAny
114                 Filter  items  by  fields  using OR logic, cannot be used to‐
115                 gether with FilterAll.
116
117                 See ListFilterFields() for possible values.
118
119          bool ResetNewMissedCalls
120                 Reset new the missed calls items,  shall  only  be  used  for
121                 folders mch and cch.
122
123          Possible errors:
124
125          org.bluez.obex.Error.InvalidArguments
126
127          org.bluez.obex.Forbidden
128
129   array{string vcard, string name} List(dict filters)
130          Returns  array of vcard-listing data where every entry consists of a
131          pair of strings containing the vcard handle and  the  contact  name.
132          For example:
133
134          "1.vcf"
135                 "John"
136
137          Possible filters:
138
139          string Order
140                 Contact order.
141
142                 Possible values:
143
144                 ""
145
146                 "indexed"
147
148                 "alphanumeric"
149
150                 "phonetic"
151
152          uint16 Offset
153                 Start offset.
154
155          uint16 MaxCount
156                 Maximum number of contacts.
157
158          Possible errors:
159
160          org.bluez.obex.Error.InvalidArguments
161
162          org.bluez.obex.Forbidden
163
164   object, dict Pull(string vcard, string targetfile, dict filters)
165          Retrieves  the vcard in the current phonebook object and store it in
166          a local file.
167
168          If an empty target file is given, a name will be automatically  gen‐
169          erated for the temporary file.
170
171          The  returned  path  represents  the  newly  created transfer, which
172          should be used to find out if  the  content  has  been  successfully
173          transferred or if the operation fails.
174
175          The properties of this transfer are also returned along with the ob‐
176          ject   path,   to   avoid   a    call    to    GetProperties,    see
177          org.bluez.obex.Transfer(5) for the possible list of properties.
178
179          Possible filters:
180
181          string Format
182                 Contact data format.
183
184                 Possible values:
185
186                 ""
187
188                 "vcard21"
189
190                 "vcard30"
191
192          array{string} Fields
193                 See ListFilterFields() for possible values.
194
195          Possible errors:
196
197          org.bluez.obex.Error.InvalidArguments
198
199          org.bluez.obex.Error.Forbidden
200
201          org.bluez.obex.Error.Failed
202
203   array{string  vcard,  string  name} Search(string field, string value, dict
204       filters)
205          Searches for entries matching the given condition and return an  ar‐
206          ray  of  vcard-listing  data where every entry consists of a pair of
207          strings containing the vcard handle and the contact name.
208
209          Possible field values:
210
211              "name" (default)
212                     Search by name.
213
214              "number"
215                     Search by number.
216
217              "sound"
218                     Search by sound.
219
220          value: the string value to search for
221
222          Possible filters:
223
224          string Order
225                 Contact order.
226
227                 Possible values:
228
229                 ""
230
231                 "indexed"
232
233                 "alphanumeric"
234
235                 "phonetic"
236
237          uint16 Offset
238                 Start offset.
239
240          uint16 MaxCount
241                 Maximum number of contacts.
242
243          Possible errors:
244
245          org.bluez.obex.Error.InvalidArguments
246
247          org.bluez.obex.Error.Forbidden
248
249          org.bluez.obex.Error.Failed
250
251   uint16 GetSize()
252          Returns the number of entries in the selected phonebook object  that
253          are  actually  used  (i.e.  indexes  that correspond to non-NULL en‐
254          tries).
255
256          Possible errors:
257
258          org.bluez.obex.Error.Forbidden
259
260          org.bluez.obex.Error.Failed
261
262   void UpdateVersion()
263          Attempts to update PrimaryCounter and SecondaryCounter.
264
265          Possible errors:
266
267          org.bluez.obex.Error.NotSupported
268
269          org.bluez.obex.Error.Forbidden
270
271          org.bluez.obex.Error.Failed
272
273   array{string} ListFilterFields()
274          Returns all Available fields that can be used in Fields filter.
275
276          Possible return:
277
278          "VERSION"
279
280          "FN"
281
282          "N"
283
284          "PHOTO"
285
286          "BDAY"
287
288          "ADR"
289
290          "LABEL"
291
292          "TEL"
293
294          "EMAIL"
295
296          "MAILER"
297
298          "TZ"
299
300          "GEO"
301
302          "TITLE"
303
304          "ROLE"
305
306          "LOGO"
307
308          "AGENT"
309
310          "ORG"
311
312          "NOTE"
313
314          "REV"
315
316          "SOUND"
317
318          "URL"
319
320          "UID"
321
322          "KEY"
323
324          "NICKNAME"
325
326          "CATEGORIES"
327
328          "PROID"
329
330          "CLASS"
331
332          "SORT-STRING"
333
334          "X-IRMC-CALL-DATETIME"
335
336          "X-BT-SPEEDDIALKEY"
337
338          "X-BT-UCI"
339
340          "X-BT-UID"
341
342          "BIT-{#}"
343
344          Possible errors: None
345
346   Properties
347   string Folder [readonly]
348          Current folder.
349
350   string DatabaseIdentifier [readonly, optional]
351          128 bits persistent database identifier.
352
353          Possible values:
354              32-character           hexadecimal            such            as
355              A1A2A3A4B1B2C1C2D1D2E1E2E3E4E5E6
356
357   string PrimaryCounter [readonly, optional]
358          128 bits primary version counter.
359
360          Possible values:
361              32-character            hexadecimal            such           as
362              A1A2A3A4B1B2C1C2D1D2E1E2E3E4E5E6
363
364   string SecondaryCounter [readonly, optional]
365          128 bits secondary version counter.
366
367          Possible values:
368              32-character           hexadecimal            such            as
369              A1A2A3A4B1B2C1C2D1D2E1E2E3E4E5E6
370
371   bool FixedImageSize [readonly, optional]
372          Indicate support for fixed image size.
373
374          Possible values:
375              True if image is JPEG 300x300 pixels otherwise False.
376
377
378
379
380BlueZ                            October 2023ORG.BLUEZ.OBEX.PHONEBOOKACCESS(5)