|
7 years ago | |
---|---|---|
docs/reference/matrix-glib | 7 years ago | |
src | 7 years ago | |
.gitignore | 7 years ago | |
AUTHORS | 7 years ago | |
COPYING | 7 years ago | |
Makefile.am | 7 years ago | |
NEWS | 7 years ago | |
README | 7 years ago | |
README.md | 7 years ago | |
autogen.sh | 7 years ago | |
configure.ac | 7 years ago |
README.md
Matrix Client SDK for GLib
This is a Matrix.org client-server SDK for GLib >= 2.40. It contains both raw API calls and a signal based asynchronous client. The API and ABI are both very volatile as of now; don’t rely on any specific feature until the API is frozen.
The main interfaces are MatrixAPI
and
MatrixClient
. MatrixHTTPAPI
and MatrixHTTPClient
implement these
interfaces, respectively and can communicate with an HTTP based
homeserver. If a new protocol becomes supported oficially, a new API
and Client
class will be added.
Usage
The SDK provides two layers of interaction. The low-level layer
(MatrixAPI
implementations like MatrixHTTPAPI
) just wraps the raw
API calls. The high-level layer (MatrixClient
implementations like
MatrixHTTPClient
) is a GMainLoop
based asynchronous object that
emits GObject
signals and uses the low-level layer to provide an
object model to perform actions on.
Client
The MatrixClient
interface is not fully planned yet.
API
For a full blown example, see test-client.c.