Browse Source

fix(docs): Add capability and documentation

Signed-off-by: Joas Schilling <coding@schilljs.com>
pull/10541/head
Joas Schilling 2 years ago
parent
commit
b3af05197b
No known key found for this signature in database GPG Key ID: 74434EFE0D2E2205
  1. 1
      docs/capabilities.md
  2. 33
      docs/conversation.md
  3. 1
      lib/Capabilities.php
  4. 1
      tests/php/CapabilitiesTest.php

1
docs/capabilities.md

@ -129,4 +129,5 @@
## 18
* `session-state` - Sessions can mark themselves as inactive, so the participant receives notifications again
* `note-to-self` - Support for "Note-to-self" conversation exists
* `config => chat => has-translation-providers` - When true, translation tuples can be loaded from the [OCS Translation API](https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-translation-api.html#get-available-translation-options).

33
docs/conversation.md

@ -154,6 +154,39 @@
- Data: See array definition in `Get user´s conversations`
## Get "Note-to-self" conversation
The conversation is like a group conversation and the user is the owner, but with the following limitations:
* Can not add participants to the conversation
* Can not allow guests
* Can not make read-only
* Can not open the conversations to users or guests
* Can not change permissions
* Can not set lobby
* Can not enable SIP
* Can not configure breakout rooms
* Can not call
If the conversation does not exist at the moment, it will be generated and the user added automatically.
* Required capability: `note-to-self`
* Method: `GET`
* Endpoint: `/room/note-to-self`
* Response:
- Status code:
+ `200 OK`
+ `401 Unauthorized` When the user is not logged in
- Header:
| field | type | Description |
|-------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------|
| `X-Nextcloud-Talk-Hash` | string | Sha1 value over some config. When you receive a different value on subsequent requests, the capabilities and the signaling settings should be refreshed. |
- Data: See array definition in `Get user´s conversations`
## Get open conversations
* Required capability: `listable-rooms`

1
lib/Capabilities.php

@ -123,6 +123,7 @@ class Capabilities implements IPublicCapability {
'bots-v1',
'markdown-messages',
'session-state',
'note-to-self',
],
'config' => [
'attachments' => [

1
tests/php/CapabilitiesTest.php

@ -140,6 +140,7 @@ class CapabilitiesTest extends TestCase {
'bots-v1',
'markdown-messages',
'session-state',
'note-to-self',
'message-expiration',
'reactions',
];

Loading…
Cancel
Save