diff options
| author | Vitor Mattos <vitor@php.rio> | 2022-03-10 16:27:16 +0300 |
|---|---|---|
| committer | Vitor Mattos <vitor@php.rio> | 2022-03-10 16:27:16 +0300 |
| commit | 73f59d3546a6ef7e474a3493bcd8cbfe28e89887 (patch) | |
| tree | c3ae1ab13514771f4a1089c257fe6fb3b26da398 /docs | |
| parent | 23270be26a0e0e0cbfc6ab9c84d0ea1e34ccbdec (diff) | |
Update docs
Signed-off-by: Vitor Mattos <vitor@php.rio>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/reaction.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/reaction.md b/docs/reaction.md index 5fc16e9f6..f4ed4b7b4 100644 --- a/docs/reaction.md +++ b/docs/reaction.md @@ -21,6 +21,16 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` + `404 Not Found` When the conversation or message to react could not be found for the participant + `409 Conflict` User already did this reaction to this message + - Data: + Array with data of reactions: + + field | type | Description + ---|---|--- + `actorType` | string | `guests` or `users` + `actorId` | string | Actor id of the reacting participant + `actorDisplayName` | string | Display name of the reaction author + `timestamp` | int | Timestamp in seconds and UTC time zone + ## Delete a reaction * Required capability: `reactions` @@ -38,6 +48,16 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` + `400 Bad Request` In case of no reaction support, message out of reactions context or any other error + `404 Not Found` When the conversation or message to react or reaction could not be found for the participant + - Data: + Array with data of reactions: + + field | type | Description + ---|---|--- + `actorType` | string | `guests` or `users` + `actorId` | string | Actor id of the reacting participant + `actorDisplayName` | string | Display name of the reaction author + `timestamp` | int | Timestamp in seconds and UTC time zone + ## Retrieve reactions of a message by type * Required capability: `reactions` |