pigeon: Add binding for NotificationChannel.soundResourceName

Author: rajveermalviya

android/app/src/main/kotlin/com/zulip/flutter/Notifications.g.kt

@@ -62,6 +62,15 @@ data class NotificationChannel (
   val importance: Long,
   val name: String? = null,
   val lightsEnabled: Boolean? = null,
+  /**
+   * The name of the sound file resource.
+   *
+   * The resource ID is retrieved using
+   * `android.content.res.Resources.getIdentifier`, which is then used to
+   * generate a `android.resource://` URI. This URI is then passed
+   * to the `NotificationChannelCompat` builder.
+   */
+  val soundResourceName: String? = null,
   val vibrationPattern: LongArray? = null
 
 ) {
@@ -72,8 +81,9 @@ data class NotificationChannel (
       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)
+      val soundResourceName = __pigeon_list[4] as String?
+      val vibrationPattern = __pigeon_list[5] as LongArray?
+      return NotificationChannel(id, importance, name, lightsEnabled, soundResourceName, vibrationPattern)
     }
   }
   fun toList(): List<Any?> {
@@ -82,6 +92,7 @@ data class NotificationChannel (
       importance,
       name,
       lightsEnabled,
+      soundResourceName,
       vibrationPattern,
     )
   }

android/app/src/main/kotlin/com/zulip/flutter/ZulipPlugin.kt

@@ -1,8 +1,10 @@
 package com.zulip.flutter
 
 import android.annotation.SuppressLint
+import android.content.ContentResolver
 import android.content.Context
 import android.content.Intent
+import android.net.Uri
 import android.os.Bundle
 import android.util.Log
 import androidx.annotation.Keep
@@ -41,28 +43,50 @@ fun toPigeonPerson(person: androidx.core.app.Person): Person {
     )
 }
 
+/** The Android resource URL for the given resource. */
+// Based on: https://stackoverflow.com/a/38340580
+fun Context.resourceUrl(resourceId: Int): Uri = with(resources) {
+    Uri.Builder()
+        .scheme(ContentResolver.SCHEME_ANDROID_RESOURCE)
+        .authority(getResourcePackageName(resourceId))
+        .appendPath(getResourceTypeName(resourceId))
+        .appendPath(getResourceEntryName(resourceId))
+        .build()
+}
+
 private class AndroidNotificationHost(val context: Context)
-        : AndroidNotificationHostApi {
+    : AndroidNotificationHostApi {
     override fun getNotificationChannels(): List<NotificationChannel> {
         return NotificationManagerCompat.from(context)
             .notificationChannelsCompat
             .map { NotificationChannel(
                 it.id,
                 it.importance.toLong(),
                 it.name?.toString(),
-                it.shouldShowLights()
+                it.shouldShowLights(),
+                it.sound?.toString(),
+                it.vibrationPattern,
             ) }
     }
 
     override fun deleteNotificationChannel(channelId: String) {
         NotificationManagerCompat.from(context).deleteNotificationChannel(channelId)
     }
 
+    @SuppressLint(
+        // For `getIdentifier`.  TODO make a cleaner API.
+        "DiscouragedApi")
     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.soundResourceName?.let {
+                    val resourceId = context.resources.getIdentifier(
+                        it, "raw", context.packageName)
+                    setSound(context.resourceUrl(resourceId),
+                        AudioAttributes.Builder().setUsage(AudioAttributes.USAGE_NOTIFICATION).build())
+                }
                 channel.vibrationPattern?.let { setVibrationPattern(it) }
             }.build()
         NotificationManagerCompat.from(context).createNotificationChannel(notificationChannel)

lib/host/android_notifications.g.dart

@@ -24,6 +24,7 @@ class NotificationChannel {
     required this.importance,
     this.name,
     this.lightsEnabled,
+    this.soundResourceName,
     this.vibrationPattern,
   });
 
@@ -39,6 +40,14 @@ class NotificationChannel {
 
   bool? lightsEnabled;
 
+  /// The name of the sound file resource.
+  ///
+  /// The resource ID is retrieved using
+  /// `android.content.res.Resources.getIdentifier`, which is then used to
+  /// generate a `android.resource://` URI. This URI is then passed
+  /// to the `NotificationChannelCompat` builder.
+  String? soundResourceName;
+
   Int64List? vibrationPattern;
 
   Object encode() {
@@ -47,6 +56,7 @@ class NotificationChannel {
       importance,
       name,
       lightsEnabled,
+      soundResourceName,
       vibrationPattern,
     ];
   }
@@ -58,7 +68,8 @@ class NotificationChannel {
       importance: result[1]! as int,
       name: result[2] as String?,
       lightsEnabled: result[3] as bool?,
-      vibrationPattern: result[4] as Int64List?,
+      soundResourceName: result[4] as String?,
+      vibrationPattern: result[5] as Int64List?,
     );
   }
 }

pigeon/notifications.dart

@@ -20,6 +20,7 @@ class NotificationChannel {
     required this.importance,
     this.name,
     this.lightsEnabled,
+    this.soundResourceName,
     this.vibrationPattern,
   });
 
@@ -33,6 +34,15 @@ class NotificationChannel {
 
   final String? name;
   final bool? lightsEnabled;
+
+  /// The name of the sound file resource.
+  ///
+  /// The resource ID is retrieved using
+  /// `android.content.res.Resources.getIdentifier`, which is then used to
+  /// generate a `android.resource://` URI. This URI is then passed
+  /// to the `NotificationChannelCompat` builder.
+  final String? soundResourceName;
+
   final Int64List? vibrationPattern;
 }
 

test/notifications/display_test.dart

@@ -126,6 +126,7 @@ void main() {
         ..name.equals('Messages')
         ..importance.equals(NotificationImportance.high)
         ..lightsEnabled.equals(true)
+        ..soundResourceName.isNull()
         ..vibrationPattern.isNotNull().deepEquals(
             NotificationChannelManager.kVibrationPattern)
       ;
@@ -874,6 +875,7 @@ extension NotificationChannelChecks on Subject<NotificationChannel> {
   Subject<int> get importance => has((x) => x.importance, 'importance');
   Subject<String?> get name => has((x) => x.name, 'name');
   Subject<bool?> get lightsEnabled => has((x) => x.lightsEnabled, 'lightsEnabled');
+  Subject<String?> get soundResourceName => has((x) => x.soundResourceName, 'soundResourceName');
   Subject<Int64List?> get vibrationPattern => has((x) => x.vibrationPattern, 'vibrationPattern');
 }