Flutter: download

Downloads a file.

• Policy permissions required:
  • buckets permissions: none
  • objects permissions: select
• Refer to the Storage guide on how access control works

Parameters

• path

  (Required)

  The full path and file name of the file to be downloaded. For example folder/image.png.

• cacheNonce

  (Optional)

  Adds a `cacheNonce` query parameter to bypass CDN caching for a specific file version.

• transform

  (Optional)

  Transform the asset before serving it to the client.

Examples

Download file

final Uint8List file = await supabase
  .storage
  .from('avatars')
  .download('avatar1.png');

With transform

final Uint8List file = await supabase
  .storage
  .from('avatars')
  .download(
    'avatar1.png',
    transform: TransformOptions(
      width: 200,
      height: 200,
    ),
  );

Bypass the CDN cache

final Uint8List file = await supabase
  .storage
  .from('avatars')
  .download(
    'avatar1.png',
    cacheNonce: 'v2',
  );