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

Interface DeprecatedSyncApi

  • @Deprecated
@Path("/_matrix/client/r0")
@Consumes("application/json")
@Produces("application/json")
public interface DeprecatedSyncApi
    Deprecated.
    Warning: This API is deprecated and will be removed from a future release.

    • Method Detail

      • initialSync

        @Deprecated
@GET
@Path("/initialSync")
void initialSync​(@QueryParam("limit")
                 Long limit,
                 @QueryParam("archived")
                 Boolean archived,
                 @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)
        Deprecated.
        in favor of SyncApi.sync(String, String, Boolean, String, Long, UriInfo, HttpHeaders, AsyncResponse, SecurityContext).
        This returns the full state for this user, with an optional limit on the number of messages per room to return.
        This endpoint was deprecated in r0 of this specification. Clients should instead call the /sync API with no since parameter. See the migration guide.
        Requires auth: Yes.
        Return: DeprecatedInitialSyncResponse.

        Status code 200: The user's current state.

        Status code 404: There is no avatar URL for this user or this user does not exist.

        Parameters:
        limit - The maximum number of messages to return for each room.
        archived - Whether to include rooms that the user has left. If false then only rooms that the user has been invited to or has joined are included. If set to true then rooms that the user has left are included as well. By default this is false.
        uriInfo - Request Information.
        httpHeaders - Http headers.
        asyncResponse - Asynchronous response.
        securityContext - Security context.

      • event

        @Deprecated
@GET
@Path("/events/{eventId}")
void event​(@PathParam("eventId")
           String eventId,
           @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)
        Deprecated.
        in favor of EventApi.roomEvent(String, String, UriInfo, HttpHeaders, AsyncResponse, SecurityContext) or EventContextApi.context(String, String, Integer, UriInfo, HttpHeaders, AsyncResponse, SecurityContext).
        Get a single event based on event_id. You must have permission to retrieve this event e.g. by being a member in the room for this event.
        This endpoint was deprecated in r0 of this specification. Clients should instead call the /rooms/{roomId}/event/{eventId} API or the /rooms/{roomId}/context/{eventId} API.
        Requires auth: Yes.
        Return: Event.

        Status code 200: The full event.

        Status code 404: The event was not found or you do not have permission to read this event.

        Parameters:
        eventId - Required. The event ID to get.
        uriInfo - Request Information.
        httpHeaders - Http headers.
        asyncResponse - Asynchronous response.
        securityContext - Security context.

      • roomInitialSync

        @Deprecated
@GET
@Path("/rooms/{roomId}/initialSync")
void roomInitialSync​(@PathParam("roomId")
                     String roomId,
                     @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)
        Deprecated.
        in favor of SyncApi.sync(String, String, Boolean, String, Long, UriInfo, HttpHeaders, AsyncResponse, SecurityContext).
        Get a copy of the current state and the most recent messages in a room.
        This endpoint was deprecated in r0 of this specification. There is no direct replacement; the relevant information is returned by the /sync API. See the migration guide.
        Requires auth: Yes.
        Return: DeprecatedRoomInfo.

        Status code 200: The current state of the room.

        Status code 403: You aren't a member of the room and weren't previously a member of the room.

        Parameters:
        roomId - Required. The room to get the data.
        uriInfo - Request Information.
        httpHeaders - Http headers.
        asyncResponse - Asynchronous response.
        securityContext - Security context.