diff options
| author | Christoph Wurst <christoph@winzerhof-wurst.at> | 2021-11-11 11:02:48 +0100 |
|---|---|---|
| committer | Christoph Wurst <christoph@winzerhof-wurst.at> | 2021-11-11 11:02:48 +0100 |
| commit | 0b72abb7a54ecf32b829ba610ec6903391d28273 (patch) | |
| tree | 133d5313a2dde25495ee4270d54c74d829f7b788 /lib/public | |
| parent | 4e1e81f336936f8fbffaba9c6f16f46379cf028e (diff) | |
| download | nextcloud-server-0b72abb7a54ecf32b829ba610ec6903391d28273.tar.gz nextcloud-server-0b72abb7a54ecf32b829ba610ec6903391d28273.zip | |
Document allowed property names for calendar property searches
For API users it looked like any properties could be searched. But it
turned out to be a hand picked list of properties that we index and then
use for the search. To prevent application errors where special props
are not found, I suggest we document the allowed values.
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
Diffstat (limited to 'lib/public')
| -rw-r--r-- | lib/public/Calendar/ICalendarQuery.php | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/lib/public/Calendar/ICalendarQuery.php b/lib/public/Calendar/ICalendarQuery.php index 142810d3fb9..d37c4b94225 100644 --- a/lib/public/Calendar/ICalendarQuery.php +++ b/lib/public/Calendar/ICalendarQuery.php @@ -51,6 +51,11 @@ interface ICalendarQuery { /** * Define the property name(s) to search for * + * Note: Nextcloud only indexes *some* properties. You can not search for + * arbitrary properties. + * + * @param string $value one of CATEGORIES, COMMENT, DESCRIPTION, LOCATION, RESOURCES, STATUS, SUMMARY, ATTENDEE, CONTACT or ORGANIZER + * * @since 23.0.0 */ public function addSearchProperty(string $value): void; |