Skip to content

api: Add update_message and delete_message events #212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 98 additions & 0 deletions lib/api/model/events.dart
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ sealed class Event {
default: return UnexpectedEvent.fromJson(json);
}
case 'message': return MessageEvent.fromJson(json);
case 'update_message': return UpdateMessageEvent.fromJson(json);
case 'delete_message': return DeleteMessageEvent.fromJson(json);
case 'heartbeat': return HeartbeatEvent.fromJson(json);
// TODO add many more event types
default: return UnexpectedEvent.fromJson(json);
Expand Down Expand Up @@ -265,6 +267,102 @@ class MessageEvent extends Event {
}
}

/// A Zulip event of type `update_message`.
@JsonSerializable(fieldRename: FieldRename.snake)
class UpdateMessageEvent extends Event {
@override
String get type => 'update_message';

final int? userId; // TODO(server-5)
final bool? renderingOnly; // TODO(server-5)
final int messageId;
final List<int> messageIds;
final List<String> flags; // TODO enum
final int? editTimestamp; // TODO(server-5)
final String? streamName;
final int? streamId;
final int? newStreamId;
final PropagateMode? propagateMode;
final String? origSubject;
final String? subject;
// final List<TopicLink> topicLinks; // TODO handle
final String? origContent;
final String? origRenderedContent;
// final int? prevRenderedContentVersion; // deprecated
final String? content;
final String? renderedContent;
final bool? isMeMessage;

UpdateMessageEvent({
required super.id,
this.userId,
this.renderingOnly,
required this.messageId,
required this.messageIds,
required this.flags,
this.editTimestamp,
this.streamName,
this.streamId,
this.newStreamId,
this.propagateMode,
this.origSubject,
this.subject,
this.origContent,
this.origRenderedContent,
this.content,
this.renderedContent,
this.isMeMessage,
});

factory UpdateMessageEvent.fromJson(Map<String, dynamic> json) =>
_$UpdateMessageEventFromJson(json);

@override
Map<String, dynamic> toJson() => _$UpdateMessageEventToJson(this);
}

/// As in [UpdateMessageEvent.propagateMode].
@JsonEnum(fieldRename: FieldRename.snake)
enum PropagateMode {
changeOne,
changeLater,
changeAll;
}

/// A Zulip event of type `delete_message`.
@JsonSerializable(fieldRename: FieldRename.snake)
class DeleteMessageEvent extends Event {
@override
String get type => 'delete_message';

final List<int> messageIds;
// final int messageId; // Not present; we support the bulk_message_deletion capability
final MessageType messageType;
final int? streamId;
final String? topic;

DeleteMessageEvent({
required super.id,
required this.messageIds,
required this.messageType,
this.streamId,
this.topic,
});

factory DeleteMessageEvent.fromJson(Map<String, dynamic> json) =>
_$DeleteMessageEventFromJson(json);

@override
Map<String, dynamic> toJson() => _$DeleteMessageEventToJson(this);
}

/// As in [DeleteMessageEvent.messageType].
@JsonEnum(fieldRename: FieldRename.snake)
enum MessageType {
stream,
private;
}

@JsonSerializable(fieldRename: FieldRename.snake)
class HeartbeatEvent extends Event {
@override
Expand Down
76 changes: 76 additions & 0 deletions lib/api/model/events.g.dart

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions lib/model/store.dart
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,12 @@ class PerAccountStore extends ChangeNotifier {
for (final view in _messageListViews) {
view.maybeAddMessage(event.message);
}
} else if (event is UpdateMessageEvent) {
assert(debugLog("server event: update_message ${event.messageId}"));
// TODO handle
} else if (event is DeleteMessageEvent) {
assert(debugLog("server event: delete_message ${event.messageIds}"));
// TODO handle
} else if (event is UnexpectedEvent) {
assert(debugLog("server event: ${jsonEncode(event.toJson())}")); // TODO log better
} else {
Expand Down