FilePicker class abstract

The interface that implementations of file_picker must implement.

Platform implementations should extend this class rather than implement it as file_picker does not consider newly added methods to be breaking changes. Extending this class (using extends) ensures that the subclass will get the default implementation, while platform implementations that implements this interface will be broken by newly added FilePicker methods.

  • Object
  • PlatformInterface
  • FilePicker




hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited


clearTemporaryFiles() Future<bool?>
Asks the underlying platform to remove any temporary files created by this plugin.
getDirectoryPath({String? dialogTitle, bool lockParentWindow = false, String? initialDirectory}) Future<String?>
Selects a directory and returns its absolute path.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
pickFiles({String? dialogTitle, String? initialDirectory, FileType type = FileType.any, List<String>? allowedExtensions, dynamic onFileLoading(FilePickerStatus)?, bool allowCompression = true, bool allowMultiple = false, bool withData = false, bool withReadStream = false, bool lockParentWindow = false, bool readSequential = false}) Future<FilePickerResult?>
Retrieves the file(s) from the underlying platform
saveFile({String? dialogTitle, String? fileName, String? initialDirectory, FileType type = FileType.any, List<String>? allowedExtensions, bool lockParentWindow = false}) Future<String?>
Opens a save file dialog which lets the user select a file path and a file name to save a file.
toString() String
A string representation of this object.


operator ==(Object other) bool
The equality operator.

Static Properties

platform FilePicker
getter/setter pair