Distinguish muted users in UI

assets/l10n/app_en.arb

@@ -128,6 +128,10 @@
   "@actionSheetOptionMarkAsUnread":  {
     "description": "Label for mark as unread button on action sheet."
   },
+  "actionSheetOptionHideMutedMessage": "Hide muted message again",
+  "@actionSheetOptionHideMutedMessage":  {
+    "description": "Label for hide muted message again button on action sheet."
+  },
   "actionSheetOptionShare": "Share",
   "@actionSheetOptionShare":  {
     "description": "Label for share button on action sheet."
@@ -872,6 +876,18 @@
   "@noEarlierMessages": {
     "description": "Text to show at the start of a message list if there are no earlier messages."
   },
+  "mutedSender": "Muted sender",
+  "@mutedSender": {
+    "description": "Name for a muted user to display in message list."
+  },
+  "revealButtonLabel": "Reveal message for muted sender",
+  "@revealButtonLabel": {
+    "description": "Label for the button revealing hidden message from a muted sender in message list."
+  },
+  "mutedUser": "Muted user",
+  "@mutedUser": {
+    "description": "Name for a muted user to display all over the app."
+  },
   "scrollToBottomTooltip": "Scroll to bottom",
   "@scrollToBottomTooltip": {
     "description": "Tooltip for button to scroll to bottom."

lib/api/model/events.dart

@@ -55,6 +55,7 @@ sealed class Event {
         }
       // case 'muted_topics': … // TODO(#422) we ignore this feature on older servers
       case 'user_topic': return UserTopicEvent.fromJson(json);
+      case 'muted_users': return MutedUsersEvent.fromJson(json);
       case 'message': return MessageEvent.fromJson(json);
       case 'update_message': return UpdateMessageEvent.fromJson(json);
       case 'delete_message': return DeleteMessageEvent.fromJson(json);
@@ -664,6 +665,24 @@ class UserTopicEvent extends Event {
   Map<String, dynamic> toJson() => _$UserTopicEventToJson(this);
 }
 
+/// A Zulip event of type `muted_users`: https://zulip.com/api/get-events#muted_users
+@JsonSerializable(fieldRename: FieldRename.snake)
+class MutedUsersEvent extends Event {
+  @override
+  @JsonKey(includeToJson: true)
+  String get type => 'muted_users';
+
+  final List<MutedUserItem> mutedUsers;
+
+  MutedUsersEvent({required super.id, required this.mutedUsers});
+
+  factory MutedUsersEvent.fromJson(Map<String, dynamic> json) =>
+    _$MutedUsersEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$MutedUsersEventToJson(this);
+}
+
 /// A Zulip event of type `message`: https://zulip.com/api/get-events#message
 @JsonSerializable(fieldRename: FieldRename.snake)
 class MessageEvent extends Event {

lib/api/model/initial_snapshot.dart

@@ -44,6 +44,8 @@ class InitialSnapshot {
 
   // final List<…> mutedTopics; // TODO(#422) we ignore this feature on older servers
 
+  final List<MutedUserItem> mutedUsers;
+
   final Map<String, RealmEmojiItem> realmEmoji;
 
   final List<RecentDmConversation> recentPrivateConversations;
@@ -130,6 +132,7 @@ class InitialSnapshot {
     required this.serverTypingStartedExpiryPeriodMilliseconds,
     required this.serverTypingStoppedWaitPeriodMilliseconds,
     required this.serverTypingStartedWaitPeriodMilliseconds,
+    required this.mutedUsers,
     required this.realmEmoji,
     required this.recentPrivateConversations,
     required this.subscriptions,

lib/api/model/model.dart

@@ -110,6 +110,24 @@ class CustomProfileFieldExternalAccountData {
   Map<String, dynamic> toJson() => _$CustomProfileFieldExternalAccountDataToJson(this);
 }
 
+
+/// An item in the [InitialSnapshot.mutedUsers].
+///
+/// For docs, search for "muted_users:"
+/// in <https://zulip.com/api/register-queue>.
+@JsonSerializable(fieldRename: FieldRename.snake)
+class MutedUserItem {
+  final int id;
+  final int timestamp;
+
+  const MutedUserItem({required this.id, required this.timestamp});
+
+  factory MutedUserItem.fromJson(Map<String, dynamic> json) =>
+    _$MutedUserItemFromJson(json);
+
+  Map<String, dynamic> toJson() => _$MutedUserItemToJson(this);
+}
+
 /// An item in [InitialSnapshot.realmEmoji] or [RealmEmojiUpdateEvent].
 ///
 /// For docs, search for "realm_emoji:"

lib/generated/l10n/zulip_localizations.dart

@@ -302,6 +302,12 @@ abstract class ZulipLocalizations {
   /// **'Mark as unread from here'**
   String get actionSheetOptionMarkAsUnread;
 
+  /// Label for hide muted message again button on action sheet.
+  ///
+  /// In en, this message translates to:
+  /// **'Hide muted message again'**
+  String get actionSheetOptionHideMutedMessage;
+
   /// Label for share button on action sheet.
   ///
   /// In en, this message translates to:
@@ -1286,6 +1292,24 @@ abstract class ZulipLocalizations {
   /// **'No earlier messages'**
   String get noEarlierMessages;
 
+  /// Name for a muted user to display in message list.
+  ///
+  /// In en, this message translates to:
+  /// **'Muted sender'**
+  String get mutedSender;
+
+  /// Label for the button revealing hidden message from a muted sender in message list.
+  ///
+  /// In en, this message translates to:
+  /// **'Reveal message for muted sender'**
+  String get revealButtonLabel;
+
+  /// Name for a muted user to display all over the app.
+  ///
+  /// In en, this message translates to:
+  /// **'Muted user'**
+  String get mutedUser;
+
   /// Tooltip for button to scroll to bottom.
   ///
   /// In en, this message translates to:

lib/generated/l10n/zulip_localizations_ar.dart

@@ -110,6 +110,9 @@ class ZulipLocalizationsAr extends ZulipLocalizations {
   @override
   String get actionSheetOptionMarkAsUnread => 'Mark as unread from here';
 
+  @override
+  String get actionSheetOptionHideMutedMessage => 'Hide muted message again';
+
   @override
   String get actionSheetOptionShare => 'Share';
 
@@ -709,6 +712,15 @@ class ZulipLocalizationsAr extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'No earlier messages';
 
+  @override
+  String get mutedSender => 'Muted sender';
+
+  @override
+  String get revealButtonLabel => 'Reveal message for muted sender';
+
+  @override
+  String get mutedUser => 'Muted user';
+
   @override
   String get scrollToBottomTooltip => 'Scroll to bottom';
 

lib/generated/l10n/zulip_localizations_en.dart

@@ -110,6 +110,9 @@ class ZulipLocalizationsEn extends ZulipLocalizations {
   @override
   String get actionSheetOptionMarkAsUnread => 'Mark as unread from here';
 
+  @override
+  String get actionSheetOptionHideMutedMessage => 'Hide muted message again';
+
   @override
   String get actionSheetOptionShare => 'Share';
 
@@ -709,6 +712,15 @@ class ZulipLocalizationsEn extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'No earlier messages';
 
+  @override
+  String get mutedSender => 'Muted sender';
+
+  @override
+  String get revealButtonLabel => 'Reveal message for muted sender';
+
+  @override
+  String get mutedUser => 'Muted user';
+
   @override
   String get scrollToBottomTooltip => 'Scroll to bottom';
 

lib/generated/l10n/zulip_localizations_ja.dart

@@ -110,6 +110,9 @@ class ZulipLocalizationsJa extends ZulipLocalizations {
   @override
   String get actionSheetOptionMarkAsUnread => 'Mark as unread from here';
 
+  @override
+  String get actionSheetOptionHideMutedMessage => 'Hide muted message again';
+
   @override
   String get actionSheetOptionShare => 'Share';
 
@@ -709,6 +712,15 @@ class ZulipLocalizationsJa extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'No earlier messages';
 
+  @override
+  String get mutedSender => 'Muted sender';
+
+  @override
+  String get revealButtonLabel => 'Reveal message for muted sender';
+
+  @override
+  String get mutedUser => 'Muted user';
+
   @override
   String get scrollToBottomTooltip => 'Scroll to bottom';
 

lib/generated/l10n/zulip_localizations_nb.dart

@@ -110,6 +110,9 @@ class ZulipLocalizationsNb extends ZulipLocalizations {
   @override
   String get actionSheetOptionMarkAsUnread => 'Mark as unread from here';
 
+  @override
+  String get actionSheetOptionHideMutedMessage => 'Hide muted message again';
+
   @override
   String get actionSheetOptionShare => 'Share';
 
@@ -709,6 +712,15 @@ class ZulipLocalizationsNb extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'No earlier messages';
 
+  @override
+  String get mutedSender => 'Muted sender';
+
+  @override
+  String get revealButtonLabel => 'Reveal message for muted sender';
+
+  @override
+  String get mutedUser => 'Muted user';
+
   @override
   String get scrollToBottomTooltip => 'Scroll to bottom';
 

lib/generated/l10n/zulip_localizations_pl.dart

@@ -115,6 +115,9 @@ class ZulipLocalizationsPl extends ZulipLocalizations {
   String get actionSheetOptionMarkAsUnread =>
       'Odtąd oznacz jako nieprzeczytane';
 
+  @override
+  String get actionSheetOptionHideMutedMessage => 'Hide muted message again';
+
   @override
   String get actionSheetOptionShare => 'Udostępnij';
 
@@ -720,6 +723,15 @@ class ZulipLocalizationsPl extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'Brak historii';
 
+  @override
+  String get mutedSender => 'Muted sender';
+
+  @override
+  String get revealButtonLabel => 'Reveal message for muted sender';
+
+  @override
+  String get mutedUser => 'Muted user';
+
   @override
   String get scrollToBottomTooltip => 'Przewiń do dołu';
 

lib/generated/l10n/zulip_localizations_ru.dart

@@ -115,6 +115,9 @@ class ZulipLocalizationsRu extends ZulipLocalizations {
   String get actionSheetOptionMarkAsUnread =>
       'Отметить как непрочитанные начиная отсюда';
 
+  @override
+  String get actionSheetOptionHideMutedMessage => 'Hide muted message again';
+
   @override
   String get actionSheetOptionShare => 'Поделиться';
 
@@ -723,6 +726,15 @@ class ZulipLocalizationsRu extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'Предшествующих сообщений нет';
 
+  @override
+  String get mutedSender => 'Muted sender';
+
+  @override
+  String get revealButtonLabel => 'Reveal message for muted sender';
+
+  @override
+  String get mutedUser => 'Muted user';
+
   @override
   String get scrollToBottomTooltip => 'Пролистать вниз';
 

lib/generated/l10n/zulip_localizations_sk.dart

@@ -111,6 +111,9 @@ class ZulipLocalizationsSk extends ZulipLocalizations {
   String get actionSheetOptionMarkAsUnread =>
       'Označiť ako neprečítané od tejto správy';
 
+  @override
+  String get actionSheetOptionHideMutedMessage => 'Hide muted message again';
+
   @override
   String get actionSheetOptionShare => 'Zdielať';
 
@@ -711,6 +714,15 @@ class ZulipLocalizationsSk extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'No earlier messages';
 
+  @override
+  String get mutedSender => 'Muted sender';
+
+  @override
+  String get revealButtonLabel => 'Reveal message for muted sender';
+
+  @override
+  String get mutedUser => 'Muted user';
+
   @override
   String get scrollToBottomTooltip => 'Scroll to bottom';