gh-pages
anoadragon453 2022-02-04 14:39:40 +00:00
parent 1aeeabb847
commit ee0d41f825
5 changed files with 22 additions and 6 deletions

View File

@ -184,6 +184,8 @@
<h1 id="querying-media"><a class="header" href="#querying-media">Querying media</a></h1> <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>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> <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> 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> <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>

View File

@ -655,7 +655,11 @@ member are returned.</p>
<h2 id="user-media"><a class="header" href="#user-media">User media</a></h2> <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> <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. <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 The newest media is on top. You can change the order with parameters
<code>order_by</code> and <code>dir</code>.</p> <code>order_by</code> and <code>dir</code>.</p>
<p>The API is:</p> <p>The API is:</p>
@ -749,7 +753,9 @@ Media objects contain the following fields:
<ul> <ul>
<li><code>created_ts</code> - integer - Timestamp when the content was uploaded in ms.</li> <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>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_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>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 <li><code>quarantined_by</code> - string - The user ID that initiated the quarantine request

View File

@ -9455,6 +9455,8 @@ have a canonical alias set.</li>
</ul> </ul>
<div id="chapter_begin" style="break-before: page; page-break-before: always;"></div><h1 id="querying-media"><a class="header" href="#querying-media">Querying media</a></h1> <div id="chapter_begin" style="break-before: page; page-break-before: always;"></div><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>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="admin_api/../media_repository.html">media repository</a>.</p>
<p>To use it, you will need to authenticate by providing an <code>access_token</code> <p>To use it, you will need to authenticate by providing an <code>access_token</code>
for a server admin: see <a href="admin_api/../usage/administration/admin_api">Admin API</a>.</p> for a server admin: see <a href="admin_api/../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> <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>
@ -11427,7 +11429,11 @@ member are returned.</p>
<h2 id="user-media"><a class="header" href="#user-media">User media</a></h2> <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> <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. <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="admin_api/../media_repository.html#local-media">local media</a>), as well as
<a href="admin_api/../media_repository.html#url-previews">URL preview images</a> requested by the user if the
<a href="admin_api/../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 The newest media is on top. You can change the order with parameters
<code>order_by</code> and <code>dir</code>.</p> <code>order_by</code> and <code>dir</code>.</p>
<p>The API is:</p> <p>The API is:</p>
@ -11521,7 +11527,9 @@ Media objects contain the following fields:
<ul> <ul>
<li><code>created_ts</code> - integer - Timestamp when the content was uploaded in ms.</li> <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>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="admin_api/../media_repository.html">media repository</a>.</li>
<li><code>media_length</code> - integer - Length of the media in bytes.</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>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 <li><code>quarantined_by</code> - string - The user ID that initiated the quarantine request

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long