flutter_file_picker/lib/file_picker.dart

93 lines
3.6 KiB
Dart
Raw Normal View History

2018-06-23 01:22:04 +00:00
import 'dart:async';
import 'dart:io';
2018-06-23 01:22:04 +00:00
import 'package:flutter/services.dart';
enum FileType {
any,
image,
video,
audio,
custom,
}
2018-06-23 01:22:04 +00:00
class FilePicker {
FilePicker._();
static const MethodChannel _channel = const MethodChannel('miguelruivo.flutter.plugins.file_picker');
static const String _tag = 'FilePicker';
/// Returns an iterable `Map<String,String>` where the `key` is the name of the file
/// and the `value` the path.
///
/// A [fileExtension] can be provided to filter the picking results.
/// If provided, it will be use the `FileType.CUSTOM` for that [fileExtension].
/// If not, `FileType.ANY` will be used and any combination of files can be multi picked at once.
static Future<Map<String, String>> getMultiFilePath({FileType type = FileType.any, String fileExtension}) async =>
await _getPath(_handleType(type, fileExtension), true);
/// Returns an absolute file path from the calling platform.
///
/// A [type] must be provided to filter the picking results.
/// Can be used a custom file type with `FileType.CUSTOM`. A [fileExtension] must be provided (e.g. PDF, SVG, etc.)
/// Defaults to `FileType.ANY` which will display all file types.
static Future<String> getFilePath({FileType type = FileType.any, String fileExtension}) async =>
await _getPath(_handleType(type, fileExtension), false);
/// Returns a `File` object from the selected file path.
///
/// This is an utility method that does the same of `getFilePath()` but saving some boilerplate if
/// you are planing to create a `File` for the returned path.
static Future<File> getFile({FileType type = FileType.any, String fileExtension}) async {
final String filePath = await _getPath(_handleType(type, fileExtension), false);
return filePath != null ? File(filePath) : null;
}
/// Returns a `List<File>` object from the selected files paths.
///
/// This is an utility method that does the same of `getMultiFilePath()` but saving some boilerplate if
/// you are planing to create a list of `File`s for the returned paths.
static Future<List<File>> getMultiFile({FileType type = FileType.any, String fileExtension}) async {
final Map<String, String> paths = await _getPath(_handleType(type, fileExtension), true);
return paths != null && paths.isNotEmpty ? paths.values.map((path) => File(path)).toList() : null;
}
static Future<dynamic> _getPath(String type, bool multipleSelection) async {
2018-12-27 14:02:24 +00:00
try {
dynamic result = await _channel.invokeMethod(type, multipleSelection);
if (result != null && multipleSelection) {
if (result is String) {
result = [result];
}
return Map<String, String>.fromIterable(result, key: (path) => path.split('/').last, value: (path) => path);
}
return result;
2018-12-27 14:02:24 +00:00
} on PlatformException catch (e) {
2019-06-24 10:10:19 +00:00
print('[$_tag] Platform exception: $e');
rethrow;
2018-12-27 14:02:24 +00:00
} catch (e) {
print('[$_tag] Unsupported operation. Method not found. The exception thrown was: $e');
2019-06-24 10:10:19 +00:00
rethrow;
2019-03-11 00:01:44 +00:00
}
}
static String _handleType(FileType type, String fileExtension) {
if (type != FileType.custom && (fileExtension?.isNotEmpty ?? false)) {
throw Exception('If you are using a custom extension filter, please use the FileType.custom instead.');
}
switch (type) {
case FileType.image:
return 'IMAGE';
case FileType.audio:
return 'AUDIO';
case FileType.video:
return 'VIDEO';
case FileType.any:
return 'ANY';
case FileType.custom:
return '__CUSTOM_' + (fileExtension ?? '');
default:
return 'ANY';
}
}
}