diff options
| author | Julius Härtl <jus@bitgrid.net> | 2018-10-29 17:00:09 +0100 |
|---|---|---|
| committer | Julius Härtl <jus@bitgrid.net> | 2018-10-30 10:19:35 +0100 |
| commit | 61af60752555bb0c7f0a30cb7b7f35e7ca45fa45 (patch) | |
| tree | f9597f423477fef10fa687d7ba98ed8dcc3866b9 /lib/public/IAddressBook.php | |
| parent | 192324e4decc850d5def1394581a0dce2f2402d6 (diff) | |
| download | nextcloud-server-61af60752555bb0c7f0a30cb7b7f35e7ca45fa45.tar.gz nextcloud-server-61af60752555bb0c7f0a30cb7b7f35e7ca45fa45.zip | |
Make enhancing entries with type property optional
Signed-off-by: Julius Härtl <jus@bitgrid.net>
Diffstat (limited to 'lib/public/IAddressBook.php')
| -rw-r--r-- | lib/public/IAddressBook.php | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/lib/public/IAddressBook.php b/lib/public/IAddressBook.php index 67c34c9e8c9..4739e6f0c5b 100644 --- a/lib/public/IAddressBook.php +++ b/lib/public/IAddressBook.php @@ -55,16 +55,18 @@ namespace OCP { /** * @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']] + * ] * @since 5.0.0 */ public function search($pattern, $searchProperties, $options); - // // dummy results - // return array( - // array('id' => 0, 'FN' => 'Thomas Müller', 'EMAIL' => 'a@b.c', 'GEO' => '37.386013;-122.082932'), - // array('id' => 5, 'FN' => 'Thomas Tanghus', 'EMAIL' => array('d@e.f', 'g@h.i')), - // ); /** * @param array $properties this array if key-value-pairs defines a contact |