Package io.github.ma1uta.matrix.identity.api

Interface LookupApi

  • @Path("/_matrix/identity/api/v1")
@Consumes("application/json")
@Produces("application/json")
public interface LookupApi
    Association lookup.

    • Method Summary

      Modifier and Type Method Description
      void bulkLookup​(BulkLookupRequest request, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.container.AsyncResponse asyncResponse)
      Lookup Matrix user IDs for a list of 3pids.
      void lookup​(String medium, String address, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.container.AsyncResponse asyncResponse)
      Look up the Matrix user ID for a 3pid.

    • Method Detail

      • lookup

        @GET
@Path("/lookup")
void lookup​(@QueryParam("medium")
            String medium,
            @QueryParam("address")
            String address,
            @Context
            javax.ws.rs.core.UriInfo uriInfo,
            @Context
            javax.ws.rs.core.HttpHeaders httpHeaders,
            @Suspended
            javax.ws.rs.container.AsyncResponse asyncResponse)
        Look up the Matrix user ID for a 3pid.
        Return: LookupResponse.

        Status code 200: The association for that 3pid, or the empty object if no association is known.

        Parameters:
        medium - Required. The medium type of the 3pid. See the 3PID Types Appendix.
        address - Required. The address of the 3pid being looked up. See the 3PID Types Appendix.
        uriInfo - Request information.
        httpHeaders - Http headers.
        asyncResponse - Asynchronous response.

      • bulkLookup

        @POST
@Path("/bulk_lookup")
void bulkLookup​(BulkLookupRequest request,
                @Context
                javax.ws.rs.core.UriInfo uriInfo,
                @Context
                javax.ws.rs.core.HttpHeaders httpHeaders,
                @Suspended
                javax.ws.rs.container.AsyncResponse asyncResponse)
        Lookup Matrix user IDs for a list of 3pids.
        Return: BulkLookupResponse.

        Status code 200: A list of known 3PID mappings for the supplied 3PIDs.

        Parameters:
        request - Required. An array of arrays containing the 3PID Types with the medium in first position and the address in second position.
        uriInfo - Request information.
        httpHeaders - Http headers.
        asyncResponse - Asynchronous response.