PocketBaseImageProvider class
An ImageProvider that fetches and caches images from a PocketBase instance.
This provider integrates with PocketBase to retrieve image files associated with a RecordModel. It uses the PocketBase SDK's file service, which typically handles caching and network requests.
- Inheritance
-
- Object
- ImageProvider<
PocketBaseImageProvider> - PocketBaseImageProvider
Constructors
- PocketBaseImageProvider.new({required $PocketBase client, required String recordId, required String recordCollectionName, required String filename, int? pixelWidth, int? pixelHeight, Size? size, Color? color, double? scale, Duration? expireAfter, String? token, bool autoGenerateToken = false})
- Creates an ImageProvider for a PocketBase file.
Properties
- autoGenerateToken → bool
-
final
- client → $PocketBase
-
final
- color → Color?
-
final
- expireAfter → Duration?
-
final
- filename → String
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- pixelHeight → int?
-
final
- pixelWidth → int?
-
final
- recordCollectionName → String
-
final
- recordId → String
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scale → double?
-
final
- size → Size?
-
final
- token → String?
-
final
Methods
-
createStream(
ImageConfiguration configuration) → ImageStream -
Called by resolve to create the ImageStream it returns.
inherited
-
download(
) → Future< Uint8List> - Downloads the image file bytes from the PocketBase server.
-
evict(
{ImageCache? cache, ImageConfiguration configuration = ImageConfiguration.empty}) → Future< bool> -
Evicts an entry from the image cache.
inherited
-
loadBuffer(
PocketBaseImageProvider key, DecoderBufferCallback decode) → ImageStreamCompleter -
Converts a key into an ImageStreamCompleter, and begins fetching the
image.
inherited
-
loadImage(
PocketBaseImageProvider key, ImageDecoderCallback decode) → ImageStreamCompleter -
Converts a key into an ImageStreamCompleter, and begins fetching the
image.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
obtainCacheStatus(
{required ImageConfiguration configuration, ImageErrorListener? handleError}) → Future< ImageCacheStatus?> -
Returns the cache location for the key that this ImageProvider creates.
inherited
-
obtainKey(
ImageConfiguration configuration) → Future< PocketBaseImageProvider> -
Converts an ImageProvider's settings plus an ImageConfiguration to a key
that describes the precise image to load.
override
-
resolve(
ImageConfiguration configuration) → ImageStream -
Resolves this image provider using the given
configuration, returning an ImageStream.inherited -
resolveStreamForKey(
ImageConfiguration configuration, ImageStream stream, PocketBaseImageProvider key, ImageErrorListener handleError) → void -
Called by resolve with the key returned by obtainKey.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
getFilterColor(
[Color? color]) → Color