Go to file
Nicolas Werner 13b4598c83 feat: Authenticate media downloads
This is not strictly required by the spec, but it improves security to
require auth for media downloads on your homeserver. I enabled that on
my servers now and plan to MSC that soon. This is required for people on
my servers to see images and other content now.
2022-05-16 08:14:48 +02:00
example refactor: mostly use dart_openapi_codegen 2021-06-25 12:40:03 +02:00
lib feat: Authenticate media downloads 2022-05-16 08:14:48 +02:00
test chore: Update to matrix v1.2 2022-05-06 15:14:12 +00:00
.gitignore chore: Update to matrix v1.2 2022-05-06 15:14:12 +00:00
.gitlab-ci.yml ci: add rm /docs and publish --force 2021-09-15 09:22:42 +00:00
CHANGELOG.md chore: Bump version 2022-05-09 08:25:25 +00: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 refactor: mostly use dart_openapi_codegen 2021-06-25 12:40:03 +02:00
pubspec.yaml chore: Bump version 2022-05-09 08:25:25 +00: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.