Package io.github.ma1uta.matrix.client.api

Interface ReportApi

@Path("/_matrix/client/r0")
@Consumes("application/json")
@Produces("application/json")
public interface ReportApi

Users may encounter content which they find inappropriate and should be able to report it to the server administrators or room moderators for review. This module defines a way for users to report content.
Content is reported based upon a negative score, where -100 is "most offensive" and 0 is "inoffensive".

Method Summary

Modifier and Type	Method	Description
void	report(String roomId, String eventId, ReportRequest reportRequest, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.container.AsyncResponse asyncResponse, javax.ws.rs.core.SecurityContext securityContext)	Reports an event as inappropriate to the server, which may then notify the appropriate people.

Method Detail

report

@POST
@Path("/rooms/{roomId}/report/{eventId}")
void report(@PathParam("roomId")
            String roomId,
            @PathParam("eventId")
            String eventId,
            ReportRequest reportRequest,
            @Context
            javax.ws.rs.core.UriInfo uriInfo,
            @Context
            javax.ws.rs.core.HttpHeaders httpHeaders,
            @Suspended
            javax.ws.rs.container.AsyncResponse asyncResponse,
            @Context
            javax.ws.rs.core.SecurityContext securityContext)

Reports an event as inappropriate to the server, which may then notify the appropriate people.
Requires auth: Yes.
Return: EmptyResponse.

Status code 200: The event has been reported successfully.

Parameters:

roomId - Required. The room in which the event being reported is located.

eventId - Required. The event to report.

reportRequest - JSON body request.

uriInfo - Request Information.

httpHeaders - Http headers.

asyncResponse - Asynchronous response.

securityContext - Security context.