Skip to content

fix(developer): add isContextChatAvailable method to Context Chat OCP API #13409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marcelklehr merged 4 commits into from
Jul 13, 2025
Merged

fix(developer): add isContextChatAvailable method to Context Chat OCP API #13409

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
17cd86c
fix(developer): add isContextChatAvailable method to Context Chat OCP…
edward-ly Jul 11, 2025
2af040c
fix(developer): add missing description for registerContentProvider m…
edward-ly Jul 11, 2025
3aeb7ed
fix(developer): mention that context_chat should be enabled before su…
edward-ly Jul 11, 2025
e37ddb4
feat(developer): add ContextChat OCP API to upgrade guide
edward-ly Jul 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_32.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Back-end changes
Added APIs
^^^^^^^^^^

- New ``OCP\ContextChat`` API. See :ref:`context_chat` for details.
- New task processing task type ``OCP\TaskProcessing\TextToSpeech`` to convert text to speech.
- New interface ``\OCP\Share\IShareProviderSupportsAllSharesInFolder`` extending ``\OCP\Share\IShareProvider`` to add the method ``\OCP\Share\IShareProviderSupportsAllSharesInFolder::getAllSharesInFolder`` used for querying all shares in a folder without filtering by user.
- New method ``\OCP\IUser::canChangeEmail`` allowing to check if the user backend allows the user to change their email address.
Expand Down
8 changes: 6 additions & 2 deletions developer_manual/digging_deeper/context_chat.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@ To add content and register your provider implementation you will need to use th

The ``IContentManager`` class has the following methods:

* ``registerContentProvider(string $providerClass)``
* ``isContextChatAvailable()``: Returns ``true`` if the Context Chat app is enabled, ``false`` otherwise.
* ``registerContentProvider(string $providerClass)``: Register a new content provider.
* ``submitContent(string $appId, array $items)``: Providers can use this to submit content for indexing in Context Chat.
* ``updateAccess(string $appId, string $providerId, string $itemId, string $op, array $userIds)``: Update the access rights for a content item. Use ``\OCP\ContextChat\Type\UpdateAccessOp`` constants for the ``$op`` value.
* ``updateAccessProvider(string $appId, string $providerId, string $op, array $userIds)``: Update the access rights for all content items from a provider. Use ``\OCP\ContextChat\Type\UpdateAccessOp`` constants for the ``$op`` value.
Expand Down Expand Up @@ -115,7 +116,10 @@ if you want to trigger an initial import of content items.
Submitting ContentItem data
^^^^^^^^^^^^^^^^^^^^^^^^^^^

To submit content, wrap it in an ``\OCP\ContextChat\ContentItem`` object:
Before submitting, you should check that the Context Chat app is enabled first
by calling the ``isContextChatAvailable()`` method.

Then, to submit content, wrap it in a list of ``\OCP\ContextChat\ContentItem`` objects:

.. code-block:: php

Expand Down