notif: Add createNotificationChannel method to pigeon bindings

rajveermalviya · rajveermalviya · commit 1f641b7c7bb2 · 2024-07-29T00:56:28.000+05:30
See: https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#createNotificationChannel(androidx.core.app.NotificationChannelCompat)
diff --git a/android/app/src/main/kotlin/com/zulip/flutter/Notifications.g.kt b/android/app/src/main/kotlin/com/zulip/flutter/Notifications.g.kt
@@ -44,6 +44,49 @@ class FlutterError (
   val details: Any? = null
 ) : Throwable()
 
+/**
+ * Corresponds to `androidx.core.app.NotificationChannelCompat`
+ *
+ * See: https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat
+ *
+ * Generated class from Pigeon that represents data sent in messages.
+ */
+data class NotificationChannel (
+  val id: String,
+  /**
+   * Specifies the importance level of notifications
+   * to be posted on this channel.
+   *
+   * Must be a valid constant from [NotificationImportance].
+   */
+  val importance: Long,
+  val name: String? = null,
+  val lightsEnabled: Boolean? = null,
+  val vibrationPattern: LongArray? = null
+
+) {
+  companion object {
+    @Suppress("LocalVariableName")
+    fun fromList(__pigeon_list: List<Any?>): NotificationChannel {
+      val id = __pigeon_list[0] as String
+      val importance = __pigeon_list[1].let { num -> if (num is Int) num.toLong() else num as Long }
+      val name = __pigeon_list[2] as String?
+      val lightsEnabled = __pigeon_list[3] as Boolean?
+      val vibrationPattern = __pigeon_list[4] as LongArray?
+      return NotificationChannel(id, importance, name, lightsEnabled, vibrationPattern)
+    }
+  }
+  fun toList(): List<Any?> {
+    return listOf(
+      id,
+      importance,
+      name,
+      lightsEnabled,
+      vibrationPattern,
+    )
+  }
+}
+
 /**
  * Corresponds to `android.app.PendingIntent`.
  *
@@ -218,25 +261,30 @@ private object NotificationsPigeonCodec : StandardMessageCodec() {
     return when (type) {
       129.toByte() -> {
         return (readValue(buffer) as? List<Any?>)?.let {
-          PendingIntent.fromList(it)
+          NotificationChannel.fromList(it)
         }
       }
       130.toByte() -> {
         return (readValue(buffer) as? List<Any?>)?.let {
-          InboxStyle.fromList(it)
+          PendingIntent.fromList(it)
         }
       }
       131.toByte() -> {
         return (readValue(buffer) as? List<Any?>)?.let {
-          Person.fromList(it)
+          InboxStyle.fromList(it)
         }
       }
       132.toByte() -> {
         return (readValue(buffer) as? List<Any?>)?.let {
-          MessagingStyleMessage.fromList(it)
+          Person.fromList(it)
         }
       }
       133.toByte() -> {
+        return (readValue(buffer) as? List<Any?>)?.let {
+          MessagingStyleMessage.fromList(it)
+        }
+      }
+      134.toByte() -> {
         return (readValue(buffer) as? List<Any?>)?.let {
           MessagingStyle.fromList(it)
         }
@@ -246,33 +294,43 @@ private object NotificationsPigeonCodec : StandardMessageCodec() {
   }
   override fun writeValue(stream: ByteArrayOutputStream, value: Any?)   {
     when (value) {
-      is PendingIntent -> {
+      is NotificationChannel -> {
         stream.write(129)
         writeValue(stream, value.toList())
       }
-      is InboxStyle -> {
+      is PendingIntent -> {
         stream.write(130)
         writeValue(stream, value.toList())
       }
-      is Person -> {
+      is InboxStyle -> {
         stream.write(131)
         writeValue(stream, value.toList())
       }
-      is MessagingStyleMessage -> {
+      is Person -> {
         stream.write(132)
         writeValue(stream, value.toList())
       }
-      is MessagingStyle -> {
+      is MessagingStyleMessage -> {
         stream.write(133)
         writeValue(stream, value.toList())
       }
+      is MessagingStyle -> {
+        stream.write(134)
+        writeValue(stream, value.toList())
+      }
       else -> super.writeValue(stream, value)
     }
   }
 }
 
 /** Generated interface from Pigeon that represents a handler of messages from Flutter. */
 interface AndroidNotificationHostApi {
+  /**
+   * Corresponds to `androidx.core.app.NotificationManagerCompat.createNotificationChannel`.
+   *
+   * See: https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#createNotificationChannel(androidx.core.app.NotificationChannelCompat)
+   */
+  fun createNotificationChannel(channel: NotificationChannel)
   /**
    * Corresponds to `android.app.NotificationManager.notify`,
    * combined with `androidx.core.app.NotificationCompat.Builder`.
@@ -317,6 +375,24 @@ interface AndroidNotificationHostApi {
     @JvmOverloads
     fun setUp(binaryMessenger: BinaryMessenger, api: AndroidNotificationHostApi?, messageChannelSuffix: String = "") {
       val separatedMessageChannelSuffix = if (messageChannelSuffix.isNotEmpty()) ".$messageChannelSuffix" else ""
+      run {
+        val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.zulip.AndroidNotificationHostApi.createNotificationChannel$separatedMessageChannelSuffix", codec)
+        if (api != null) {
+          channel.setMessageHandler { message, reply ->
+            val args = message as List<Any?>
+            val channelArg = args[0] as NotificationChannel
+            val wrapped: List<Any?> = try {
+              api.createNotificationChannel(channelArg)
+              listOf(null)
+            } catch (exception: Throwable) {
+              wrapError(exception)
+            }
+            reply.reply(wrapped)
+          }
+        } else {
+          channel.setMessageHandler(null)
+        }
+      }
       run {
         val channel = BasicMessageChannel<Any?>(binaryMessenger, "dev.flutter.pigeon.zulip.AndroidNotificationHostApi.notify$separatedMessageChannelSuffix", codec)
         if (api != null) {
diff --git a/android/app/src/main/kotlin/com/zulip/flutter/ZulipPlugin.kt b/android/app/src/main/kotlin/com/zulip/flutter/ZulipPlugin.kt
@@ -6,6 +6,7 @@ import android.content.Intent
 import android.os.Bundle
 import android.util.Log
 import androidx.annotation.Keep
+import androidx.core.app.NotificationChannelCompat
 import androidx.core.app.NotificationCompat
 import androidx.core.app.NotificationManagerCompat
 import androidx.core.graphics.drawable.IconCompat
@@ -42,6 +43,16 @@ fun toPigeonPerson(person: androidx.core.app.Person): Person {
 
 private class AndroidNotificationHost(val context: Context)
         : AndroidNotificationHostApi {
+    override fun createNotificationChannel(channel: NotificationChannel) {
+        val notificationChannel = NotificationChannelCompat
+            .Builder(channel.id, channel.importance.toInt()).apply {
+                channel.name?.let { setName(it) }
+                channel.lightsEnabled?.let { setLightsEnabled(it) }
+                channel.vibrationPattern?.let { setVibrationPattern(it) }
+            }.build()
+        NotificationManagerCompat.from(context).createNotificationChannel(notificationChannel)
+    }
+
     @SuppressLint(
         // If permission is missing, `notify` will throw an exception.
         // Which hopefully will propagate to Dart, and then it's up to Dart code to handle it.
diff --git a/lib/host/android_notifications.dart b/lib/host/android_notifications.dart
@@ -1,5 +1,40 @@
 export './android_notifications.g.dart';
 
+/// For use in [NotificationChannel.importance].
+///
+/// See:
+///   https://developer.android.com/reference/android/app/NotificationChannel#setImportance(int)
+///   https://developer.android.com/reference/android/app/NotificationChannel#getImportance()
+abstract class NotificationImportance {
+  /// Corresponds to `IMPORTANCE_UNSPECIFIED`:
+  ///   https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#IMPORTANCE_UNSPECIFIED()
+  static const unspecified = -1000;
+
+  /// Corresponds to `IMPORTANCE_NONE`:
+  ///   https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#IMPORTANCE_NONE()
+  static const none = 0;
+
+  /// Corresponds to `IMPORTANCE_MIN`:
+  ///   https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#IMPORTANCE_MIN()
+  static const min = 1;
+
+  /// Corresponds to `IMPORTANCE_LOW`:
+  ///   https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#IMPORTANCE_LOW()
+  static const low = 2;
+
+  /// Corresponds to `IMPORTANCE_DEFAULT`:
+  ///   https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#IMPORTANCE_DEFAULT()
+  static const default_ = 3;
+
+  /// Corresponds to `IMPORTANCE_HIGH`:
+  ///   https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#IMPORTANCE_HIGH()
+  static const high = 4;
+
+  /// Corresponds to `IMPORTANCE_MAX`:
+  ///   https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#IMPORTANCE_MAX()
+  static const max = 5;
+}
+
 /// For use in [PendingIntent.flags].
 ///
 /// See: https://developer.android.com/reference/android/app/PendingIntent#constants_1
diff --git a/lib/host/android_notifications.g.dart b/lib/host/android_notifications.g.dart
@@ -15,6 +15,54 @@ PlatformException _createConnectionError(String channelName) {
   );
 }
 
+/// Corresponds to `androidx.core.app.NotificationChannelCompat`
+///
+/// See: https://developer.android.com/reference/androidx/core/app/NotificationChannelCompat
+class NotificationChannel {
+  NotificationChannel({
+    required this.id,
+    required this.importance,
+    this.name,
+    this.lightsEnabled,
+    this.vibrationPattern,
+  });
+
+  String id;
+
+  /// Specifies the importance level of notifications
+  /// to be posted on this channel.
+  ///
+  /// Must be a valid constant from [NotificationImportance].
+  int importance;
+
+  String? name;
+
+  bool? lightsEnabled;
+
+  Int64List? vibrationPattern;
+
+  Object encode() {
+    return <Object?>[
+      id,
+      importance,
+      name,
+      lightsEnabled,
+      vibrationPattern,
+    ];
+  }
+
+  static NotificationChannel decode(Object result) {
+    result as List<Object?>;
+    return NotificationChannel(
+      id: result[0]! as String,
+      importance: result[1]! as int,
+      name: result[2] as String?,
+      lightsEnabled: result[3] as bool?,
+      vibrationPattern: result[4] as Int64List?,
+    );
+  }
+}
+
 /// Corresponds to `android.app.PendingIntent`.
 ///
 /// See: https://developer.android.com/reference/android/app/PendingIntent
@@ -197,21 +245,24 @@ class _PigeonCodec extends StandardMessageCodec {
   const _PigeonCodec();
   @override
   void writeValue(WriteBuffer buffer, Object? value) {
-    if (value is PendingIntent) {
+    if (value is NotificationChannel) {
       buffer.putUint8(129);
       writeValue(buffer, value.encode());
-    } else     if (value is InboxStyle) {
+    } else     if (value is PendingIntent) {
       buffer.putUint8(130);
       writeValue(buffer, value.encode());
-    } else     if (value is Person) {
+    } else     if (value is InboxStyle) {
       buffer.putUint8(131);
       writeValue(buffer, value.encode());
-    } else     if (value is MessagingStyleMessage) {
+    } else     if (value is Person) {
       buffer.putUint8(132);
       writeValue(buffer, value.encode());
-    } else     if (value is MessagingStyle) {
+    } else     if (value is MessagingStyleMessage) {
       buffer.putUint8(133);
       writeValue(buffer, value.encode());
+    } else     if (value is MessagingStyle) {
+      buffer.putUint8(134);
+      writeValue(buffer, value.encode());
     } else {
       super.writeValue(buffer, value);
     }
@@ -221,14 +272,16 @@ class _PigeonCodec extends StandardMessageCodec {
   Object? readValueOfType(int type, ReadBuffer buffer) {
     switch (type) {
       case 129: 
-        return PendingIntent.decode(readValue(buffer)!);
+        return NotificationChannel.decode(readValue(buffer)!);
       case 130: 
-        return InboxStyle.decode(readValue(buffer)!);
+        return PendingIntent.decode(readValue(buffer)!);
       case 131: 
-        return Person.decode(readValue(buffer)!);
+        return InboxStyle.decode(readValue(buffer)!);
       case 132: 
-        return MessagingStyleMessage.decode(readValue(buffer)!);
+        return Person.decode(readValue(buffer)!);
       case 133: 
+        return MessagingStyleMessage.decode(readValue(buffer)!);
+      case 134: 
         return MessagingStyle.decode(readValue(buffer)!);
       default:
         return super.readValueOfType(type, buffer);
@@ -249,6 +302,31 @@ class AndroidNotificationHostApi {
 
   final String __pigeon_messageChannelSuffix;
 
+  /// Corresponds to `androidx.core.app.NotificationManagerCompat.createNotificationChannel`.
+  ///
+  /// See: https://developer.android.com/reference/androidx/core/app/NotificationManagerCompat#createNotificationChannel(androidx.core.app.NotificationChannelCompat)
+  Future<void> createNotificationChannel(NotificationChannel channel) async {
+    final String __pigeon_channelName = 'dev.flutter.pigeon.zulip.AndroidNotificationHostApi.createNotificationChannel$__pigeon_messageChannelSuffix';
+    final BasicMessageChannel<Object?> __pigeon_channel = BasicMessageChannel<Object?>(
+      __pigeon_channelName,
+      pigeonChannelCodec,
+      binaryMessenger: __pigeon_binaryMessenger,
+    );
+    final List<Object?>? __pigeon_replyList =
+        await __pigeon_channel.send(<Object?>[channel]) as List<Object?>?;
+    if (__pigeon_replyList == null) {
+      throw _createConnectionError(__pigeon_channelName);
+    } else if (__pigeon_replyList.length > 1) {
+      throw PlatformException(
+        code: __pigeon_replyList[0]! as String,
+        message: __pigeon_replyList[1] as String?,
+        details: __pigeon_replyList[2],
+      );
+    } else {
+      return;
+    }
+  }
+
   /// Corresponds to `android.app.NotificationManager.notify`,
   /// combined with `androidx.core.app.NotificationCompat.Builder`.
   ///
diff --git a/pigeon/notifications.dart b/pigeon/notifications.dart
diff --git a/test/model/binding.dart b/test/model/binding.dart
