firka/flutter
firka/flutter
4
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add more docs for MethodChannel.invokeMethod (#10345)

Browse Source
This commit is contained in:
Mikkel Nygaard Ravn 2017-05-26 19:39:52 +02:00 committed by GitHub
parent c11d1318f8
commit c06dce4718
2 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
packages/flutter/lib/src/services/message_codecs.dart
View File

@ -164,10 +164,6 @@ class JSONMethodCodec implements MethodCodec {
/// [MessageCodec] using the Flutter standard binary encoding. /// [MessageCodec] using the Flutter standard binary encoding.
/// ///
/// The standard encoding is guaranteed to be compatible with the corresponding
/// standard codec for FlutterMessageChannels on the host platform. These parts
/// of the Flutter SDK are evolved synchronously.
///
/// Supported messages are acyclic values of these forms: /// Supported messages are acyclic values of these forms:
/// ///
/// * null /// * null

18
packages/flutter/lib/src/services/platform_channel.dart
View File

@ -17,7 +17,7 @@ import 'platform_messages.dart';
/// Messages are encoded into binary before being sent, and binary messages /// Messages are encoded into binary before being sent, and binary messages
/// received are decoded into Dart values. The [MessageCodec] used must be /// received are decoded into Dart values. The [MessageCodec] used must be
/// compatible with the one used by the platform plugin. This can be achieved /// compatible with the one used by the platform plugin. This can be achieved
/// by creating a [BasicMessageChannel] counterpart of this channel on the /// by creating a basic message channel counterpart of this channel on the
/// platform side. The Dart type of messages sent and received is [T], /// platform side. The Dart type of messages sent and received is [T],
/// but only the values supported by the specified [MessageCodec] can be used. /// but only the values supported by the specified [MessageCodec] can be used.
/// The use of unsupported values should be considered programming errors, and /// The use of unsupported values should be considered programming errors, and
@ -95,7 +95,7 @@ class BasicMessageChannel<T> {
/// Method calls are encoded into binary before being sent, and binary results /// Method calls are encoded into binary before being sent, and binary results
/// received are decoded into Dart values. The [MethodCodec] used must be /// received are decoded into Dart values. The [MethodCodec] used must be
/// compatible with the one used by the platform plugin. This can be achieved /// compatible with the one used by the platform plugin. This can be achieved
/// by creating a `MethodChannel` counterpart of this channel on the /// by creating a method channel counterpart of this channel on the
/// platform side. The Dart type of arguments and results is `dynamic`, /// platform side. The Dart type of arguments and results is `dynamic`,
/// but only values supported by the specified [MethodCodec] can be used. /// but only values supported by the specified [MethodCodec] can be used.
/// The use of unsupported values should be considered programming errors, and /// The use of unsupported values should be considered programming errors, and
@ -123,12 +123,26 @@ class MethodChannel {
/// Invokes a [method] on this channel with the specified [arguments]. /// Invokes a [method] on this channel with the specified [arguments].
/// ///
/// The static type of [arguments] is `dynamic`, but only values supported by
/// the [codec] of this channel can be used. The same applies to the returned
/// result. The values supported by the default codec and their platform-specific
/// counterparts are documented with [StandardMessageCodec].
///
/// Returns a [Future] which completes to one of the following: /// Returns a [Future] which completes to one of the following:
/// ///
/// * a result (possibly null), on successful invocation; /// * a result (possibly null), on successful invocation;
/// * a [PlatformException], if the invocation failed in the platform plugin; /// * a [PlatformException], if the invocation failed in the platform plugin;
/// * a [MissingPluginException], if the method has not been implemented by a /// * a [MissingPluginException], if the method has not been implemented by a
/// platform plugin. /// platform plugin.
///
/// See also:
///
/// * [StandardMessageCodec] which defines the payload values supported by
/// [StandardMethodCodec].
/// * [JSONMessageCodec] which defines the payload values supported by
/// [JSONMethodCodec].
/// * <https://docs.flutter.io/javadoc/io/flutter/plugin/common/MethodCall.html>
/// for how to access method call arguments on Android.
Future<dynamic> invokeMethod(String method, [dynamic arguments]) async { Future<dynamic> invokeMethod(String method, [dynamic arguments]) async {
assert(method != null); assert(method != null);
final dynamic result = await BinaryMessages.send( final dynamic result = await BinaryMessages.send(