StandardPagePluginMixin mixin

A mixin for allowing a Plugin to modify how a StandardPage or StandardPageWithResult works.

Superclass constraints

Properties

app → App<Object>
The App referenced by the plugin.
no setterinherited
dependencies → List<Type>
The list of other plugins that this plugin depends on. This property should be used to add the types of other plugins that are required for this Plugin to work. For example, when using the FirebaseAnalyticsPlugin, you need to include FirebaseCorePlugin.
no setterinherited
disposed → bool
Get whether this Plugin has been disposed.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
initialized → bool
Whether this Plugin is initialized or not.
no setterinherited
methodCallLogs → List<MethodCall>
finalinherited
name → String
The unique name of this Plugin. This property is referenced in various situations, such as when enabling or disabling the plugin, and when enabling or disabling the mock, and when communicating with Native code.
no setterinherited
Get the list of NavigatorObservers to pass to Patapata for this plugin. This Observers list will ultimately be added to the App.navigatorObservers list.
no setterinherited
remoteConfigEnabledKey → String
Get the RemoteConfig key name to enable or disable this plugin.
no setterinherited
requireRemoteConfig → bool
This property determines whether initialization should occur after the RemoteConfig system has started when set to true, or before it starts when set to false.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

buildPage(BuildContext context, Widget child) → Widget
A function that allows you to modify the StandardPage or StandardPageWithResult before it is displayed. It will directly wrap the result of StandardPage.buildPage or StandardPageWithResult.buildPage.
createAppWidgetWrapper(Widget child) → Widget
Wraps the Widget that will ultimately be passed to Flutter's runApp function. This is used when the plugin needs to wrap App.createAppWidget to add widgets to the App's widget tree.
inherited
createLocalConfig() → LocalConfig?
Specify the LocalConfig to register with Patapata for this plugin.
inherited
createRemoteConfig() → RemoteConfig?
Specify the RemoteConfig to register with Patapata for this plugin.
inherited
createRemoteMessaging() → RemoteMessaging?
Specify the RemoteMessaging to register with Patapata for this plugin.
inherited
dispose() → FutureOr<void>
Disposes this Plugin. Always call super.dispose before any other overridden code. In general you should not call this method as App will do that for you.
inherited
init(App<Object> app) → FutureOr<bool>
Executed when a PatapataApp runs or when a this Plugin is added to the PatapataApp after run. This may return a Future for asynchronous initialization. Always call super.init before any other overridden code.
inherited
mockPatapataDisable() → void
This is a function to mock patapataDisable running in native code. It will only be called when kIsTest is true.
inherited
mockPatapataEnable() → void
This is a function to mock patapataEnable running in native code. It will only be called when kIsTest is true.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setMockMethodCallHandler() → void
A function for mocking a MethodChannel.
inherited
setMockStreamHandler() → void
A function for mocking a MockStreamHandler.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

inline({String name = 'inline', List<Type> dependencies = const <Type>[], bool requireRemoteConfig = false, FutureOr<bool> init(App<Object> app)?, FutureOr<void> dispose()?, Widget createAppWidgetWrapper(Widget child)?, RemoteConfig? createRemoteConfig()?, LocalConfig? createLocalConfig()?, RemoteMessaging? createRemoteMessaging()?, List<NavigatorObserver> navigatorObservers()?, required Widget buildPage(BuildContext context, Widget child)}) → StandardPagePluginMixin
Create a StandardPagePluginMixin that can be used in App.addPlugin. This takes all the same parameters as Plugin.inline as well as all the methods of StandardPagePluginMixin.