All Classes

Class	Description
AccountApi	Account registration and management.
AccountApi.RegisterType	The kind of account to register.
AccountData	Account data.
AdminApi	Gets information about a particular user.
AdminResponse	Response for gets information about a particular user.
Api	Open API definition.
AuthApi	A client can obtain access tokens using the /login API.
AuthApi.AuthType	Authentication types.
AuthApi.IdentifierType	Identifier types.
AuthenticationData	Authentication Data.
AuthenticationFlows	Authentication flow.
AuthenticationStage	Stages.
AvailableResponse	JSON response for available api.
AvatarUrl	JSON body request for profile api.
CapabilitiesApi	A homeserver may not support certain operations and clients must be able to query for what the homeserver can and can't offer.
CapabilitiesResponse	Capabilities response.
ChangePasswordCapability	Capability to indicate if the user can change their password.
ChangesResponse	The list of users who updated their devices.
ClaimRequest	JSON body parameters for Claims one-time keys for use in pre-key messages.
ClaimResponse	Response format.
ClientConfigApi	Client Behaviour.
ConnectionInfo	Connection info.
ContentApi	This module allows users to upload content to their homeserver which is retrievable from other homeservers.
ContentApi.Method	The desired resizing method.
ContentConfig	Content config.
ContentUri	The MXC URI for the uploaded content.
CreateRoomRequest	JSON body request for creation api.
DeactivateRequest	Request for deactivate the user's account, removing all ability for the user to login again.
DeactivateResponse	Deactivate response.
DeactivateResponse.UnbindResult	Id server unbind results.
Delete3PidRequest	JSON body request to delete 3pid.
DeprecatedInitialSyncResponse	Deprecated. in favor of SyncApi.sync(String, String, Boolean, String, Long, javax.ws.rs.core.UriInfo, javax.ws.rs.core.HttpHeaders, AsyncResponse, SecurityContext).
DeprecatedRoomInfo	Deprecated. in favor of SyncApi.sync(String, String, Boolean, String, Long, javax.ws.rs.core.UriInfo, javax.ws.rs.core.HttpHeaders, AsyncResponse, SecurityContext).
DeprecatedSyncApi	Deprecated.
Device	Device.
DeviceApi	Clients that implement this module should offer the user a list of registered devices, as well as the means to update their display names.
DeviceDeleteRequest	Additional authentication information for the user-interactive authentication API.
DeviceInfo	Device info.
DeviceKeys	Device Keys.
DeviceLists	Device lists.
DevicesDeleteRequest	JSON body request for bulk devices delete.
DevicesResponse	Information about all devices for the current user.
DeviceUpdateRequest	The new display name for this device.
DisplayName	JSON body request for profile api.
EmailRequestToken	Request for the proxies the identity server API validate/email/requestToken.
EncryptionApi	Matrix optionally supports end-to-end encryption, allowing rooms to be created whose conversation contents is not decryptable or interceptable on any of the participating homeservers.
Ephemeral	Ephemeral.
EventApi	There are several APIs provided to GET events for a room.
EventContext	Event context.
EventContextApi	This API returns a number of events that happened just before and after the specified event.
EventContextResponse	Events that happened just before and after the specified event.
EventContextResponse	Event context.
EventFilter	Filter.
FallbackAuthApi	If a client does not recognize any or all login flows it can use the fallback login API.
Filter	Filter.
FilterApi	Filters can be created on the server and can be passed as as a parameter to APIs which return events.
FilterData	JSON body request for filter api (create filter).
FilterData.EventFormat	Event formats.
FilterResponse	JSON body response.
Group	Group.
Groupings	Groupings.
GroupValue	Group value.
HomeserverInfo	Homeserver information.
Identifier	Some authentication mechanisms use a user identifier object to identify a user.
IdentityServerInfo	Identity Server information.
Invite3pid	Invite 3pid.
InvitedRoom	Invite room.
InviteRequest	Invite request.
InviteState	Invite state.
JoinedMembersResponse	Joined room members.
JoinedRoom	Joined room.
JoinedRoomsResponse	JSON body resposnse with joined rooms.
JoinRequest	Join request.
KickRequest	Kick JSON body request.
LeftRoom	Left room.
LoginRequest	Authenticates the user, and issues an access token they can use to authorize themself in subsequent requests.
LoginResponse	Response for the login request.
LoginType	Login type.
MembersResponse	The list of members for this room.
MsisdnRequestToken	Request for the proxies the identity server API validate/msisdn/requestToken.
NewVersion	The new version for the room.
Notification	Notification.
NotificationResponse	JSON body response for push notifications.
OpenIdApi	This module allows users to verify their identity with a third party service.
OpenIdResponse	JSON body response of the OpenID API.
PasswordRequest	Request for changes the password for an account on this homeserver.
PhoneIdentifier	The user is identified by a phone number.
Presence	PresenceContent.
PresenceApi	Each user has the concept of presence information.
PresenceRequest	JSON body request for presence api.
PresenceStatus	JSON body request for presence api.
PresenceStatus.PresenceType	PresenceContent types.
Profile	JSON body for profile api (profile).
ProfileApi	Profiles.
PublicRoomsChunk	Public rooms chunk.
PublicRoomsFilter	Search filter.
PublicRoomsRequest	JSON body request.
PublicRoomsResponse	JSON body response.
PushActions	JSON body request/response for action push api.
PushApi	This module adds support for push notifications.
PushApi.Actions	All rules have an associated list of actions.
PushApi.Condition	Override, Underride and Default Rules MAY have a list of 'conditions'.
PushApi.Kind	Kind of the push rules.
PushApi.Rule	Homeservers can specify "server-default rules" which operate at a lower priority than "user-defined rules".
PushApi.Tweak	The set_tweak action is used to add an entry to the 'tweaks' dictionary that is sent in the notification request to the Push Gateway.
PushEnable	JSON body request/response for enable/disable push api.
Pusher	Pusher.
PushersRequest	JSON body request to create a new pusher.
PushersResponse	Pusher list.
PushRulesResponse	JSON body response for push api.
PushUpdateRequest	JSON body request for push update api.
QueryRequest	JSON body parameters for Returns the current devices and identity keys for the given users.
QueryResponse	Response format.
ReadMarkersRequest	JSON body of the read marker request.
ReceiptApi	This module adds in support for receipts.
ReceiptApi.Receipt	ReceiptContent types.
RedactRequest	Request for the redaction.
RegisterRequest	Request for register for an account on this homeserver.
ReplacementRoom	The ID of the new room.
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.
ReportRequest	JSON Body for report request.
RequestCategories	Categories.
ResponseCategories	Response categories.
Result	Search result.
RoomApi	Rooms API.
RoomApi.Preset	Presets.
RoomApi.Visibility	Visibility.
RoomEventFilter	Room event filter.
RoomEventResults	Room events results.
RoomEventsCriteria	Room events.
RoomEventsCriteria.Key	The keys to search.
RoomEventsCriteria.Order	Order.
RoomFilter	Room filter.
RoomId	JSON body with roomId used in the room apis.
RoomMember	Room member.
RoomResolveResponse	JSON body response of the room response api.
Rooms	Rooms.
RoomSummary	Room summary.
RoomVersionsCapability	The room versions the server supports.
RoomVersionsCapability.Availability	Available values of the `available` property.
RoomVisibility	JSON body request and response for listing room api.
SearchApi	The search API allows clients to perform full text search across events in all rooms that the user has been in, including those that they have left.
SearchRequest	JSON body request for search api.
SearchRequest	JSON body request for user directory api (search).
SearchResponse	JSON body response for search api.
SearchResponse	JSON body response for user directory api (search result).
SendEventResponse	Sent event.
SendToDeviceApi	This module provides a means by which clients can exchange signalling messages without them being stored permanently as part of a shared communication history.
SendToDeviceRequest	Sent to device body request.
ServerDiscoveryApi	In order to allow users to connect to a Matrix server without needing to explicitly specify the homeserver's URL or other parameters, clients SHOULD use an auto-discovery mechanism to determine the server's URL based on a user's Matrix ID.
ServerDiscoveryResponse	Server discovery information.
SessionInfo	Session info.
SsoApi	Single Sign-On (SSO) is a generic term which refers to protocols which allow users to log into applications via a single web-based authentication portal.
State	State.
SupportedLoginResponse	Supported login types.
SyncApi	To read events, the intended flow of operation is for clients to first call the /sync API without a since parameter.
SyncApi.Presence	PresenceContent.
SyncResponse	JSON body response for sync api.
TagApi	Users can add tags to rooms.
TagApi.Tag	TagInfo special names.
Tags	TagInfo request.
ThirdpartyIdentifier	The user is identified by a third-party identifer in canonicalised form.
ThirdPartyIdentifier	Request for gets a list of the third party identifiers that the homeserver has associated with the user's account.
ThirdPartyProtocolApi	Application services can provide access to third party networks via bridging.
ThirdPartySigned	Third party signed.
ThreePidCred	3Pid credentials.
ThreePidRequest	Request for adds contact information to the user's account.
ThreePidResponse	Response for gets a list of the third party identifiers that the homeserver has associated with the user's account.
Timeline	Timeline.
ToDevice	To device.
TypingApi	When a client receives an m.typing event, it MUST use the user ID list to REPLACE its knowledge of every user who is currently typing.
TypingRequest	TypingContent body request.
UnbanRequest	Unban JSON body request.
UnreadNotificationCounts	Unread notification counts.
UnsignedDeviceInfo	UnsignedDeviceInfo.
UploadRequest	JSON body parameters for Publishes end-to-end encryption keys for the device.
UploadResponse	Response format.
User	JSON body response for user directory api (User).
UserDirectoryApi	User directory.
UserIdentifier	The user is identified by their Matrix ID.
UserInteractiveData	In the REST API described in this specification, authentication works by the client and server exchanging JSON dictionaries.
VersionApi	Gets the versions of the specification supported by the server.
VersionsResponse	The versions supported by the server.
VoipApi	The homeserver MAY provide a TURN server which clients can use to contact the remote party.
VoipResponse	The TURN server credentials.
WhoamiResponse	Response for gets information about the owner of a given access token.