moon
/
honkoma
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: Add `mark_message_as_read` to docs

This commit is contained in:
lain 2020-06-03 19:24:37 +02:00
parent b3407344d3
commit 286bd8eb83
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/API/chats.md
View File

@ -94,6 +94,15 @@ Returned data:
} }
``` ```
### Marking a single chat message as read
To set the `unread` property of a message to `false`
`POST /api/v1/pleroma/chats/:id/messages/:message_id/read`
Returned data:
The modified chat message
### Getting a list of Chats ### Getting a list of Chats
@ -149,7 +158,8 @@ Returned data:
"visible_in_picker": false "visible_in_picker": false
} }
], ],
"id": "13" "id": "13",
"unread": true
}, },
{ {
"account_id": "someflakeid", "account_id": "someflakeid",
@ -157,7 +167,8 @@ Returned data:
"content": "Whats' up?", "content": "Whats' up?",
"created_at": "2020-04-21T15:06:45.000Z", "created_at": "2020-04-21T15:06:45.000Z",
"emojis": [], "emojis": [],
"id": "12" "id": "12",
"unread": false
} }
] ]
``` ```
@ -190,7 +201,8 @@ Returned data:
"visible_in_picker": false "visible_in_picker": false
} }
], ],
"id": "13" "id": "13",
"unread": false
} }
``` ```
@ -215,7 +227,8 @@ There's a new `pleroma:chat_mention` notification, which has this form. It is no
"chat_id": "1", "chat_id": "1",
"id": "10", "id": "10",
"content": "Hello", "content": "Hello",
"account_id": "someflakeid" "account_id": "someflakeid",
"unread": false
}, },
"created_at": "somedate" "created_at": "somedate"
} }