summaryrefslogtreecommitdiffstats
path: root/docs/chat.md
diff options
context:
space:
mode:
authorJoas Schilling <coding@schilljs.com>2024-01-19 15:21:00 +0100
committerJoas Schilling <coding@schilljs.com>2024-01-19 15:21:00 +0100
commit113f0557c462ecb1a663706cba90e2f0eed4352b (patch)
tree710ada5fa9dcfd2e55db57e0cf1be3260bb76531 /docs/chat.md
parent256d440af3dff0636c206173e986c4f85641ae60 (diff)
fix(docs): Document empty display names
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs/chat.md')
-rw-r--r--docs/chat.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/chat.md b/docs/chat.md
index 328978801..a892072cb 100644
--- a/docs/chat.md
+++ b/docs/chat.md
@@ -49,7 +49,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`: since Nextcloud 13
| `token` | string | Conversation token |
| `actorType` | string | See [Constants - Actor types of chat messages](constants.md#actor-types-of-chat-messages) |
| `actorId` | string | Actor id of the message author |
-| `actorDisplayName` | string | Display name of the message author |
+| `actorDisplayName` | string | Display name of the message author (can be empty for type `deleted_users` and `guests`) |
| `timestamp` | int | Timestamp in seconds and UTC time zone |
| `systemMessage` | string | empty for normal chat message or the type of the system message (untranslated) |
| `messageType` | string | Currently known types are `comment`, `comment_deleted`, `system` and `command` |
@@ -64,7 +64,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`: since Nextcloud 13
| `markdown` | bool | **Optional:** Whether the message should be rendered as markdown or shown as plain text |
| `lastEditActorType` | string | Actor type of the last editing author - See [Constants - Actor types of chat messages](constants.md#actor-types-of-chat-messages) (only available with `edit-messages` capability and when the message was actually edited) |
| `lastEditActorId` | string | Actor id of the last editing author (only available with `edit-messages` capability and when the message was actually edited) |
-| `lastEditActorDisplayName` | string | Display name of the last editing author (only available with `edit-messages` capability and when the message was actually edited) |
+| `lastEditActorDisplayName` | string | Display name of the last editing author (only available with `edit-messages` capability and when the message was actually edited) (can be empty for type `deleted_users` and `guests`) |
| `lastEditTimestamp` | int | Unix time stamp when the message was last edited (only available with `edit-messages` capability and when the message was actually edited) |
#### Parent data