RetryImage class
Image.memory displaying an image fetched from the provided url.
Uses exponential backoff algorithm to re-fetch the url in case an error occurs.
Invokes the provided onForbidden callback on the 403 Forbidden HTTP
errors.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- RetryImage
- Available extensions
Constructors
-
RetryImage(String url, {Key? key, String? checksum, ThumbHash? thumbhash, BoxFit? fit, double? height, double? width, double? minWidth, double? aspectRatio, BorderRadius? borderRadius, FutureOr<
void> onForbidden()?, ImageFilter? filter, bool cancelable = false, bool displayProgress = true, Widget loadingBuilder()?}) -
const
-
RetryImage.attachment(ImageAttachment attachment, {BoxFit? fit, double? height, double? width, double? minWidth, BorderRadius? borderRadius, Future<
void> onForbidden()?, ImageFilter? filter, bool cancelable = false, bool displayProgress = true}) -
Constructs a RetryImage from the provided
attachmentloading the ImageAttachment.big with a ImageAttachment.small fallback.factory
Properties
- aspectRatio → double?
-
Aspect ratio of an image to display.
final
- borderRadius → BorderRadius?
-
BorderRadius to apply to this RetryImage.
final
- cancelable → bool
-
Indicator whether an ongoing image fetching from the url is cancelable.
final
- checksum → String?
-
SHA-256 checksum of the image to display.
final
- displayProgress → bool
-
Indicator whether the image fetching progress should be displayed.
final
- filter → ImageFilter?
-
ImageFilter to apply to this RetryImage.
final
- fit → BoxFit?
-
BoxFit to apply to this RetryImage.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- height → double?
-
Height of this RetryImage.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- loadingBuilder → Widget Function()?
-
Builder, building the background of this RetryImage in its loading
state, when the url or thumbhash isn't displayed yet.
final
- minWidth → double?
-
Minimal width of this RetryImage.
final
-
onForbidden
→ FutureOr<
void> Function()? -
Callback, called when loading an image from the provided url fails with
a forbidden network error.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- thumbhash → ThumbHash?
-
ThumbHash of this RetryImage.
final
- url → String
-
URL of an image to display.
final
- width → double?
-
Width of this RetryImage.
final
Methods
-
animate(
{Key? key, List< Effect> ? effects, AnimateCallback? onInit, AnimateCallback? onPlay, AnimateCallback? onComplete, bool? autoPlay, Duration? delay, AnimationController? controller, Adapter? adapter, double? target, double? value}) → Animate -
Available on Widget, provided by the AnimateWidgetExtensions extension
Wraps the target Widget in an Animate instance, and returns the instance for chaining calls. Ex.myWidget.animate()is equivalent toAnimate(child: myWidget). -
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< RetryImage> -
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, int wrapWidth = 65}) → 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