Clarify that users' media are also preview images (#11862)

This commit is contained in:
Dirk Klimpel 2022-02-04 15:39:14 +01:00 committed by GitHub
parent a3865ed525
commit 65ef21b1c7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 1 deletions

1
changelog.d/11862.doc Normal file
View File

@ -0,0 +1 @@
Document images returned by the User List Media Admin API can include those generated by URL previews.

View File

@ -2,6 +2,9 @@
These APIs allow extracting media information from the homeserver. These APIs allow extracting media information from the homeserver.
Details about the format of the `media_id` and storage of the media in the file system
are documented under [media repository](../media_repository.md).
To use it, you will need to authenticate by providing an `access_token` To use it, you will need to authenticate by providing an `access_token`
for a server admin: see [Admin API](../usage/administration/admin_api). for a server admin: see [Admin API](../usage/administration/admin_api).

View File

@ -539,6 +539,11 @@ The following fields are returned in the JSON response body:
### List media uploaded by a user ### List media uploaded by a user
Gets a list of all local media that a specific `user_id` has created. Gets a list of all local media that a specific `user_id` has created.
These are media that the user has uploaded themselves
([local media](../media_repository.md#local-media)), as well as
[URL preview images](../media_repository.md#url-previews) requested by the user if the
[feature is enabled](../development/url_previews.md).
By default, the response is ordered by descending creation date and ascending media ID. By default, the response is ordered by descending creation date and ascending media ID.
The newest media is on top. You can change the order with parameters The newest media is on top. You can change the order with parameters
`order_by` and `dir`. `order_by` and `dir`.
@ -635,7 +640,9 @@ The following fields are returned in the JSON response body:
Media objects contain the following fields: Media objects contain the following fields:
- `created_ts` - integer - Timestamp when the content was uploaded in ms. - `created_ts` - integer - Timestamp when the content was uploaded in ms.
- `last_access_ts` - integer - Timestamp when the content was last accessed in ms. - `last_access_ts` - integer - Timestamp when the content was last accessed in ms.
- `media_id` - string - The id used to refer to the media. - `media_id` - string - The id used to refer to the media. Details about the format
are documented under
[media repository](../media_repository.md).
- `media_length` - integer - Length of the media in bytes. - `media_length` - integer - Length of the media in bytes.
- `media_type` - string - The MIME-type of the media. - `media_type` - string - The MIME-type of the media.
- `quarantined_by` - string - The user ID that initiated the quarantine request - `quarantined_by` - string - The user ID that initiated the quarantine request