OfficialDakari
/
matrix-dart-sdk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

refactor: Deprecate Streams in favor of client.onSync 

This deprecates all streams which can
be created by using client.onSync
anyway for a more predictable state
handling in consuming apps.
This commit is contained in:
krille-chan 2024-05-19 07:48:00 +02:00 committed by Krille
parent 1f597a72f8
commit 885aeb3c17
No known key found for this signature in database
GPG Key ID: E067ECD60F1A0652
3 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lib/src/client.dart
View File

@ -1310,6 +1310,7 @@ class Client extends MatrixApi {
CachedStreamController(); CachedStreamController();
/// Callback will be called on account data updates. /// Callback will be called on account data updates.
@Deprecated('Use `client.onSync` instead')
final CachedStreamController<BasicEvent> onAccountData = final CachedStreamController<BasicEvent> onAccountData =
CachedStreamController(); CachedStreamController();
@ -1326,6 +1327,7 @@ class Client extends MatrixApi {
final CachedStreamController<UiaRequest> onUiaRequest = final CachedStreamController<UiaRequest> onUiaRequest =
CachedStreamController(); CachedStreamController();
@Deprecated('This is not in use anywhere anymore')
final CachedStreamController<Event> onGroupMember = CachedStreamController(); final CachedStreamController<Event> onGroupMember = CachedStreamController();
final CachedStreamController<String> onCancelSendEvent = final CachedStreamController<String> onCancelSendEvent =
@ -2024,6 +2026,7 @@ class Client extends MatrixApi {
jsonEncode(newAccountData.content), jsonEncode(newAccountData.content),
); );
accountData[newAccountData.type] = newAccountData; accountData[newAccountData.type] = newAccountData;
// ignore: deprecated_member_use_from_same_package
onAccountData.add(newAccountData); onAccountData.add(newAccountData);
if (newAccountData.type == EventTypes.PushRules) { if (newAccountData.type == EventTypes.PushRules) {
@ -2398,6 +2401,7 @@ class Client extends MatrixApi {
..addAll(summary.toJson()); ..addAll(summary.toJson());
rooms[roomIndex].summary = RoomSummary.fromJson(roomSummaryJson); rooms[roomIndex].summary = RoomSummary.fromJson(roomSummaryJson);
} }
// ignore: deprecated_member_use_from_same_package
rooms[roomIndex].onUpdate.add(rooms[roomIndex].id); rooms[roomIndex].onUpdate.add(rooms[roomIndex].id);
if ((chatUpdate.timeline?.limited ?? false) && if ((chatUpdate.timeline?.limited ?? false) &&
requestHistoryOnLimitedTimeline) { requestHistoryOnLimitedTimeline) {
@ -2473,6 +2477,7 @@ class Client extends MatrixApi {
case EventUpdateType.decryptedTimelineQueue: case EventUpdateType.decryptedTimelineQueue:
break; break;
} }
// ignore: deprecated_member_use_from_same_package
room.onUpdate.add(room.id); room.onUpdate.add(room.id);
} }

3
lib/src/room.dart
View File

@ -202,6 +202,7 @@ class Room {
/// If something changes, this callback will be triggered. Will return the /// If something changes, this callback will be triggered. Will return the
/// room id. /// room id.
@Deprecated('Use `client.onSync` instead and filter for this room ID')
final CachedStreamController<String> onUpdate = CachedStreamController(); final CachedStreamController<String> onUpdate = CachedStreamController();
/// If there is a new session key received, this will be triggered with /// If there is a new session key received, this will be triggered with
@ -1702,6 +1703,7 @@ class Room {
final dbuser = await client.database?.getUser(mxID, this); final dbuser = await client.database?.getUser(mxID, this);
if (dbuser != null) { if (dbuser != null) {
setState(dbuser); setState(dbuser);
// ignore: deprecated_member_use_from_same_package
onUpdate.add(id); onUpdate.add(id);
return dbuser; return dbuser;
} }
@ -1777,6 +1779,7 @@ class Room {
client, client,
); );
}); });
// ignore: deprecated_member_use_from_same_package
onUpdate.add(id); onUpdate.add(id);
_requestingMatrixIds.remove(mxID); _requestingMatrixIds.remove(mxID);
return user; return user;

1
test/client_test.dart
View File

@ -62,6 +62,7 @@ void main() {
matrix.onPresenceChanged.stream.listen((CachedPresence data) { matrix.onPresenceChanged.stream.listen((CachedPresence data) {
presenceCounter++; presenceCounter++;
}); });
// ignore: deprecated_member_use_from_same_package
matrix.onAccountData.stream.listen((BasicEvent data) { matrix.onAccountData.stream.listen((BasicEvent data) {
accountDataCounter++; accountDataCounter++;
}); });