forked from flutter/engine
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Android plugin registry (flutter#3641)
- Loading branch information
1 parent
33ee0a5
commit b273d1a
Showing
4 changed files
with
286 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
165 changes: 165 additions & 0 deletions
165
shell/platform/android/io/flutter/plugin/common/PluginRegistry.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,165 @@ | ||
| // Copyright 2017 The Chromium Authors. All rights reserved. | ||
| // Use of this source code is governed by a BSD-style license that can be | ||
| // found in the LICENSE file. | ||
|
|
||
| package io.flutter.plugin.common; | ||
|
|
||
| import android.app.Activity; | ||
| import android.content.Intent; | ||
|
|
||
| /** | ||
| * Registry used by plugins to set up interaction with Android APIs. | ||
| * | ||
| * <p>Flutter applications by default include an auto-generated and auto-updated | ||
| * plugin registrant class (GeneratedPluginRegistrant) that makes use of a | ||
| * {@link PluginRegistry} to register contributions from each plugin mentioned | ||
| * in the application's pubspec file. The generated registrant class is, again | ||
| * by default, called from the application's main {@link Activity}, which | ||
| * defaults to an instance of {@link io.flutter.app.FlutterActivity}, itself a | ||
| * {@link PluginRegistry}.</p> | ||
| */ | ||
| public interface PluginRegistry { | ||
| /** | ||
| * Returns a {@link Registrar} for receiving the registrations pertaining | ||
| * to the specified plugin. | ||
| * | ||
| * @param pluginKey a unique String identifying the plugin; typically the | ||
| * fully qualified name of the plugin's main class. | ||
| */ | ||
| Registrar registrarFor(String pluginKey); | ||
|
|
||
| /** | ||
| * Returns whether the specified plugin is known to this registry. | ||
| * | ||
| * @param pluginKey a unique String identifying the plugin; typically the | ||
| * fully qualified name of the plugin's main class. | ||
| * @return true if this registry has handed out a registrar for the | ||
| * specified plugin. | ||
| */ | ||
| boolean hasPlugin(String pluginKey); | ||
|
|
||
| /** | ||
| * Returns the value published by the specified plugin, if any. | ||
| * | ||
| * <p>Plugins may publish a single value, such as an instance of the | ||
| * plugin's main class, for situations where external control or | ||
| * interaction is needed. Clients are expected to know the value's | ||
| * type.</p> | ||
| * | ||
| * @param pluginKey a unique String identifying the plugin; typically the | ||
| * fully qualified name of the plugin's main class. | ||
| * @return the published value, possibly null. | ||
| */ | ||
| <T> T valuePublishedByPlugin(String pluginKey); | ||
|
|
||
| /** | ||
| * Receiver of registrations from a single plugin. | ||
| */ | ||
| interface Registrar { | ||
| /** | ||
| * Returns the {@link Activity} that forms the plugin's operating context. | ||
| */ | ||
| Activity activity(); | ||
|
|
||
| /** | ||
| * Returns a {@link BinaryMessenger} which the plugin can use for | ||
| * creating channels for communicating with the Dart side. | ||
| */ | ||
| BinaryMessenger messenger(); | ||
|
|
||
| /** | ||
| * Publishes a value associated with the plugin being registered. | ||
| * | ||
| * <p>The published value is available to interested clients via | ||
| * {@link PluginRegistry#valuePublishedByPlugin(String)}.</p> | ||
| * | ||
| * <p>Publication should be done only when client code needs to interact | ||
| * with the plugin in a way that cannot be accomplished by the plugin | ||
| * registering callbacks with client APIs.</p> | ||
| * | ||
| * <p>Overwrites any previously published value.</p> | ||
| * | ||
| * @param value the value, possibly null. | ||
| * @return this {@link Registrar}. | ||
| */ | ||
| Registrar publish(Object value); | ||
|
|
||
| /** | ||
| * Adds a callback allowing the plugin to take part in handling incoming | ||
| * calls to {@Activity#onRequestPermissionsResult(int, String[], int[])} | ||
| * or {android.support.v4.app.ActivityCompat.OnRequestPermissionsResultCallback#onRequestPermissionsResult(int, String[], int[])}. | ||
| * | ||
| * @param listener a {@link RequestPermissionResultListener} callback. | ||
| * @return this {@link Registrar}. | ||
| */ | ||
| Registrar addRequestPermissionResultListener(RequestPermissionResultListener listener); | ||
|
|
||
| /** | ||
| * Adds a callback allowing the plugin to take part in handling incoming | ||
| * calls to {@Activity#onActivityResult(int, int, Intent)}. | ||
| * | ||
| * @param listener an {@link ActivityResultListener} callback. | ||
| * @return this {@link Registrar}. | ||
| */ | ||
| Registrar addActivityResultListener(ActivityResultListener listener); | ||
|
|
||
| /** | ||
| * Adds a callback allowing the plugin to take part in handling incoming | ||
| * calls to {@Activity#onNewIntent(Intent)}. | ||
| * | ||
| * @param listener a {@link NewIntentListener} callback. | ||
| * @return this {@link Registrar}. | ||
| */ | ||
| Registrar addNewIntentListener(NewIntentListener listener); | ||
|
|
||
| /** | ||
| * Adds a callback allowing the plugin to take part in handling incoming | ||
| * calls to {@Activity#onUserLeaveHint()}. | ||
| * | ||
| * @param listener a {@link UserLeaveHintListener} callback. | ||
| * @return this {@link Registrar}. | ||
| */ | ||
| Registrar addUserLeaveHintListener(UserLeaveHintListener listener); | ||
| } | ||
|
|
||
| /** | ||
| * Delegate interface for handling results of permission requests on | ||
| * behalf of the main {@link Activity}. | ||
| */ | ||
| interface RequestPermissionResultListener { | ||
| /** | ||
| * @return true if the result has been handled. | ||
| */ | ||
| boolean onRequestPermissionResult(int requestCode, String[] permissions, int[] grantResults); | ||
| } | ||
|
|
||
| /** | ||
| * Delegate interface for handling activity results on behalf of the main | ||
| * {@link Activity}. | ||
| */ | ||
| interface ActivityResultListener { | ||
| /** | ||
| * @return true if the result has been handled. | ||
| */ | ||
| boolean onActivityResult(int requestCode, int resultCode, Intent data); | ||
| } | ||
|
|
||
| /** | ||
| * Delegate interface for handling new intents on behalf of the main | ||
| * {@link Activity}. | ||
| */ | ||
| interface NewIntentListener { | ||
| /** | ||
| * @return true if the new intent has been handled. | ||
| */ | ||
| boolean onNewIntent(Intent intent); | ||
| } | ||
|
|
||
| /** | ||
| * Delegate interface for handling user leave hints on behalf of the main | ||
| * {@link Activity}. | ||
| */ | ||
| interface UserLeaveHintListener { | ||
| void onUserLeaveHint(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters