io.flutter.plugin.common.MethodCall Class Reference

Public Member Functions
	MethodCall (@NonNull String method, @Nullable Object arguments)
boolean	hasArgument (@NonNull String key)

Public Attributes
final String	method
final Object	arguments

Package Functions
public< T > T	arguments ()
public< T > T	argument (@NonNull String key)

Detailed Description

Command object representing a method call on a MethodChannel.

Definition at line 14 of file MethodCall.java.

Constructor & Destructor Documentation

MethodCall()

io.flutter.plugin.common.MethodCall.MethodCall ( @NonNull String  method, @Nullable Object  arguments  )

inline

Creates a MethodCall with the specified method name and arguments.

Parameters

method	the method name String, not null.
arguments	the arguments, a value supported by the channel's message codec. Possibly, null.

Definition at line 34 of file MethodCall.java.

                                                                        {
    if (BuildConfig.DEBUG && method == null) {
      throw new AssertionError("Parameter method must not be null.");
    }
    this.method = method;
    this.arguments = arguments;
  }

Member Function Documentation

argument()

public< T > T io.flutter.plugin.common.MethodCall.argument ( @NonNull String  key )

inlinepackage

Returns a String-keyed argument of this method call, assuming arguments is a Map or a JSONObject. The static type of the returned result is determined by the call-site.

Parameters

<T>	the intended type of the argument.
key	the String key.

Returns

the argument value at the specified key, with static type T, or null, if such an entry is not present.

Exceptions

ClassCastException

if arguments can be cast to neither Map nor JSONObject.

Definition at line 68 of file MethodCall.java.

                                             {
    if (arguments == null) {
      return null;
    } else if (arguments instanceof Map) {
      return (T) ((Map<?, ?>) arguments).get(key);
    } else if (arguments instanceof JSONObject) {
      return (T) ((JSONObject) arguments).opt(key);
    } else {
      throw new ClassCastException();
    }
  }

arguments()

public< T > T io.flutter.plugin.common.MethodCall.arguments ( )

inlinepackage

Returns the arguments of this method call with a static type determined by the call-site.

Parameters

<T>	the intended type of the arguments.

Returns

the arguments with static type T

Definition at line 50 of file MethodCall.java.

                           {
    return (T) arguments;
  }

hasArgument()

boolean io.flutter.plugin.common.MethodCall.hasArgument ( @NonNull String  key )

inline

Returns whether this method call involves a mapping for the given argument key, assuming arguments is a Map or a JSONObject. The value associated with the key, as returned by argument(String), is not considered, and may be null.

Parameters

key	the String key.

Returns

true, if arguments is a Map containing key, or a JSONObject with a mapping for key.

Exceptions

ClassCastException

if arguments can be cast to neither Map nor JSONObject.

Definition at line 91 of file MethodCall.java.

                                                  {
    if (arguments == null) {
      return false;
    } else if (arguments instanceof Map) {
      return ((Map<?, ?>) arguments).containsKey(key);
    } else if (arguments instanceof JSONObject) {
      return ((JSONObject) arguments).has(key);
    } else {
      throw new ClassCastException();
    }
  }

Member Data Documentation

arguments

final Object io.flutter.plugin.common.MethodCall.arguments

Arguments for the call.

Consider using arguments() for cases where a particular run-time type is expected. Consider using argument(String) when that run-time type is Map or JSONObject.

Definition at line 25 of file MethodCall.java.

method

final String io.flutter.plugin.common.MethodCall.method

The name of the called method.

Definition at line 16 of file MethodCall.java.

---

The documentation for this class was generated from the following file:

• shell/platform/android/io/flutter/plugin/common/MethodCall.java