GLib based library to communicate with Matrix.org homeservers
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Gergely Polonkai 9a93dc6c2f Make documentation generate 1 year ago
docs Make documentation generate 1 year ago
src Generate the pkg-config file from Meson 1 year ago
vapi Remove the refresh_token 1 year ago
.gitignore Move from valadoc generation to GTK-Doc 1 year ago
AUTHORS Add AUTHORS, NEWS and README files 3 years ago
CODE_OF_CONDUCT.md Add code of conduct and contact to README 3 years ago
CONTRIBUTING.md Add contribution details 3 years ago
COPYING Add COPYING file 3 years ago
NEWS Add AUTHORS, NEWS and README files 3 years ago
README Add AUTHORS, NEWS and README files 3 years ago
README.md Remove the refresh_token 1 year ago
meson.build Generate the pkg-config file from Meson 1 year ago
meson_options.txt Stop meson building the test clients by default 1 year 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

For a working example, see test-client.c.

// Create a client object
MatrixClient *client = MATRIX_CLIENT(matrix_http_client_new("http://localhost:8008"));

// Set tokens for the session. Alternatively you may want to login with matrix_api_login() or matrix_client_login_with_password()
matrix_api_set_token(MATRIX_API(client), "your_access_token");

// Connect a callback that gets called when a m.room.message event arrives
matrix_client_connect_event(client, MATRIX_EVENT_TYPE_ROOM_MESSAGE, message_callback, NULL);

// Enter polling mode. This continuously calls the /sync API
matrix_client_begin_polling(client);

// Now enter a main loop with g_main_loop_run() so polling for events can actually begin

API

For a full blown example, see test-api-client.c.

Contribution

See the file CONTRIBUTING.md for details.

Code of Conduct

See the file CODE_OF_CONDUCT.md for details.

Contact

Should you need any help, join us in Matrix at #matrix-glib-sdk:polonkai.eu.