add some notes re: setMessageHandler()

PADL · Nov 25, 2024 · b87006b · b87006b
1 parent 025c235
commit b87006b
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/Sources/FlutterSwift/Channel/FlutterChannel.swift b/Sources/FlutterSwift/Channel/FlutterChannel.swift
@@ -127,6 +127,11 @@ extension _FlutterBinaryMessengerConnectionRepresentable {
     }
   }
 
+  /// helper function to set the message handler for a channel.
+  /// `optionalHandler` is the handler function; if `nil`, then the message
+  /// handler will be removed (as if `removeMessageHandler()` was called`.
+  /// Otherwise, `block` is called to wrap the handler into a
+  /// `FlutterBinaryMessageHandler`.
   #if canImport(Android)
   @UIThreadActor
   #else