Quarantine Media

Endpoints

QuarantineMedia

Quarantining media means that it is marked as inaccessible by users. It applies to any local media, and any locally-cached copies of remote media.

The media file itself (and any thumbnails) is not deleted from the server.

Source code in matrix_admin_sdk/endpoints/v1/quarantine_media.py

class QuarantineMedia(Endpoint):
    """
    Quarantining media means that it is marked as inaccessible by users.
    It applies to any local media, and any locally-cached copies of remote media.

    The media file itself (and any thumbnails) is not deleted from the server.
    """

    async def quarantining_media_by_id(
        self, server_name: str, media_id: str
    ) -> Dict[Any, Any]:
        """
        This API quarantines a single piece of local or remote media.
        Args:
            server_name: e.g. example.org
            media_id: e.g. abcdefg12345...

        Returns: dictionary
        """
        url = self.url(f"media/quarantine/{server_name}/{media_id}")
        result = await self.request(RequestMethods.POST, url)
        return result

    async def remove_media_from_quarantine_by_id(
        self, server_name: str, media_id: str
    ) -> Dict[Any, Any]:
        """
        This API removes a single piece of local or remote media from quarantine.
        Args:
            server_name: e.g. example.org
            media_id: e.g. abcdefg12345...

        Returns: dictionary
        """
        url = self.url(f"media/unquarantine/{server_name}/{media_id}")
        result = await self.request(RequestMethods.POST, url)
        return result

    async def quarantining_media_in_room(self, room_id) -> Dict[str, int]:
        """
        This API quarantines all local and remote media in a room.
        Args:
            room_id: e.g. !roomid12345:example.org

        Returns: {"num_quarantined": 10}
        """
        url = self.url(f"room/{room_id}/media/quarantine")
        result = await self.request(RequestMethods.POST, url)
        return result

    async def quarantining_all_media_of_user(self, user_id: str) -> Dict[str, int]:
        """
        This API quarantines all local media that a local user has uploaded.
        That is to say, if you would like to quarantine media uploaded by
        a user on a remote homeserver, you should instead use one of the other APIs.
        Args:
            user_id: User ID in the form of @bob:example.org

        Returns: {"num_quarantined": 10}

        """
        url = self.url(f"user/{user_id}/media/quarantine")
        result = await self.request(RequestMethods.POST, url)
        return result

    async def protecting_media_from_being_quarantined(
        self, media_id: str
    ) -> Dict[Any, Any]:
        """
        This API protects a single piece of local media from being quarantined using
        the above APIs. This is useful for sticker packs and other shared media
        which you do not want to get quarantined, especially when quarantining
        media in a room.
        Args:
            media_id: in the form of abcdefg12345...

        Returns: dictionary
        """
        url = self.url(f"media/protect/{media_id}")
        result = await self.request(RequestMethods.POST, url)
        return result

    async def unprotecting_media_from_being_quarantined(
        self, media_id: str
    ) -> Dict[Any, Any]:
        """
        This API protects a single piece of local media from being quarantined using
        the above APIs. This is useful for sticker packs and other shared media
        which you do not want to get quarantined, especially when quarantining
        media in a room.
        Args:
            media_id: in the form of abcdefg12345...

        Returns: dictionary
        """
        url = self.url(f"media/unprotect/{media_id}")
        result = await self.request(RequestMethods.POST, url)
        return result

protecting_media_from_being_quarantined(self, media_id) async

This API protects a single piece of local media from being quarantined using the above APIs. This is useful for sticker packs and other shared media which you do not want to get quarantined, especially when quarantining media in a room.

Parameters:

Name	Type	Description	Default
media_id	str	in the form of abcdefg12345...	required

Source code in matrix_admin_sdk/endpoints/v1/quarantine_media.py

async def protecting_media_from_being_quarantined(
    self, media_id: str
) -> Dict[Any, Any]:
    """
    This API protects a single piece of local media from being quarantined using
    the above APIs. This is useful for sticker packs and other shared media
    which you do not want to get quarantined, especially when quarantining
    media in a room.
    Args:
        media_id: in the form of abcdefg12345...

    Returns: dictionary
    """
    url = self.url(f"media/protect/{media_id}")
    result = await self.request(RequestMethods.POST, url)
    return result

quarantining_all_media_of_user(self, user_id) async

This API quarantines all local media that a local user has uploaded. That is to say, if you would like to quarantine media uploaded by a user on a remote homeserver, you should instead use one of the other APIs.

Parameters:

Name	Type	Description	Default
user_id	str	User ID in the form of @bob:example.org	required

Source code in matrix_admin_sdk/endpoints/v1/quarantine_media.py

async def quarantining_all_media_of_user(self, user_id: str) -> Dict[str, int]:
    """
    This API quarantines all local media that a local user has uploaded.
    That is to say, if you would like to quarantine media uploaded by
    a user on a remote homeserver, you should instead use one of the other APIs.
    Args:
        user_id: User ID in the form of @bob:example.org

    Returns: {"num_quarantined": 10}

    """
    url = self.url(f"user/{user_id}/media/quarantine")
    result = await self.request(RequestMethods.POST, url)
    return result

quarantining_media_by_id(self, server_name, media_id) async

This API quarantines a single piece of local or remote media.

Parameters:

Name	Type	Description	Default
server_name	str	e.g. example.org	required
media_id	str	e.g. abcdefg12345...	required

Source code in matrix_admin_sdk/endpoints/v1/quarantine_media.py

async def quarantining_media_by_id(
    self, server_name: str, media_id: str
) -> Dict[Any, Any]:
    """
    This API quarantines a single piece of local or remote media.
    Args:
        server_name: e.g. example.org
        media_id: e.g. abcdefg12345...

    Returns: dictionary
    """
    url = self.url(f"media/quarantine/{server_name}/{media_id}")
    result = await self.request(RequestMethods.POST, url)
    return result

quarantining_media_in_room(self, room_id) async

This API quarantines all local and remote media in a room.

Parameters:

Name	Type	Description	Default
room_id		e.g. !roomid12345:example.org	required

Source code in matrix_admin_sdk/endpoints/v1/quarantine_media.py

async def quarantining_media_in_room(self, room_id) -> Dict[str, int]:
    """
    This API quarantines all local and remote media in a room.
    Args:
        room_id: e.g. !roomid12345:example.org

    Returns: {"num_quarantined": 10}
    """
    url = self.url(f"room/{room_id}/media/quarantine")
    result = await self.request(RequestMethods.POST, url)
    return result

remove_media_from_quarantine_by_id(self, server_name, media_id) async

This API removes a single piece of local or remote media from quarantine.

Parameters:

Name	Type	Description	Default
server_name	str	e.g. example.org	required
media_id	str	e.g. abcdefg12345...	required

Source code in matrix_admin_sdk/endpoints/v1/quarantine_media.py

async def remove_media_from_quarantine_by_id(
    self, server_name: str, media_id: str
) -> Dict[Any, Any]:
    """
    This API removes a single piece of local or remote media from quarantine.
    Args:
        server_name: e.g. example.org
        media_id: e.g. abcdefg12345...

    Returns: dictionary
    """
    url = self.url(f"media/unquarantine/{server_name}/{media_id}")
    result = await self.request(RequestMethods.POST, url)
    return result

unprotecting_media_from_being_quarantined(self, media_id) async

This API protects a single piece of local media from being quarantined using the above APIs. This is useful for sticker packs and other shared media which you do not want to get quarantined, especially when quarantining media in a room.

Parameters:

Name	Type	Description	Default
media_id	str	in the form of abcdefg12345...	required

Source code in matrix_admin_sdk/endpoints/v1/quarantine_media.py

async def unprotecting_media_from_being_quarantined(
    self, media_id: str
) -> Dict[Any, Any]:
    """
    This API protects a single piece of local media from being quarantined using
    the above APIs. This is useful for sticker packs and other shared media
    which you do not want to get quarantined, especially when quarantining
    media in a room.
    Args:
        media_id: in the form of abcdefg12345...

    Returns: dictionary
    """
    url = self.url(f"media/unprotect/{media_id}")
    result = await self.request(RequestMethods.POST, url)
    return result