inex/famedlysdk
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

[Room] Add documentations.

Browse source
This commit is contained in:
Christian Pauly 2019-06-26 16:39:52 +02:00
parent 96bc9b6aca
commit 602a5d79cd
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
lib/src/Room.dart
View file

@ -330,6 +330,7 @@ class Room {
}); });
} }
/// Sets this room as a direct chat for this user.
Future<dynamic> addToDirectChat(String userID) async { Future<dynamic> addToDirectChat(String userID) async {
Map<String, List<String>> directChats = Map<String, List<String>> directChats =
await client.store.getAccountDataDirectChats(); await client.store.getAccountDataDirectChats();
@ -347,6 +348,7 @@ class Room {
return resp; return resp;
} }
/// Sends *m.fully_read* and *m.read* for the given event ID.
Future<dynamic> sendReadReceipt(String eventID) async { Future<dynamic> sendReadReceipt(String eventID) async {
final dynamic resp = client.connection.jsonRequest( final dynamic resp = client.connection.jsonRequest(
type: "POST", type: "POST",
@ -419,6 +421,7 @@ class Room {
return room; return room;
} }
/// Creates a timeline from the store. Returns a [Timeline] object.
Future<Timeline> getTimeline( Future<Timeline> getTimeline(
{onTimelineUpdateCallback onUpdate, {onTimelineUpdateCallback onUpdate,
onTimelineInsertCallback onInsert}) async { onTimelineInsertCallback onInsert}) async {