Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Clarify that users' media are also preview images #11862

Merged
merged 6 commits into from
Feb 4, 2022
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/11862.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify that users' media are also preview images.
dklimpel marked this conversation as resolved.
Show resolved Hide resolved
3 changes: 3 additions & 0 deletions docs/admin_api/media_admin_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@

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 in the section about the [media repository](../media_repository.md).
dklimpel marked this conversation as resolved.
Show resolved Hide resolved

## List all media in a room

This API gets a list of known media in a room.
Expand Down
9 changes: 8 additions & 1 deletion docs/admin_api/user_admin_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -564,6 +564,11 @@ The following fields are returned in the JSON response body:

### List media uploaded by a user
Gets a list of all local media that a specific `user_id` has created.
These are media that the user has uploaded himself
dklimpel marked this conversation as resolved.
Show resolved Hide resolved
([local media](../media_repository.md#local-media)), as well as
[preview images](../media_repository.md#url-previews) if the
dklimpel marked this conversation as resolved.
Show resolved Hide resolved
[feature is enabled](../development/url_previews.md).

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
`order_by` and `dir`.
Expand Down Expand Up @@ -663,7 +668,9 @@ The following fields are returned in the JSON response body:
Media objects contain the following fields:
- `created_ts` - integer - Timestamp when the content was uploaded 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
of the `media_id` are documented in the section about the
dklimpel marked this conversation as resolved.
Show resolved Hide resolved
[media repository](../media_repository.md).
- `media_length` - integer - Length of the media in bytes.
- `media_type` - string - The MIME-type of the media.
- `quarantined_by` - string - The user ID that initiated the quarantine request
Expand Down