Go to file
Christian Pauly e15c21bea8 fix: Remove empty readme 2020-12-31 10:15:24 +01:00
example docs: Clean up 2020-12-30 12:46:02 +01:00
lib fix: Remove empty readme 2020-12-31 10:15:24 +01:00
test Initial commit 2020-12-28 12:01:03 +01:00
.gitignore Initial commit 2020-12-28 12:01:03 +01:00
.gitlab-ci.yml Initial commit 2020-12-28 12:01:03 +01:00
CHANGELOG.md Initial commit 2020-12-28 12:01:03 +01:00
CONTRIBUTING.md Initial commit 2020-12-28 12:01:03 +01:00
LICENSE Initial commit 2020-12-28 12:01:03 +01:00
README.md docs: Clean up 2020-12-30 12:46:02 +01:00
analysis_options.yaml Initial commit 2020-12-28 12:01:03 +01:00
pubspec.yaml docs: Clean up 2020-12-30 12:46:02 +01:00

README.md

Matrix API Lite

This package is a dead simple data model over the client-server specification of https://matrix.org and is mostly used as a base for a more complete Matrix SDK. It doesn't contain any logic and just provides methods for all API endpoints and json parser for all objects. It is intended to be as close to the specificaton as possible so we get a 1:1 relationship with the API. More complex logic like a sync loop or a data model for rooms should be implemented in a more complete Matrix SDK.

Usage

A simple usage example:

import 'package:matrix_api_lite/src/matrix_api.dart';

void main() async {
  final api = MatrixApi(homeserver: Uri.parse('https://matrix.org'));
  final capabilities = await api.requestServerCapabilities();
  print(capabilities.toJson());
}