Namespace

CM – 0

A Matrix Client Library

Version0.0.3-dev
AuthorsPurism SPC
LicenseLGPL-2.1-or-later
Websitehttps://source.puri.sm/Librem5/libcmatrix
Sourcehttps://source.puri.sm/Librem5/libcmatrix

Build

pkg-config filescmatrix-0

Dependencies

GObject—2.0 The base type system library
Browse documentation

Additional documentation

Classes

Account

since: 0

Client

A Matrix client.

since: 0

Event

since: 0

Matrix

The main matrix object.

since: 0

Pusher

Configuration for a server side pusher.

since: 0.0.1

Room

A Matrix room. This class provides access to properties of the room including a list of events maintained as a GListModel.

since: 0

RoomEvent

An event that is associated with a matrix room like e.g. a topic change or member event. Basically Matrix message of type m.room.*.

since: 0

RoomMessageEvent

since: 0

User

since: 0

VerificationEvent

since: 0

Structs

Db

since: 0

Olm

since: 0

RoomMember

since: 0

UserList

Track all users that belongs to the account.

since: 0

Enumerations

ContentType

since: 0

EventState

since: 0

EventType

The type of a Matrix event.

since: 0

PusherKind

The type of a CmPusher

since: 0

Status

since: 0

Error Domains

Error

The Error returned by the Matrix Server See https://matrix.org/docs/spec/client_server/r0.6.1#api-standards for details.

since: 0

Callbacks

Callback

Type definition for the function that will be called when the client sees new events.

since: 0

Functions

init

This function should be called to initialize the library. You may call this in main()

since: 0

utils_get_homeserver_async

Get homeserver from the given username. username should be in complete form (eg: user:example.org)

since: 0.0.2

utils_get_homeserver_finish

Finish call to cm_utils_get_homeserver_async().

since: 0.0.2

utils_get_homeserver_sync

Get homeserver from the given username. username should be in complete form (eg: user:example.org)

since: 0.0.2