diff options
author | anoadragon453 <anoadragon453@users.noreply.github.com> | 2022-02-04 14:39:40 +0000 |
---|---|---|
committer | anoadragon453 <anoadragon453@users.noreply.github.com> | 2022-02-04 14:39:40 +0000 |
commit | ee0d41f8256fbcd831c87408d803b366d1391626 (patch) | |
tree | 8720adc6ee04378c3ed1589f4f2a13b25bbd0e8e /develop/admin_api | |
parent | deploy: 02632b3504ad4512c5f5a4f859b3fe326b19c788 (diff) | |
download | synapse-ee0d41f8256fbcd831c87408d803b366d1391626.tar.xz |
deploy: 65ef21b1c7b4297d6a7b2888de4cbfe198ac0324
Diffstat (limited to 'develop/admin_api')
-rw-r--r-- | develop/admin_api/media_admin_api.html | 2 | ||||
-rw-r--r-- | develop/admin_api/user_admin_api.html | 10 |
2 files changed, 10 insertions, 2 deletions
diff --git a/develop/admin_api/media_admin_api.html b/develop/admin_api/media_admin_api.html index aef1682ede..d632429210 100644 --- a/develop/admin_api/media_admin_api.html +++ b/develop/admin_api/media_admin_api.html @@ -184,6 +184,8 @@ <h1 id="querying-media"><a class="header" href="#querying-media">Querying media</a></h1> <p>These APIs allow extracting media information from the homeserver.</p> +<p>Details about the format of the <code>media_id</code> and storage of the media in the file system +are documented under <a href="../media_repository.html">media repository</a>.</p> <p>To use it, you will need to authenticate by providing an <code>access_token</code> for a server admin: see <a href="../usage/administration/admin_api">Admin API</a>.</p> <h2 id="list-all-media-in-a-room"><a class="header" href="#list-all-media-in-a-room">List all media in a room</a></h2> diff --git a/develop/admin_api/user_admin_api.html b/develop/admin_api/user_admin_api.html index d22366845d..952fed601c 100644 --- a/develop/admin_api/user_admin_api.html +++ b/develop/admin_api/user_admin_api.html @@ -655,7 +655,11 @@ member are returned.</p> <h2 id="user-media"><a class="header" href="#user-media">User media</a></h2> <h3 id="list-media-uploaded-by-a-user"><a class="header" href="#list-media-uploaded-by-a-user">List media uploaded by a user</a></h3> <p>Gets a list of all local media that a specific <code>user_id</code> has created. -By default, the response is ordered by descending creation date and ascending media ID. +These are media that the user has uploaded themselves +(<a href="../media_repository.html#local-media">local media</a>), as well as +<a href="../media_repository.html#url-previews">URL preview images</a> requested by the user if the +<a href="../development/url_previews.html">feature is enabled</a>.</p> +<p>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 <code>order_by</code> and <code>dir</code>.</p> <p>The API is:</p> @@ -749,7 +753,9 @@ Media objects contain the following fields: <ul> <li><code>created_ts</code> - integer - Timestamp when the content was uploaded in ms.</li> <li><code>last_access_ts</code> - integer - Timestamp when the content was last accessed in ms.</li> -<li><code>media_id</code> - string - The id used to refer to the media.</li> +<li><code>media_id</code> - string - The id used to refer to the media. Details about the format +are documented under +<a href="../media_repository.html">media repository</a>.</li> <li><code>media_length</code> - integer - Length of the media in bytes.</li> <li><code>media_type</code> - string - The MIME-type of the media.</li> <li><code>quarantined_by</code> - string - The user ID that initiated the quarantine request |