saveFile function

Future<ThemedFile?> saveFile({ required String filename, required Uint8List bytes, String? saveDialogTitle, LayrzAppLocalizations? i18n, })

saveFile is a helper function to save a file to the device.

This function is only for native implementations, that is, Android, iOS, Windows, and macOS. To implement this function multiplatform, follow this example

import 'package:layrz_theme/src/helpers/save_file/native.dart'
  if (dart.library.html) 'package:layrz_theme/src/helpers/save_file/web.dart';
// ...
saveFile() // <- this function

Returns a ThemedFile. If the user cancels the save, it returns null.

filename is the name of the file to save. bytes is the bytes of the file to save. saveDialogTitle is the title of the pick dialog. When i18n is not null, this is ignored and use the translation layrz.file.save instead. i18n is the localization object.

Implementation

/// [filename] is the name of the file to save.
/// [bytes] is the bytes of the file to save.
/// [saveDialogTitle] is the title of the pick dialog. When [i18n] is not null, this is ignored and use the
/// translation `layrz.file.save` instead.
/// [i18n] is the localization object.
Future<ThemedFile?> saveFile({
  required String filename,
  required Uint8List bytes,
  String? saveDialogTitle,
  LayrzAppLocalizations? i18n,
}) async {
  String dialogTitle = saveDialogTitle ?? i18n?.t('layrz.file.save') ?? "Save file";

  if (Platform.isAndroid) {
    final parentDirectory = await getApplicationDocumentsDirectory();
    final directory = await FilePicker.platform.getDirectoryPath(
      dialogTitle: dialogTitle,
      initialDirectory: parentDirectory.path,
    );

    if (directory != null) {
      final file = File("$directory/$filename");
      await file.writeAsBytes(bytes);
      return ThemedFile(
        name: filename,
        bytes: bytes,
        path: file.path,
      );
    }

    return null;
  }

  if (Platform.isWindows) {
    var status = await Permission.storage.status;
    if (!status.isGranted) {
      status = await Permission.storage.request();
    }

    if (!status.isGranted) {
      return null;
    }

    final parentDirectory = await getApplicationDocumentsDirectory();

    FileType type = FileType.any;
    List<String> allowedExtensions = [];
    final mime = lookupMimeType(filename);

    if (mime != null) {
      if (mime.startsWith('image/')) {
        type = FileType.image;
      } else if (mime.startsWith('video/')) {
        type = FileType.video;
      } else if (mime.startsWith('audio/')) {
        type = FileType.audio;
      } else {
        type = FileType.custom;
        allowedExtensions = [extensionFromMime(mime)];
      }
    }

    final directory = await FilePicker.platform.saveFile(
      dialogTitle: dialogTitle,
      initialDirectory: parentDirectory.path,
      fileName: filename,
      type: type,
      allowedExtensions: allowedExtensions,
    );

    if (directory != null) {
      final file = File(directory);
      await file.writeAsBytes(bytes);
      return ThemedFile(
        name: filename,
        bytes: bytes,
        path: file.path,
      );
    }
    return null;
  }

  if (Platform.isIOS) {
    var status = await Permission.storage.status;
    if (!status.isGranted) {
      status = await Permission.storage.request();
    }

    if (!status.isGranted) {
      return null;
    }

    final parentDirectory = await getApplicationDocumentsDirectory();
    final directory = await FilePicker.platform.getDirectoryPath(
      dialogTitle: dialogTitle,
      initialDirectory: parentDirectory.path,
    );

    if (directory != null) {
      final file = File("$directory/$filename");
      await file.writeAsBytes(bytes);
      return ThemedFile(
        name: filename,
        bytes: bytes,
        path: file.path,
      );
    }

    return null;
  }

  if (Platform.isMacOS) {
    final parentDirectory = await getApplicationDocumentsDirectory();
    final directory = await FilePicker.platform.getDirectoryPath(
      dialogTitle: dialogTitle,
      initialDirectory: parentDirectory.path,
    );

    if (directory != null) {
      final file = File("$directory/$filename");
      await file.writeAsBytes(bytes);
      return ThemedFile(
        name: filename,
        bytes: bytes,
        path: file.path,
      );
    }

    return null;
  }

  if (Platform.isLinux) {
    final parentDirectory = await getApplicationDocumentsDirectory();
    final directory = await FilePicker.platform.getDirectoryPath(
      dialogTitle: dialogTitle,
      initialDirectory: parentDirectory.path,
    );

    if (directory != null) {
      final file = File("$directory/$filename");
      await file.writeAsBytes(bytes);
      return ThemedFile(
        name: filename,
        bytes: bytes,
        path: file.path,
      );
    }

    return null;
  }

  return null;
}