StartUserStoryConfiguration class

An immutable class that represents the configuration for starting a user story.

Annotations

Constructors

StartUserStoryConfiguration({Widget splashScreenBuilder(BuildContext context, dynamic onFinish())?, Widget introductionBuilder(BuildContext context, Widget introductionPage)?, IntroductionOptions introductionOptionsBuilder(BuildContext context)?, IntroductionService? introductionService, String? homeScreenRoute, Widget? introductionFallbackScreen, ScrollPhysics? introductionScrollPhysics, bool showIntroduction = true, bool useKillswitch = false, int minimumSplashScreenDuration = 3, Future<String?> splashScreenFuture(BuildContext context)?, WidgetBuilder? splashScreenCenterWidget, Color? splashScreenBackgroundColor = const Color(0xff212121), bool canPopFromIntroduction = true, KillswitchService? killswitchService, bool showSplashScreen = true})
Creates a new instance of StartUserStoryConfiguration.
const

Properties

canPopFromIntroduction bool
Allow popping from introduction, defaults to true
final
hashCode int
The hash code for this object.
no setterinherited
homeScreenRoute String?
The route that is used to navigate to the home screen.
final
introductionBuilder → (Widget Function(BuildContext context, Widget introductionPage)?)
This is used to wrap the introduction widget in your own custom page.
final
introductionFallbackScreen Widget?
final
introductionOptionsBuilder → (IntroductionOptions Function(BuildContext context)?)
final
introductionScrollPhysics ScrollPhysics?
final
introductionService IntroductionService?
final
killswitchService → KillswitchService?
final
minimumSplashScreenDuration int
The minimum duration the splash screen in seconds.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
showIntroduction bool
If the introduction should be shown.
final
showSplashScreen bool
If the splash screen should be shown or not.
final
splashScreenBackgroundColor Color?
The background color of the splash screen.
final
splashScreenBuilder → (Widget Function(BuildContext context, dynamic onFinish())?)
You can use this to build your own splash screen.
final
splashScreenCenterWidget WidgetBuilder?
The widget that is shown in the center of the splash screen.
final
splashScreenFuture → (Future<String?> Function(BuildContext context)?)
The future that is awaited before the splash screen is closed.
final
useKillswitch bool
If the killswitch is enabled this app can be remotely disabled.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

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