StandardAppPlugin class

A plugin that embodies the fundamental concepts of Patapata, which includes rules, pages, and settings for app development, known as StandardApp. This plugin is enabled by default. If you want to disable StandardApp, you can remove this plugin using App.removePlugin or disable it through remote configuration settings after running.

Inheritance
Mixed-in types

Constructors

StandardAppPlugin.new()

Properties

app → App<Object>
The App referenced by the plugin.
no setterinherited
delegate → StandardRouterDelegate?
The RouterDelegate required for Patapata's Router.
no setter
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
parser → StandardRouteInformationParser?
The RouteInformationParser required for Patapata's Router.
no setter
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

addLinkHandler(bool callback(Uri link)) → StandardAppPluginLinkHandlerKey
Add a callback function callback to the plugin's link handlers and return the key that identifies the added link handler. The link handler intercepts the link provided as an argument in StandardAppRouterContext.route. It is used when you want to perform additional processing when receiving deep links or external notifications without triggering page navigation.
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.
override
Retrieve a deep link for the specified pageData (when the page that retrieves the deep link does not return a value). P is the type of the destination page, R is the type of page data, and they should be consistent with what you have set in your StandardPage.
generateLinkWithResult<P extends StandardPageWithResult<R, E>, R extends Object?, E extends Object?>(R pageData) → String?
Retrieve a deep link for the specified pageData (when the page that retrieves the deep link returns a value). P is the type of the destination page, R is the type of page data, and E is the data type of the value that the page returns. These should be the same as what you set in your StandardPageWithResultFactory.
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.
override
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
removeLinkHandler(StandardAppPluginLinkHandlerKey key) → void
Remove a link handler from the plugin that matches the specified key key.
route(String link) → void
Navigate to a page with the specified link. link is a string set in StandardPageFactory under links.
setMockMethodCallHandler() → void
A function for mocking a MethodChannel.
inherited
setMockStreamHandler() → void
A function for mocking a MockStreamHandler.
inherited
startupNavigateToPage(Object page, StartupPageCompleter completer) → void
Called from StartupState.navigateToPage. Implements page navigation.
override
startupOnReset() → void
Called when StartupSequence.resetMachine is invoked during the processing of StartupSequence.
override
startupProcessInitialRoute() → void
Called when all the processes of StartupSequence have successfully completed. Implements the navigation process to the application home.
override
toString() → String
A string representation of this object.
inherited

Operators

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

Static Properties

debugIsWeb ↔ bool
getter/setter pair