diff options
| author | Julius Härtl <jus@bitgrid.net> | 2018-10-30 14:43:08 +0100 |
|---|---|---|
| committer | Julius Härtl <jus@bitgrid.net> | 2018-10-30 14:43:08 +0100 |
| commit | b9c5e569d36fb57baae6c340d31970d5f852261e (patch) | |
| tree | 0d53317d84365db776a99c485360b1332661abc6 /apps/dav | |
| parent | 5a73a9b9ded91b15ca044d27ac2cf42fb483af93 (diff) | |
| download | nextcloud-server-b9c5e569d36fb57baae6c340d31970d5f852261e.tar.gz nextcloud-server-b9c5e569d36fb57baae6c340d31970d5f852261e.zip | |
Update AddressBookImpl documentation
Signed-off-by: Julius Härtl <jus@bitgrid.net>
Diffstat (limited to 'apps/dav')
| -rw-r--r-- | apps/dav/lib/CardDAV/AddressBookImpl.php | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/apps/dav/lib/CardDAV/AddressBookImpl.php b/apps/dav/lib/CardDAV/AddressBookImpl.php index 4f2491e1895..1aedd5d5643 100644 --- a/apps/dav/lib/CardDAV/AddressBookImpl.php +++ b/apps/dav/lib/CardDAV/AddressBookImpl.php @@ -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 */ |