Go to file
Christian Pauly 5f46a75d10 chore: Bump version 2021-01-08 13:03:06 +01:00
example docs: Clean up 2020-12-30 12:46:02 +01:00
lib fix: Cast instead of shallow copy 2021-01-08 12:55:45 +01:00
test feat: Implement plaintext parsing 2021-01-08 10:54:04 +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 chore: Bump version 2021-01-08 13:03:06 +01:00
CONTRIBUTING.md docs: Update Contributing 2020-12-31 10:19:50 +01:00
LICENSE Add LICENSE 2021-01-04 09:27:45 +00: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 chore: Bump version 2021-01-08 13:03:06 +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());
}