ShorebirdCodePush class

Applications should not import this file directly, but import package:shorebird_code_push/shorebird_code_push.dart instead. Get info about your Shorebird code push app.


Get info about your Shorebird code push app.
ShorebirdCodePush.test({Updater updater = const Updater()})
Constructor used for testing which allows injecting a mock Updater.


hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited


currentPatchNumber() Future<int?>
The version of the currently-installed patch. null if no patch is installed (i.e., the app is running the release version).
downloadUpdateIfAvailable() Future<void>
Downloads the latest patch, if available.
isNewPatchAvailableForDownload() Future<bool>
Checks whether a new patch is available for download.
isNewPatchReadyToInstall() Future<bool>
Whether a new patch has been downloaded and is ready to install.
isShorebirdAvailable() bool
Whether the Shorebird Engine is available.
nextPatchNumber() Future<int?>
The version of the patch that will be run on the next app launch. If no new patch has been downloaded, this will be the same as currentPatchNumber.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
toString() String
A string representation of this object.


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