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

Interface UserDirectoryApi

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

User directory.
Provides search over all users.

Method Summary

Modifier and Type	Method	Description
void	searchUsers(SearchRequest request, javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.HttpHeaders httpHeaders, javax.ws.rs.container.AsyncResponse asyncResponse, javax.ws.rs.core.SecurityContext securityContext)	Performs a search for users on the homeserver.

Method Detail

searchUsers

@POST
@Path("/search")
void searchUsers(SearchRequest request,
                 @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)

Performs a search for users on the homeserver. The homeserver may determine which subset of users are searched, however the homeserver MUST at a minimum consider the users the requesting user shares a room with and those who reside in public rooms (known to the homeserver). The search MUST consider local users to the homeserver, and SHOULD query remote users as part of the search.
The search is performed case-insensitively on user IDs and display names preferably using a collation determined based upon the Accept-Language header provided in the request, if present.
Rate-limited: Yes.
Requires auth: Yes.
Return: SearchResponse.

Status code 200: The results of the search.

Status code 429: This request was rate-limited.

Parameters:

request - JSON body request.

uriInfo - Request Information.

httpHeaders - Http headers.

asyncResponse - Asynchronous response.

securityContext - Security context.