addReference method

  1. @Deprecated('Use addReferenceV2 instead')
Future<ScalableImage> addReference(
  1. ScalableImageSource src, {
  2. ScalableImage ifAvailableSync(
    1. ScalableImage
    )?,
})

Called when a ScalableImageSource is referenced, e.g. in a stateful widget's State object's initState method. Returns a Future for the scalable image.

Application code where cache is present should use the returned future, and not use ScalableImageSource.createSI directly.

This method calls addReferenceV2.

src The source of the scalable image ifAvailableSync An optional function that is called synchronously if the ScalableImage is available in the cache. (Added in version 1.1.12)

Implementation

@Deprecated('Use addReferenceV2 instead')
Future<ScalableImage> addReference(ScalableImageSource src,
    {ScalableImage Function(ScalableImage)? ifAvailableSync}) {
  final result = addReferenceV2(src);
  if (result is Future<ScalableImage>) {
    return result;
  } else {
    if (ifAvailableSync != null) {
      ifAvailableSync(result);
    }
    return Future.value(result);
  }
}