Browse Source

Update AddressBookImpl documentation

Signed-off-by: Julius Härtl <jus@bitgrid.net>
tags/v15.0.0beta1
Julius Härtl 5 years ago
parent
commit
b9c5e569d3
No account linked to committer's email address
1 changed files with 9 additions and 1 deletions
  1. 9
    1
      apps/dav/lib/CardDAV/AddressBookImpl.php

+ 9
- 1
apps/dav/lib/CardDAV/AddressBookImpl.php View File

@@ -88,7 +88,15 @@ class AddressBookImpl implements IAddressBook {
/**
* @param string $pattern which should match within the $searchProperties
* @param array $searchProperties defines the properties within the query pattern should match
* @param array $options - for future use. One should always have options!
* @param array $options Options to define the output format
* - types boolean (since 15.0.0) If set to true, fields that come with a TYPE property will be an array
* example: ['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['type => 'HOME', 'value' => 'g@h.i']]
* @return array an array of contacts which are arrays of key-value-pairs
* example result:
* [
* ['id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c', 'GEO' => '37.386013;-122.082932'],
* ['id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => ['d@e.f', 'g@h.i']]
* ]
* @return array an array of contacts which are arrays of key-value-pairs
* @since 5.0.0
*/

Loading…
Cancel
Save