You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
PCoder 9526dfa4f2 Initial commit version 0.8.13 1 month ago
example Initial commit version 0.8.13 1 month ago
home Initial commit version 0.8.13 1 month ago
lib Initial commit version 0.8.13 1 month ago
scripts Initial commit version 0.8.13 1 month ago
test Initial commit version 0.8.13 1 month ago
test_driver Initial commit version 0.8.13 1 month ago
CHANGELOG.md Initial commit version 0.8.13 1 month ago
CONTRIBUTING.md Initial commit version 0.8.13 1 month ago
LICENSE Initial commit version 0.8.13 1 month ago
README.md Initial commit version 0.8.13 1 month ago
analysis_options.yaml Initial commit version 0.8.13 1 month ago
build.yaml Initial commit version 0.8.13 1 month ago
pubspec.yaml Initial commit version 0.8.13 1 month ago

README.md

Matrix SDK

Matrix (matrix.org) SDK written in dart.

Native libraries

For E2EE, libolm must be provided.

Additionally, OpenSSL (libcrypto) must be provided on native platforms for E2EE.

For flutter apps you can easily import it with the flutter_olm and the flutter_openssl_crypto packages.

How to use this

  1. Import the sdk
  matrix: <latest-version>
  # Optional:
  flutter_olm: <latest-version>
  flutter_openssl_crypto: <latest-version>
import 'package:matrix/matrix.dart';
  1. Create a new client:
final client = Client("HappyChat");

The SDK works better with a database. Otherwise it has no persistence. For this you need to provide a databaseBuilder like this:

final client = Client(
  "HappyChat",
  databaseBuilder: (Client client) async {
    await Hive.init('/path/to/your/storage');
    final db = FamedlySdkHiveDatabase(client.clientName);
    await db.open();
    return db;
  },
);
  1. Connect to a Matrix Homeserver and listen to the streams:
client.onLoginStateChanged.stream.listen((bool loginState){ 
  print("LoginState: ${loginState.toString()}");
});

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

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

await client.checkHomeserver("https://yourhomeserver.abc");
await client.login(
  identifier: AuthenticationUserIdentifier(user: 'alice'),
  password: '123456',
);
  1. Send a message to a Room:
await client.getRoomById('your_room_id').sendTextEvent('Hello world');