mirror of
https://git.pleroma.social/sjw/pleroma.git
synced 2024-12-25 06:55:05 +01:00
Pleroma Conversations: Document differences.
This commit is contained in:
parent
b64b6fee2a
commit
ddabe7784b
@ -59,12 +59,19 @@ Has these additional fields under the `pleroma` object:
|
||||
- `show_role`: boolean, nullable, true when the user wants his role (e.g admin, moderator) to be shown
|
||||
- `no_rich_text` - boolean, nullable, true when html tags are stripped from all statuses requested from the API
|
||||
|
||||
## Conversations
|
||||
|
||||
Has an additional field under the `pleroma` object:
|
||||
|
||||
- `recipients`: The list of the recipients of this Conversation. These will be addressed when replying to this conversation.
|
||||
|
||||
## Account Search
|
||||
|
||||
Behavior has changed:
|
||||
|
||||
- `/api/v1/accounts/search`: Does not require authentication
|
||||
|
||||
|
||||
## Notifications
|
||||
|
||||
Has these additional fields under the `pleroma` object:
|
||||
@ -79,6 +86,7 @@ Additional parameters can be added to the JSON body/Form data:
|
||||
- `content_type`: string, contain the MIME type of the status, it is transformed into HTML by the backend. You can get the list of the supported MIME types with the nodeinfo endpoint.
|
||||
- `to`: A list of nicknames (like `lain@soykaf.club` or `lain` on the local server) that will be used to determine who is going to be addressed by this post. Using this will disable the implicit addressing by mentioned names in the `status` body, only the people in the `to` list will be addressed. The normal rules for for post visibility are not affected by this and will still apply.
|
||||
- `visibility`: string, besides standard MastoAPI values (`direct`, `private`, `unlisted` or `public`) it can be used to address a List by setting it to `list:LIST_ID`.
|
||||
- `in_reply_to_conversation_id`: Will reply to a given conversation, addressing only the people who are part of the recipient set of that conversation. Sets the visibility to `direct`.
|
||||
|
||||
## PATCH `/api/v1/update_credentials`
|
||||
|
||||
|
@ -319,3 +319,32 @@ See [Admin-API](Admin-API.md)
|
||||
"healthy": true # Instance state
|
||||
}
|
||||
```
|
||||
|
||||
# Pleroma Conversations
|
||||
|
||||
Pleroma Conversations have the same general structure that Mastodon Conversations have. The behavior differs in the following ways when using these endpoints:
|
||||
|
||||
1. Pleroma Conversations never add or remove recipients, unless explicitly changed by the user.
|
||||
2. Pleroma Conversations statuses can be requested by Conversation id.
|
||||
3. Pleroma Conversations can be replied to.
|
||||
|
||||
Conversations have the additional field "recipients" under the "pleroma" key. This holds a list of all the accounts that will receive a message in this conversation.
|
||||
|
||||
The status posting endpoint takes an additional parameter, `in_reply_to_conversation_id`, which, when set, will set the visiblity to direct and address only the people who are the recipients of that Conversation.
|
||||
|
||||
|
||||
## `GET /api/v1/pleroma/conversations/:id/statuses`
|
||||
### Timeline for a given conversation
|
||||
* Method `GET`
|
||||
* Authentication: required
|
||||
* Params: Like other timelines
|
||||
* Response: JSON, statuses (200 - healthy, 503 unhealthy).
|
||||
|
||||
|
||||
## `PATCH /api/v1/pleroma/conversations/:id`
|
||||
### Update a conversation. Used to change the set of recipients.
|
||||
* Method `PATCH`
|
||||
* Authentication: required
|
||||
* Params:
|
||||
* `recipients`: A list of ids of users that should receive posts to this conversation.
|
||||
* Response: JSON, statuses (200 - healthy, 503 unhealthy)
|
||||
|
Loading…
Reference in New Issue
Block a user