inex
/
famedlysdk
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
111 Commits 2 Branches 0 Tags 3.5 MiB
Dart 99.9%
Go to file
Marcel 253e0ecda6 [client][pushrules] Add GET Pushrules Endpoint 
[sdk] Add "build_runner", "json_annotation" and "json_serializable" to dependencies required for [client][pushrules]
[test][client][pushrules] Add Tests for [client][pushrules]

Took 2 hours 13 minutes
 		2019-06-21 07:41:09 +00:00
lib [client][pushrules] Add GET Pushrules Endpoint 2019-06-21 07:41:09 +00:00
scripts Add scripts 2019-06-09 12:21:46 +02:00
test [client][pushrules] Add GET Pushrules Endpoint 2019-06-21 07:41:09 +00:00
.gitignore Initial commit 2019-06-09 12:16:48 +02:00
.gitlab-ci.yml Update .gitlab-ci.yml 2019-06-09 18:30:50 +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 Update CONTRIBUTING.md 2019-06-10 12:19:40 +00:00
Gemfile Add jekyll infos 2019-06-09 12:55:57 +00:00
Gemfile.lock Try to fix publishing code again 2019-06-09 13:17:31 +00:00
LICENSE Update LICENSE 2019-06-09 11:36:59 +00:00
README.md [client][pushrules] Add GET Pushrules Endpoint 2019-06-21 07:41:09 +00:00
_config.yml Add jekyll infos 2019-06-09 12:55:57 +00:00
pubspec.lock [client][pushrules] Add GET Pushrules Endpoint 2019-06-21 07:41:09 +00:00
pubspec.yaml [client][pushrules] Add GET Pushrules Endpoint 2019-06-21 07:41:09 +00: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

How to use this

  1. Import the sdk
  famedlysdk:
    git:
      url: https://gitlab.com/famedly/famedlysdk.git
      ref: 77be6102f6cbb2e01adc28f9caa3aa583f914235

import 'package:flutter/material.dart';
import 'package:famedlysdk/famedlysdk.dart';
  1. Access the MatrixState object by calling Matrix.of with your current BuildContext:
Client matrix = Client("famedly talk");
  1. Connect to a Matrix Homeserver and listen to the streams:

matrix.connection.onLoginStateChanged.stream.listen((bool loginState){ 
  print("LoginState: ${loginState.toString()}");
});

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

matrix.connection.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.connection.jsonRequest(
    type: "PUT",
    action: "/r0/rooms/!fjd823j:example.com/send/m.room.message/$txnId",
    data: {
        "msgtype": "m.text",
        "body": "hello"
    }
);

Development

Regenerating JSON Classes

To regenerate the part files of JSON Classes you need to run this command:

flutter pub run build_runner build