Go to file
Nicolas Werner 1719bcec9e chore: add pushrules to the event types 2022-10-14 12:31:05 +00:00
example refactor: mostly use dart_openapi_codegen 2021-06-25 12:40:03 +02:00
lib chore: add pushrules to the event types 2022-10-14 12:31:05 +00:00
test fix: Edge case where MatrixException.error differs from errcode 2022-10-14 14:22:13 +02:00
.gitignore fix: Fixed dysfunctional key-verification (Emoji+manual) 2022-08-26 09:48:11 +02:00
.gitlab-ci.yml refactor: Remove unused api docs job 2022-08-29 08:41:38 +00:00
CHANGELOG.md chore: Bump version 2022-08-29 10:33:16 +02:00
CONTRIBUTING.md fix: Typo and wellknown parsing 2021-03-01 11:38:53 +01:00
LICENSE docs: Update license to MIT 2021-01-08 13:14:03 +01:00
README.md docs: Update spec link in README 2022-05-06 15:14:12 +00:00
analysis_options.yaml chore: strict casts 2022-08-20 17:26:16 +02:00
pubspec.yaml chore: Bump version 2022-08-29 10:33:16 +02: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());
}

Generated code

The files in lib/src/generated are generated by dart_openapi_codegen from matrix-spec. See the README.md in dart_openapi_codegen for more information.