Interface EventContextApi


  • @Path("/_matrix/client/r0/rooms")
    @Produces("application/json")
    public interface EventContextApi
    This API returns a number of events that happened just before and after the specified event. This allows clients to get the context surrounding an event.
    • Method Summary

      Modifier and Type Method Description
      void context​(String roomId, String eventId, Integer limit, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.container.AsyncResponse asyncResponse, javax.ws.rs.core.SecurityContext securityContext)
      This API returns a number of events that happened just before and after the specified event.
    • Method Detail

      • context

        @GET
        @Path("/{roomId}/context/{eventId}")
        void context​(@PathParam("roomId")
                     String roomId,
                     @PathParam("eventId")
                     String eventId,
                     @QueryParam("limit")
                     Integer limit,
                     @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)
        This API returns a number of events that happened just before and after the specified event. This allows clients to get the context surrounding an event.
        Requires auth: Yes.
        Return: EventContextResponse.

        Status code 200: The events and state surrounding the requested event.

        Parameters:
        roomId - Required. The room to get events from.
        eventId - Required. The event to get context around.
        limit - The maximum number of events to return. Default: 10.
        uriInfo - Request Information.
        httpHeaders - Http headers.
        asyncResponse - Asynchronous response.
        securityContext - Security context.