Go to file
Christian Pauly 8db8972c2f Merge branch 'soru/fix-key-sharing' into 'master'
fix key request sending

See merge request famedly/famedlysdk!345
2020-06-12 12:32:43 +00:00
.gitlab Add new file 2020-02-03 08:34:53 +00:00
doc Update doc/book.toml, doc/src/SUMMARY.md, doc/src/readme.md, employee-handbook_mermaid.css, employee-handbook_mermaid-init.js, employee-handbook_mermaid.min.js files 2020-05-17 08:01:09 +00:00
home Update doc/book.toml, doc/src/SUMMARY.md, doc/src/readme.md, employee-handbook_mermaid.css, employee-handbook_mermaid-init.js, employee-handbook_mermaid.min.js files 2020-05-17 08:01:09 +00:00
lib fix key request sending 2020-06-12 12:32:42 +00:00
test Fix state attack 2020-06-10 14:17:57 +00:00
test_driver split encryption stuff to other library 2020-06-04 13:39:51 +02:00
.gitignore Make coverage visible again 2020-05-19 09:28:13 +00:00
.gitlab-ci.yml Update Dart Version 2020-06-09 10:10:23 +00:00
.metadata Initial commit 2019-06-09 12:16:48 +02:00
CHANGELOG.md Add description 2019-06-09 12:20:59 +02:00
CONTRIBUTING.md Add code formatting CI job 2020-05-22 10:12:18 +00:00
LICENSE Update LICENSE 2019-06-09 11:36:59 +00:00
README.md [Readme] update 2020-01-04 10:21:54 +00:00
analysis_options.yaml Init matrix_api library 2020-06-03 10:16:01 +00:00
prepare.sh [SDK] Add dart-olm library and update CI 2020-02-15 07:48:41 +00:00
pubspec.lock Revert "test coverage thing" 2020-06-05 15:42:13 +02:00
pubspec.yaml Revert "test coverage thing" 2020-06-05 15:42:13 +02:00
test.sh Revert "test coverage thing" 2020-06-05 15:42:13 +02:00

README.md

+++ This SDK is under development and highly experimental +++

famedlysdk

Matrix SDK for the famedly talk app written in dart.

API

The API is documented here: famedly.gitlab.io/famedlysdk/famedlysdk/famedlysdk-library.html

How to use this

  1. Import the sdk
  famedlysdk:
    git:
      url: https://gitlab.com/famedly/famedlysdk.git
import 'package:flutter/material.dart';
import 'package:famedlysdk/famedlysdk.dart';
  1. Create a new client:
Client matrix = Client("HappyChat");

Take a look here for an example store: https://gitlab.com/ChristianPauly/fluffychat-flutter/snippets

Client matrix = Client("HappyChat");
  1. Connect to a Matrix Homeserver and listen to the streams:
matrix.onLoginStateChanged.stream.listen((bool loginState){ 
  print("LoginState: ${loginState.toString()}");
});

matrix.onEvent.stream.listen((EventUpdate eventUpdate){ 
  print("New event update!");
});

matrix.onRoomUpdate.stream.listen((RoomUpdate eventUpdate){ 
  print("New room update!");
});

final bool serverValid = await matrix.checkServer("https://yourhomeserver.abc");

final bool loginValid = await matrix.login("username", "password");
  1. Send a message to a Room:
final resp = await matrix.jsonRequest(
    type: "PUT",
    action: "/r0/rooms/!fjd823j:example.com/send/m.room.message/$txnId",
    data: {
        "msgtype": "m.text",
        "body": "hello"
    }
);