UpdateCheckResult class
Result returned from BloomUpdates.checkForUpdate().
Encapsulates availability, runtime binary compatibility, and staged rollout status.
Example:
final result = await BloomUpdates.checkForUpdate();
if (result.isAvailable && result.isCompatible) {
print('Update ${result.manifest?.version} available!');
}
Constructors
- UpdateCheckResult({required bool isAvailable, bool isCompatible = true, UpdateManifest? manifest, String? rejectionReason})
-
Creates an UpdateCheckResult.
const
- UpdateCheckResult.available(UpdateManifest updateManifest)
-
Result representing an available and compatible update with the given
updateManifest.const - UpdateCheckResult.rejected({required String reason, UpdateManifest? manifest})
-
Result representing a rejected update check with a given
reason.const - UpdateCheckResult.upToDate()
-
Result representing an up-to-date client.
const
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- isAvailable → bool
-
Whether an update was discovered.
final
- isCompatible → bool
-
Whether the discovered update is compatible with the local runtime binary.
final
- manifest → UpdateManifest?
-
Downloadable patch manifest if available.
final
- rejectionReason → String?
-
Reason why update was rejected or unavailable.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
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