diff options
| author | Daniel Kesselberg <mail@danielkesselberg.de> | 2022-12-06 20:21:37 +0100 |
|---|---|---|
| committer | Vincent Petry (Rebase PR Action) <PVince81@users.noreply.github.com> | 2023-01-19 09:33:53 +0000 |
| commit | ffb76d547567f1a6c2f33981dcca3e0cab1b5309 (patch) | |
| tree | fa0cfa97bf81610fea4bd6305431ea6badc4bf88 /lib/public | |
| parent | e447530c292132e9a374ebfd7bac6bad722e93ee (diff) | |
| download | nextcloud-server-ffb76d547567f1a6c2f33981dcca3e0cab1b5309.tar.gz nextcloud-server-ffb76d547567f1a6c2f33981dcca3e0cab1b5309.zip | |
docs: document types flag for search options
Signed-off-by: Daniel Kesselberg <mail@danielkesselberg.de>
Diffstat (limited to 'lib/public')
| -rw-r--r-- | lib/public/Contacts/IManager.php | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/public/Contacts/IManager.php b/lib/public/Contacts/IManager.php index ce50f8d5b32..2e87f6c8afc 100644 --- a/lib/public/Contacts/IManager.php +++ b/lib/public/Contacts/IManager.php @@ -90,13 +90,15 @@ interface IManager { * @param string $pattern which should match within the $searchProperties * @param array $searchProperties defines the properties within the query pattern should match * @param array $options = array() to define the search behavior + * - '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']] * - 'escape_like_param' - If set to false wildcards _ and % are not escaped * - 'limit' - Set a numeric limit for the search results * - 'offset' - Set the offset for the limited search results * - 'enumeration' - (since 23.0.0) Whether user enumeration on system address book is allowed * - 'fullmatch' - (since 23.0.0) Whether matching on full detail in system addresss book is allowed * - 'strict_search' - (since 23.0.0) Whether the search pattern is full string or partial search - * @psalm-param array{escape_like_param?: bool, limit?: int, offset?: int, enumeration?: bool, fullmatch?: bool, strict_search?: bool} $options + * @psalm-param array{types?: bool, escape_like_param?: bool, limit?: int, offset?: int, enumeration?: bool, fullmatch?: bool, strict_search?: bool} $options * @return array an array of contacts which are arrays of key-value-pairs * @since 6.0.0 */ |