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

Client API interfaces.

Interface Summary

Interface	Description
AccountApi	Account registration and management.
AdminApi	Gets information about a particular user.
Api	Open API definition.
AuthApi	A client can obtain access tokens using the /login 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.
ClientConfigApi	Client Behaviour.
ContentApi	This module allows users to upload content to their homeserver which is retrievable from other homeservers.
DeprecatedSyncApi	Deprecated.
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.
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.
EventApi	There are several APIs provided to GET events for a room.
EventContextApi	This API returns a number of events that happened just before and after the specified event.
FallbackAuthApi	If a client does not recognize any or all login flows it can use the fallback login API.
FilterApi	Filters can be created on the server and can be passed as as a parameter to APIs which return events.
OpenIdApi	This module allows users to verify their identity with a third party service.
PresenceApi	Each user has the concept of presence information.
ProfileApi	Profiles.
PushApi	This module adds support for push notifications.
ReceiptApi	This module adds in support for receipts.
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.
RoomApi	Rooms 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.
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.
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.
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.
SyncApi	To read events, the intended flow of operation is for clients to first call the /sync API without a since parameter.
TagApi	Users can add tags to rooms.
ThirdPartyProtocolApi	Application services can provide access to third party networks via bridging.
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.
UserDirectoryApi	User directory.
VersionApi	Gets the versions of the specification supported by the server.
VoipApi	The homeserver MAY provide a TURN server which clients can use to contact the remote party.

Class Summary

Class	Description
AccountApi.RegisterType	The kind of account to register.
AuthApi.AuthType	Authentication types.
AuthApi.IdentifierType	Identifier types.
ContentApi.Method	The desired resizing method.
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.
ReceiptApi.Receipt	ReceiptContent types.
RoomApi.Preset	Presets.
RoomApi.Visibility	Visibility.
SyncApi.Presence	PresenceContent.
TagApi.Tag	TagInfo special names.