khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-04 02:36:49 +07:00
Code Issues Packages Projects Releases Wiki Activity

Document the AutoCompleteEvent event

Browse Source 
Signed-off-by: Joas Schilling <coding@schilljs.com>
This commit is contained in:
Joas Schilling
2022-11-09 14:23:42 +01:00
parent 56641f0fe1
commit 8576c831af
1 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
developer_manual/client_apis/OCS/ocs-api-overview.rst
View File

@@ -218,12 +218,21 @@ An example curl command would be:
curl -i -u master -X GET -H "OCS-APIRequest: true" 'https://my.nextcloud/ocs/v2.php/core/autocomplete/get?search=JOANNE%40EMAIL.ISP&itemType=%20&itemId=%20&shareTypes[]=8&limit=2'
That would look for JOANNE@EMAIL.ISP as guest user. Maximum 2 results to be returned for a regular user, the shareTypes array would carry only "0".
``itemType`` and ``itemId`` are left (set to a white space), essentially they are to give context about the use case, so sorters can do their work (like who
commented last). It can be an option for filtering on a later stage but you can also leave them out as per the below example.
That would look for JOANNE@EMAIL.ISP as guest user. Maximum 2 results to be returned for a regular user, the
shareTypes array would carry only "8". ``itemType`` and ``itemId`` are left out (set to a white space),
essentially they are to give context about the use case, so sorters can do their work (like who commented last).
It can be an option for filtering on a later stage but you can also leave them out as per the below example.
.. code::
curl -i -u master -X GET -H "OCS-APIRequest: true" 'https://my.nextcloud/ocs/v2.php/core/autocomplete/get?search=JOANNE%40EMAIL.ISP&shareTypes[]=8&limit=2'
The shareType would default to regular users if you left it out), the limit defaults to 10.
The shareType defaults to regular users if you left it out), the limit defaults to 10.
Filtering the auto-complete results
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In case needed, you can also further filter the auto-complete results on the PHP side using the
``OCP\Collaboration\AutoComplete\AutoCompleteEvent`` event. The event gives you access to the current
result set, the item and share types and some more information that you can use to e.g. limit the autocomplete
results to users that are actually in the current chat conversation.