UpgradeBase class

Inheritance
Implementers

Constructors

UpgradeBase({Key? key, AppcastConfiguration? appcastConfig, UpgraderMessages? messages, bool? debugDisplayAlways = false, bool? debugDisplayOnce = false, bool? debugLogging = false, Duration? durationToAlertAgain = const Duration(days: 3), BoolCallback? onIgnore, BoolCallback? onLater, BoolCallback? onUpdate, BoolCallback? shouldPopScope, Client? client, bool? showIgnore, bool? showLater, bool? showReleaseNotes, bool? canDismissDialog, String? countryCode, String? minAppVersion, UpgradeDialogStyle? dialogStyle = UpgradeDialogStyle.material, Widget? getCustomDialog(BuildContext context, {String? message, void onUserIgnored()?, void onUserLater()?, void onUserUpdated()?, String? releaseNotes, String? title})?})

Properties

appcastConfig AppcastConfiguration?
The appcast configuration (AppcastConfiguration) used by Appcast.
final
canDismissDialog bool?
Can alert dialog be dismissed on tap outside of the alert dialog. Not used by UpgradeCard. (default: false)
final
client → Client?
Provide an HTTP Client that can be replaced for mock testing.
final
countryCode String?
The country code that will override the system locale. Optional. Used only for iOS.
final
debugDisplayAlways bool?
For debugging, always force the upgrade to be available.
final
debugDisplayOnce bool?
For debugging, display the upgrade at least once once.
final
debugLogging bool?
For debugging, display logging statements.
final
dialogStyle UpgradeDialogStyle?
The upgrade dialog style. Optional. Used only on UpgradeAlert. (default: material)
final
durationToAlertAgain Duration
Duration until alerting user again after later.
no setter
getCustomDialog → (Widget? Function(BuildContext context, {String? message, void onUserIgnored()?, void onUserLater()?, void onUserUpdated()?, String? releaseNotes, String? title})?)
The function which returns the custom widget to be shown in place of default alert dialogs
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
messages UpgraderMessages?
The localized messages used for display in upgrader.
final
minAppVersion String?
The minimum app version supported by this app. Earlier versions of this app will be forced to update to the current version. Optional.
final
onIgnore BoolCallback?
Called when the ignore button is tapped or otherwise activated. Return false when the default behavior should not execute.
final
onLater BoolCallback?
Called when the ignore button is tapped or otherwise activated. Return false when the default behavior should not execute.
final
onUpdate BoolCallback?
Called when the ignore button is tapped or otherwise activated. Return false when the default behavior should not execute.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
shouldPopScope BoolCallback?
Called when the user taps outside of the dialog and canDismissDialog is false. Also called when the back button is pressed. Return true for the screen to be popped. Not used by UpgradeCard.
final
showIgnore bool?
Hide or show Ignore button on dialog (default: true)
final
showLater bool?
Hide or show Later button on dialog (default: true)
final
showReleaseNotes bool?
Hide or show release notes (default: true)
final

Methods

build(BuildContext context, UpgradeBaseState state) Widget?
createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() UpgradeBaseState
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

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