File Picker

https://pub.dev/documentation/file_picker/latest
Admin
A package that allows you to use the native file explorer to pick single or multiple files, with...
Tokens:11,139
Snippets:123
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### String get name

Source: https://pub.dev/documentation/file_picker/latest/file_picker/PlatformFile/name.html

Retrieves the name of the underlying file, including the extension.

```APIDOC
## Property: name

### Description
Returns the name of the underlying file, including the extension.

### Signature
`String get name`
```

--------------------------------

### XFile get xFile

Source: https://pub.dev/documentation/file_picker/latest/file_picker/PlatformFile/xFile.html

Retrieves the current file instance as an XFile object.

```APIDOC
## XFile get xFile

### Description
Returns the selected file as an `XFile` object for further processing or file operations.

### Signature
`XFile get xFile;`
```

--------------------------------

### Uri get uri

Source: https://pub.dev/documentation/file_picker/latest/file_picker/PlatformFile/uri.html

Retrieves the Uri associated with the underlying file. Depending on the platform, this may represent a local file path, a blob, a data URI, or a network resource.

```APIDOC
## Uri get uri

### Description
Returns an `Uri` object representing the underlying file. The format and scheme of the URI are platform-dependent and may point to local files, blobs, data URIs, or network resources.

### Signature
`Uri get uri;`
```

--------------------------------

### DesktopWindowOptions()

Source: https://pub.dev/documentation/file_picker/latest/file_picker/DesktopWindowOptions/DesktopWindowOptions.html

Creates an instance of DesktopWindowOptions to configure desktop window behavior.

```APIDOC
## DesktopWindowOptions()

### Description
Creates an instance of DesktopWindowOptions. This constructor is used to define settings for desktop windows.

### Signature
const DesktopWindowOptions({bool lockParentWindow = false})

### Parameters
- **lockParentWindow** (bool) - Optional - Defaults to false. Determines whether the parent window should be locked.
```

--------------------------------

### WebOptions()

Source: https://pub.dev/documentation/file_picker/latest/file_picker/WebOptions-class.html

Creates an instance of WebOptions for configuring web-specific file picker behavior.

```APIDOC
## WebOptions()

### Description
Creates an instance of WebOptions to be used with the file picker on web platforms.

### Constructor
`const WebOptions()`
```

--------------------------------

### Initialize WebOptions

Source: https://pub.dev/documentation/file_picker/latest/file_picker/WebOptions/WebOptions.html

Creates a new instance of the WebOptions class using the constant constructor.

```dart
const WebOptions();
```

--------------------------------

### WindowsOptions({bool lockParentWindow})

Source: https://pub.dev/documentation/file_picker/latest/file_picker/WindowsOptions/WindowsOptions.html

Creates an instance of WindowsOptions to configure file picker behavior on Windows.

```APIDOC
## WindowsOptions constructor

### Description
Creates an instance of WindowsOptions. This is used to configure specific behaviors for the file picker on the Windows platform.

### Signature
`const WindowsOptions({bool lockParentWindow = false})`

### Parameters
- **lockParentWindow** (bool) - Optional - Whether to lock the parent window during the file picker operation. Defaults to false.
```

--------------------------------

### Future<List<PlatformFile>> pickFiles

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker/pickFiles.html

Opens a native file explorer and lets the user select one or multiple files. Returns a list of PlatformFile objects or an empty list if the operation is canceled.

```APIDOC
## pickFiles

### Description
Opens a native file explorer and lets the user select one or multiple files. The method returns a list of PlatformFile objects representing the selected files.

### Signature
Future<List<PlatformFile>> pickFiles({
  String? dialogTitle,
  String? initialDirectory,
  FileType type = FileType.any,
  List<String>? allowedExtensions,
  Function(FilePickerStatus)? onFileLoading,
  int compressionQuality = 0,
  AndroidOptions androidOptions = const AndroidOptions(),
  WindowsOptions windowsOptions = const WindowsOptions(),
  LinuxOptions linuxOptions = const LinuxOptions(),
  WebOptions webOptions = const WebOptions()
})

### Parameters
- **dialogTitle** (String?) - Optional - The title for the picker dialog.
- **initialDirectory** (String?) - Optional - The initial directory path for the picker.
- **type** (FileType) - Optional - The type of files that can be selected (defaults to FileType.any).
- **allowedExtensions** (List<String>?) - Optional - Filter by specific file extensions when type is set to FileType.custom.
- **onFileLoading** (Function(FilePickerStatus)?) - Optional - Callback to track picker status changes.
- **compressionQuality** (int) - Optional - Compresses picked images/videos on supported platforms (0-100).
- **androidOptions** (AndroidOptions) - Optional - Android-specific configurations.
- **windowsOptions** (WindowsOptions) - Optional - Windows-specific configurations.
- **linuxOptions** (LinuxOptions) - Optional - Linux-specific configurations.
- **webOptions** (WebOptions) - Optional - Web-specific configurations.

### Returns
- **List<PlatformFile>** - A list of selected files, or an empty list if the user canceled the operation.
```

--------------------------------

### pickFiles()

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform-class.html

Pick multiple files using the native file picker.

```APIDOC
## Future<List<PlatformFile>> pickFiles({String? dialogTitle, String? initialDirectory, FileType type, List<String>? allowedExtensions, dynamic onFileLoading(FilePickerStatus)?, int compressionQuality, AndroidOptions androidOptions, WindowsOptions windowsOptions, LinuxOptions linuxOptions, WebOptions webOptions})

### Description
Pick multiple files using the native file picker.
```

--------------------------------

### WindowsOptions constructor

Source: https://pub.dev/documentation/file_picker/latest/file_picker/WindowsOptions-class.html

Creates an instance of WindowsOptions to configure file picker behavior on Windows.

```APIDOC
## WindowsOptions({bool lockParentWindow = false})

### Description
Creates an instance of WindowsOptions. Use this to specify configuration for the Windows file picker.

### Parameters
- **lockParentWindow** (bool) - Optional - Whether to lock the parent window modally when showing the file picker dialog. Defaults to false.
```

--------------------------------

### Future<PlatformFile?> pickFile(...)

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker/pickFile.html

Opens a native file explorer and lets the user select a single file. Returns a PlatformFile object if a file was selected, or null if the operation was canceled.

```APIDOC
## pickFile

### Description
Opens a native file explorer and lets the user select a single file. Returns a PlatformFile object if a file was selected, or null if the user canceled the operation.

### Parameters
- **dialogTitle** (String?) - Optional - The title for the picker dialog.
- **initialDirectory** (String?) - Optional - The initial directory path for the picker.
- **type** (FileType) - Optional - The type of file that can be selected (default: FileType.any).
- **allowedExtensions** (List<String>?) - Optional - Filter by specific file extensions when type is set to FileType.custom.
- **onFileLoading** (Function(FilePickerStatus)?) - Optional - Callback to track picker status changes.
- **compressionQuality** (int) - Optional - Compression quality for images/videos on supported platforms (0-100, default: 0).
- **androidOptions** (AndroidOptions) - Optional - Platform-specific configuration for Android.
- **windowsOptions** (WindowsOptions) - Optional - Platform-specific configuration for Windows.
- **linuxOptions** (LinuxOptions) - Optional - Platform-specific configuration for Linux.
- **webOptions** (WebOptions) - Optional - Platform-specific configuration for Web.
```

--------------------------------

### LinuxOptions constructor

Source: https://pub.dev/documentation/file_picker/latest/file_picker/LinuxOptions-class.html

Creates an instance of LinuxOptions to configure the Linux file picker dialog.

```APIDOC
## LinuxOptions({String? acceptLabel, bool lockParentWindow = false})

### Description
Creates an instance of LinuxOptions. This object is used to define the behavior and appearance of the file picker dialog on Linux.

### Parameters
- **acceptLabel** (String?) - Optional - The label for the accept button of the file chooser dialog.
- **lockParentWindow** (bool) - Optional - Whether to lock the parent window modally when showing the file picker dialog. Defaults to false.
```

--------------------------------

### AndroidOptions()

Source: https://pub.dev/documentation/file_picker/latest/file_picker/AndroidOptions-class.html

Constructor to create an instance of AndroidOptions.

```APIDOC
## AndroidOptions()

### Description
Creates an instance of AndroidOptions for configuring the file picker on Android.

### Signature
`const AndroidOptions()`
```

--------------------------------

### pickFile

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker-class.html

Opens a native file explorer and lets the user select a single file.

```APIDOC
## pickFile()

### Description
Opens a native file explorer and lets the user select a single file.

### Parameters
- **dialogTitle** (String?) - Optional
- **initialDirectory** (String?) - Optional
- **type** (FileType) - Optional
- **allowedExtensions** (List<String>?) - Optional
- **onFileLoading** (Function?) - Optional
- **compressionQuality** (int) - Optional
- **lockParentWindow** (bool) - Optional
- **cancelUploadOnWindowBlur** (bool) - Optional

### Returns
- **Future<PlatformFile?>**
```

--------------------------------

### FilePickerPlatform.instance

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform/instance.html

Access the current platform-specific implementation of the FilePickerPlatform.

```APIDOC
## static FilePickerPlatform get instance

### Description
Retrieves the current singleton instance of the FilePickerPlatform.

### Signature
`static FilePickerPlatform get instance`
```

--------------------------------

### LinuxOptions Constructor Implementation

Source: https://pub.dev/documentation/file_picker/latest/file_picker/LinuxOptions/LinuxOptions.html

The primary constructor for defining Linux-specific file picker behavior.

```dart
const LinuxOptions({this.acceptLabel, super.lockParentWindow});
```

--------------------------------

### Pick a directory

Source: https://pub.dev/documentation/file_picker/latest/index.html

Use getDirectoryPath to allow the user to select a directory. Returns null if canceled.

```dart
String? selectedDirectory = await FilePicker.getDirectoryPath();

if (selectedDirectory == null) {
  // User canceled the picker
}
```

--------------------------------

### pickFiles

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform/pickFiles.html

Opens the native file picker to select multiple files.

```APIDOC
## pickFiles

### Description
Pick multiple files using the native file picker.

### Signature
`Future<List<PlatformFile>> pickFiles({String? dialogTitle, String? initialDirectory, FileType type = FileType.any, List<String>? allowedExtensions, Function(FilePickerStatus)? onFileLoading, int compressionQuality = 0, AndroidOptions androidOptions = const AndroidOptions(), WindowsOptions windowsOptions = const WindowsOptions(), LinuxOptions linuxOptions = const LinuxOptions(), WebOptions webOptions = const WebOptions()})`

### Parameters
- **dialogTitle** (String?) - Optional - Title for the picker dialog.
- **initialDirectory** (String?) - Optional - Initial directory path for the picker.
- **type** (FileType) - Optional - Specifies the type of files to be picked (defaults to FileType.any).
- **allowedExtensions** (List<String>?) - Optional - Restricts selection to specified file extensions when type is FileType.custom.
- **onFileLoading** (Function(FilePickerStatus)?) - Optional - Callback triggered when the picker changes status.
- **compressionQuality** (int) - Optional - Image/video compression quality (0-100) on supported platforms (defaults to 0).
- **androidOptions** (AndroidOptions) - Optional - Platform-specific configurations for Android.
- **windowsOptions** (WindowsOptions) - Optional - Platform-specific configurations for Windows.
- **linuxOptions** (LinuxOptions) - Optional - Platform-specific configurations for Linux.
- **webOptions** (WebOptions) - Optional - Platform-specific configurations for Web.

### Returns
- **List<PlatformFile>** - A list of selected files, or an empty list if the operation was canceled.
```

--------------------------------

### pickFiles

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker-class.html

Retrieves the file(s) from the underlying platform.

```APIDOC
## pickFiles()

### Description
Retrieves the file(s) from the underlying platform.

### Returns
- **Future<List<PlatformFile>>**
```

--------------------------------

### Implementation of pickFileAndDirectoryPaths

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker/pickFileAndDirectoryPaths.html

This method delegates the file and directory selection process to the platform-specific FilePicker implementation.

```dart
static Future<List<String>> pickFileAndDirectoryPaths({
  String? dialogTitle,
  String? initialDirectory,
  FileType type = FileType.any,
  List<String>? allowedExtensions,
}) {
  return FilePickerPlatform.instance.pickFileAndDirectoryPaths(
    dialogTitle: dialogTitle,
    initialDirectory: initialDirectory,
    type: type,
    allowedExtensions: allowedExtensions,
  );
}
```

--------------------------------

### PlatformFile Methods

Source: https://pub.dev/documentation/file_picker/latest/file_picker/PlatformFile-class.html

Methods to retrieve file information and read file content.

```APIDOC
## Methods

- **length() → Future<int>**: Get the length of the file in bytes.
- **readAsBytes() → Future<Uint8List>**: Read the bytes of the file as a single chunk.
- **readAsByteStream() → Stream<Uint8List>**: Read the file content as a stream of bytes.
```

--------------------------------

### Implementation of pickFiles

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker/pickFiles.html

The internal implementation of the pickFiles static method, which delegates the file selection process to the platform-specific FilePickerPlatform instance.

```dart
static Future<List<PlatformFile>> pickFiles({
  String? dialogTitle,
  String? initialDirectory,
  FileType type = FileType.any,
  List<String>? allowedExtensions,
  Function(FilePickerStatus)? onFileLoading,
  int compressionQuality = 0,
  @Deprecated(
    'use pickFile for single-file selection; this parameter will be removed in a future release',
  )
  bool allowMultiple = true,
  @Deprecated(
    'Use PlatformFile.readAsBytes(); this parameter will be removed in a future release',
  )
  bool withData = kIsWeb,
  @Deprecated(
    'Use PlatformFile.readAsByteStream(); this parameter will be removed in a future release',
  )
  bool withReadStream = false,
  @Deprecated(
    'Use WindowsOptions.lockParentWindow or LinuxOptions.lockParentWindow instead; this parameter will be removed in a future release.',
  )
  bool lockParentWindow = false,
  @Deprecated(
    'Use PlatformFile.readAsByteStream(); this parameter will be removed in a future release',
  )
  bool readSequential = false,
  @Deprecated(
    'Use WebOptions.cancelUploadOnWindowBlur instead; this parameter will be removed in a future release.',
  )
  bool cancelUploadOnWindowBlur = true,
  @Deprecated('Use androidOptions instead.') Object? androidSafOptions,
  AndroidOptions androidOptions = const AndroidOptions(),
  WindowsOptions windowsOptions = const WindowsOptions(),
  LinuxOptions linuxOptions = const LinuxOptions(),
  WebOptions webOptions = const WebOptions(),
}) {
  return FilePickerPlatform.instance.pickFiles(
    dialogTitle: dialogTitle,
    initialDirectory: initialDirectory,
    type: type,
    allowedExtensions: allowedExtensions,
    onFileLoading: onFileLoading,
    compressionQuality: compressionQuality,
    androidOptions: _resolveAndroidOptions(androidSafOptions, androidOptions),
    windowsOptions: windowsOptions,
    linuxOptions: linuxOptions,
    webOptions: webOptions,
  );
}
```

--------------------------------

### DesktopWindowOptions(bool lockParentWindow)

Source: https://pub.dev/documentation/file_picker/latest/file_picker/DesktopWindowOptions-class.html

Constructor for creating a new instance of DesktopWindowOptions with an optional parameter to lock the parent window.

```APIDOC
## DesktopWindowOptions(bool lockParentWindow)

### Description
Creates an instance of DesktopWindowOptions to configure desktop-specific file picker behavior.

### Parameters
- **lockParentWindow** (bool) - Optional - Whether to lock the parent window modally when showing the file picker dialog. Defaults to false.
```

--------------------------------

### PlatformFile Properties

Source: https://pub.dev/documentation/file_picker/latest/file_picker/PlatformFile-class.html

Access metadata and references for the picked file.

```APIDOC
## Properties

- **name** (String): The name of the underlying file, including the extension.
- **path** (String?): The local file path of the underlying file, or null if not on local disk.
- **uri** (Uri): An Uri to the underlying file.
- **xFile** (XFile): Get this file as an XFile.
```

--------------------------------

### Initialize FilePickerPlatform

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform/FilePickerPlatform.html

Constructor for the FilePickerPlatform class, which requires a token for initialization.

```dart
FilePickerPlatform() : super(token: _token);
```

--------------------------------

### Pick multiple files

Source: https://pub.dev/documentation/file_picker/latest/index.html

Use pickFiles to retrieve a list of files. Returns an empty list if the user cancels the operation.

```dart
List<PlatformFile> files = await FilePicker.pickFiles();

if (files.isNotEmpty) {
  for (final file in files) {
    print(file.name);
  }
} else {
  // User canceled the picker
}
```

--------------------------------

### Implementation of pickFile static method

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker/pickFile.html

This method acts as a wrapper for the platform-specific file picker implementation, handling various configuration parameters.

```dart
static Future<PlatformFile?> pickFile({
  String? dialogTitle,
  String? initialDirectory,
  FileType type = FileType.any,
  List<String>? allowedExtensions,
  Function(FilePickerStatus)? onFileLoading,
  int compressionQuality = 0,
  @Deprecated(
    'Use WindowsOptions.lockParentWindow or LinuxOptions.lockParentWindow instead; this parameter will be removed in a future release.',
  )
  bool lockParentWindow = false,
  @Deprecated(
    'Use WebOptions.cancelUploadOnWindowBlur instead; this parameter will be removed in a future release.',
  )
  bool cancelUploadOnWindowBlur = true,
  @Deprecated('Use androidOptions instead.') Object? androidSafOptions,
  AndroidOptions androidOptions = const AndroidOptions(),
  WindowsOptions windowsOptions = const WindowsOptions(),
  LinuxOptions linuxOptions = const LinuxOptions(),
  WebOptions webOptions = const WebOptions(),
}) {
  return FilePickerPlatform.instance.pickFile(
    dialogTitle: dialogTitle,
    initialDirectory: initialDirectory,
    type: type,
    allowedExtensions: allowedExtensions,
    onFileLoading: onFileLoading,
    compressionQuality: compressionQuality,
    androidOptions: _resolveAndroidOptions(androidSafOptions, androidOptions),
    windowsOptions: windowsOptions,
    linuxOptions: linuxOptions,
    webOptions: webOptions,
  );
}
```

--------------------------------

### pickFileAndDirectoryPaths

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform/pickFileAndDirectoryPaths.html

Opens the native file picker to select files and directories.

```APIDOC
## pickFileAndDirectoryPaths

### Description
Pick files and directories using the native file picker. Returns a list of absolute paths for the selected items, or an empty list if the operation is canceled.

### Signature
`Future<List<String>> pickFileAndDirectoryPaths({String? dialogTitle, String? initialDirectory, FileType type = FileType.any, List<String>? allowedExtensions})`

### Parameters
- **dialogTitle** (String?) - Optional - The title for the picker dialog.
- **initialDirectory** (String?) - Optional - The initial directory path for the picker.
- **type** (FileType) - Optional - Specifies the type of files to be picked (defaults to FileType.any).
- **allowedExtensions** (List<String>?) - Optional - Restricts selection to specified file extensions when type is set to FileType.custom.
```

--------------------------------

### FilePickerPlatform.instance (setter)

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform/instance.html

Set the platform-specific implementation for the FilePickerPlatform.

```APIDOC
## static set instance(FilePickerPlatform instance)

### Description
Sets the platform-specific implementation. This method verifies the instance using a platform token before assignment.

### Signature
`static set instance(FilePickerPlatform instance)`

### Parameters
- **instance** (FilePickerPlatform) - Required - The platform-specific implementation to set.
```

--------------------------------

### pickFileAndDirectoryPaths

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker/pickFileAndDirectoryPaths.html

Displays a dialog that allows the user to select both files and directories simultaneously, returning their absolute paths. This functionality is currently only supported on macOS.

```APIDOC
## pickFileAndDirectoryPaths

### Signature
`Future<List<String>> pickFileAndDirectoryPaths({String? dialogTitle, String? initialDirectory, FileType type = FileType.any, List<String>? allowedExtensions})`

### Description
Displays a dialog that allows the user to select both files and directories simultaneously, returning their absolute paths.

### Parameters
- **dialogTitle** (String?) - Optional - The title for the picker dialog.
- **initialDirectory** (String?) - Optional - The initial directory path for the picker.
- **type** (FileType) - Optional - Specifies the type of files to be picked (defaults to FileType.any).
- **allowedExtensions** (List<String>?) - Optional - Used to filter by specific file extensions when type is set to FileType.custom.

### Returns
- **Future<List<String>>** - A list of absolute paths to the selected files and directories, or an empty list if the operation was canceled.

### Platform Support
- macOS
```

--------------------------------

### Implementation of saveFile static method

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker/saveFile.html

This snippet shows the implementation of the saveFile method, which delegates the operation to the FilePickerPlatform instance.

```dart
static Future<Uri?> saveFile({
  required String fileName,
  required Uint8List bytes,
  String mimeType = 'application/octet-stream',
  String? dialogTitle,
  String? initialDirectory,
  FileType type = FileType.any,
  List<String>? allowedExtensions,
  Function(FilePickerStatus)? onFileSaving,
  @Deprecated(
    'Use WindowsOptions.lockParentWindow or LinuxOptions.lockParentWindow instead; this parameter will be removed in a future release.',
  )
  bool lockParentWindow = false,
  WindowsOptions windowsOptions = const WindowsOptions(),
  LinuxOptions linuxOptions = const LinuxOptions(),
  WebOptions webOptions = const WebOptions(),
}) {
  return FilePickerPlatform.instance.saveFile(
    fileName: fileName,
    bytes: bytes,
    mimeType: mimeType,
    dialogTitle: dialogTitle,
    initialDirectory: initialDirectory,
    onFileSaving: onFileSaving,
    windowsOptions: windowsOptions,
    linuxOptions: linuxOptions,
    webOptions: webOptions,
  );
}
```

--------------------------------

### DesktopWindowOptions Constructor Implementation

Source: https://pub.dev/documentation/file_picker/latest/file_picker/DesktopWindowOptions/DesktopWindowOptions.html

The constructor initializes the DesktopWindowOptions instance with an optional lockParentWindow parameter.

```dart
const DesktopWindowOptions({this.lockParentWindow = false});
```

--------------------------------

### pickFile

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform/pickFile.html

Triggers the native file picker to select a single file. Returns a PlatformFile object or null if canceled.

```APIDOC
## pickFile

### Description
Pick a single file using the native file picker.

### Signature
Future<PlatformFile?> pickFile({
  String? dialogTitle,
  String? initialDirectory,
  FileType type = FileType.any,
  List<String>? allowedExtensions,
  Function(FilePickerStatus)? onFileLoading,
  int compressionQuality = 0,
  AndroidOptions androidOptions = const AndroidOptions(),
  WindowsOptions windowsOptions = const WindowsOptions(),
  LinuxOptions linuxOptions = const LinuxOptions(),
  WebOptions webOptions = const WebOptions(),
})

### Parameters
- **dialogTitle** (String?) - Optional - Title for the picker dialog.
- **initialDirectory** (String?) - Optional - Initial directory path for the picker.
- **type** (FileType) - Optional - Type of file to be picked (defaults to FileType.any).
- **allowedExtensions** (List<String>?) - Optional - Restricts selection to specified extensions when type is FileType.custom.
- **onFileLoading** (Function(FilePickerStatus)?) - Optional - Callback triggered when the picker changes status.
- **compressionQuality** (int) - Optional - Image/video compression quality (0-100) on supported platforms.
- **androidOptions** (AndroidOptions) - Optional - Platform-specific configuration for Android.
- **windowsOptions** (WindowsOptions) - Optional - Platform-specific configuration for Windows.
- **linuxOptions** (LinuxOptions) - Optional - Platform-specific configuration for Linux.
- **webOptions** (WebOptions) - Optional - Platform-specific configuration for Web.

### Returns
- **PlatformFile?** - The selected file, or null if the user canceled the operation.
```

--------------------------------

### pickFiles method implementation

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform/pickFiles.html

The default implementation of the pickFiles method, which throws an UnimplementedError if not overridden by a platform-specific class.

```dart
Future<List<PlatformFile>> pickFiles({
  String? dialogTitle,
  String? initialDirectory,
  FileType type = FileType.any,
  List<String>? allowedExtensions,
  Function(FilePickerStatus)? onFileLoading,
  int compressionQuality = 0,
  AndroidOptions androidOptions = const AndroidOptions(),
  WindowsOptions windowsOptions = const WindowsOptions(),
  LinuxOptions linuxOptions = const LinuxOptions(),
  WebOptions webOptions = const WebOptions(),
}) {
  throw UnimplementedError('pickFiles() has not been implemented.');
}
```

--------------------------------

### Implementation of pickFileAndDirectoryPaths

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform/pickFileAndDirectoryPaths.html

The default implementation of the pickFileAndDirectoryPaths method, which throws an UnimplementedError.

```dart
Future<List<String>> pickFileAndDirectoryPaths({
  String? dialogTitle,
  String? initialDirectory,
  FileType type = FileType.any,
  List<String>? allowedExtensions,
}) async {
  throw UnimplementedError(
    'pickFileAndDirectoryPaths() has not been implemented.',
  );
}
```

--------------------------------

### pickFile method implementation

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform/pickFile.html

The default implementation of the pickFile method, which throws an UnimplementedError if not overridden by a platform-specific subclass.

```dart
Future<PlatformFile?> pickFile({
  String? dialogTitle,
  String? initialDirectory,
  FileType type = FileType.any,
  List<String>? allowedExtensions,
  Function(FilePickerStatus)? onFileLoading,
  int compressionQuality = 0,
  AndroidOptions androidOptions = const AndroidOptions(),
  WindowsOptions windowsOptions = const WindowsOptions(),
  LinuxOptions linuxOptions = const LinuxOptions(),
  WebOptions webOptions = const WebOptions(),
}) {
  throw UnimplementedError('pickFile() has not been implemented.');
}
```

--------------------------------

### Accessing the PlatformFile name property

Source: https://pub.dev/documentation/file_picker/latest/file_picker/PlatformFile/name.html

Retrieves the name of the underlying file as a String.

```dart
String get name;
```

--------------------------------

### getDirectoryPath()

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform-class.html

Pick a single directory using the native file picker.

```APIDOC
## Future<String?> getDirectoryPath({String? dialogTitle, String? initialDirectory, AndroidOptions androidOptions, WindowsOptions windowsOptions, LinuxOptions linuxOptions, WebOptions webOptions})

### Description
Pick a single directory using the native file picker.
```

--------------------------------

### Retrieve XFile instance

Source: https://pub.dev/documentation/file_picker/latest/file_picker/PlatformFile/xFile.html

Access the file content as an XFile object.

```dart
XFile get xFile;
```

--------------------------------

### AndroidOptions Constructor

Source: https://pub.dev/documentation/file_picker/latest/file_picker/AndroidOptions/AndroidOptions.html

Creates an instance of AndroidOptions for configuring file picker behavior on Android.

```dart
const AndroidOptions();
```

--------------------------------

### getDirectoryPath

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker-class.html

Selects a directory and returns its absolute path.

```APIDOC
## getDirectoryPath()

### Description
Selects a directory and returns its absolute path.

### Parameters
- **dialogTitle** (String?) - Optional
- **lockParentWindow** (bool) - Optional
- **initialDirectory** (String?) - Optional
- **androidSafOptions** (Object?) - Optional
- **androidOptions** (AndroidOptions) - Optional
- **windowsOptions** (WindowsOptions) - Optional
- **linuxOptions** (LinuxOptions) - Optional
- **webOptions** (WebOptions) - Optional

### Returns
- **Future<String?>**
```

--------------------------------

### saveFile implementation

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform/saveFile.html

The default implementation of the saveFile method, which throws an UnimplementedError.

```dart
Future<Uri?> saveFile({
  required String fileName,
  required Uint8List bytes,
  required String mimeType,
  String? dialogTitle,
  String? initialDirectory,
  Function(FilePickerStatus)? onFileSaving,
  WindowsOptions windowsOptions = const WindowsOptions(),
  LinuxOptions linuxOptions = const LinuxOptions(),
  WebOptions webOptions = const WebOptions(),
}) async {
  throw UnimplementedError('saveFile() has not been implemented.');
}
```

--------------------------------

### Pick a single file

Source: https://pub.dev/documentation/file_picker/latest/index.html

Use pickFile to retrieve a single file. Returns null if the user cancels the operation.

```dart
PlatformFile? file = await FilePicker.pickFile();

if (file != null) {
  print(file.name);
  print(await file.length());
} else {
  // User canceled the picker
}
```

--------------------------------

### Implementation of getDirectoryPath

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker/getDirectoryPath.html

The internal implementation of the getDirectoryPath method, which delegates to the platform-specific FilePicker instance.

```dart
static Future<String?> getDirectoryPath({
  String? dialogTitle,
  @Deprecated(
    'Use WindowsOptions.lockParentWindow or LinuxOptions.lockParentWindow instead; this parameter will be removed in a future release.',
  )
  bool lockParentWindow = false,
  String? initialDirectory,
  @Deprecated('Use androidOptions instead.') Object? androidSafOptions,
  AndroidOptions androidOptions = const AndroidOptions(),
  WindowsOptions windowsOptions = const WindowsOptions(),
  LinuxOptions linuxOptions = const LinuxOptions(),
  WebOptions webOptions = const WebOptions(),
}) {
  return FilePickerPlatform.instance.getDirectoryPath(
    dialogTitle: dialogTitle,
    initialDirectory: initialDirectory,
    androidOptions: _resolveAndroidOptions(androidSafOptions, androidOptions),
    windowsOptions: windowsOptions,
    linuxOptions: linuxOptions,
    webOptions: webOptions,
  );
}
```

--------------------------------

### Set FilePickerPlatform instance

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform/instance.html

Assign a new instance to the FilePickerPlatform, verifying the token before setting.

```dart
static set instance(FilePickerPlatform instance) {
  PlatformInterface.verifyToken(instance, _token);
  _instance = instance;
}
```

--------------------------------

### Pick multiple files with extension filter

Source: https://pub.dev/documentation/file_picker/latest/index.html

Filter selectable files by providing a list of allowed extensions using FileType.custom.

```dart
List<PlatformFile> files = await FilePicker.pickFiles(
  type: FileType.custom,
  allowedExtensions: ['jpg', 'pdf', 'doc'],
);
```

--------------------------------

### getDirectoryPath method implementation

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform/getDirectoryPath.html

The default implementation of the getDirectoryPath method, which throws an UnimplementedError.

```dart
Future<String?> getDirectoryPath({
  String? dialogTitle,
  String? initialDirectory,
  AndroidOptions androidOptions = const AndroidOptions(),
  WindowsOptions windowsOptions = const WindowsOptions(),
  LinuxOptions linuxOptions = const LinuxOptions(),
  WebOptions webOptions = const WebOptions(),
}) async {
  throw UnimplementedError('getDirectoryPath() has not been implemented.');
}
```

--------------------------------

### saveFile()

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform-class.html

Save the given bytes to a file with the given fileName, using the native save file dialog.

```APIDOC
## Future<Uri?> saveFile({required String fileName, required Uint8List bytes, required String mimeType, String? dialogTitle, String? initialDirectory, dynamic onFileSaving(FilePickerStatus)?, WindowsOptions windowsOptions, LinuxOptions linuxOptions, WebOptions webOptions})

### Description
Save the given `bytes` to a file with the given `fileName`, using the native save file dialog.
```

--------------------------------

### WindowsOptions Constructor Implementation

Source: https://pub.dev/documentation/file_picker/latest/file_picker/WindowsOptions/WindowsOptions.html

The constructor for WindowsOptions, which accepts an optional lockParentWindow parameter.

```dart
const WindowsOptions({super.lockParentWindow});
```

--------------------------------

### saveFile

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker-class.html

Opens a save file dialog to let the user select a location and a file name to save bytes to.

```APIDOC
## saveFile()

### Description
Opens a save file dialog to let the user select a location and a file name to save bytes to.

### Parameters
- **fileName** (String) - Required
- **bytes** (Uint8List) - Required
- **mimeType** (String) - Optional

### Returns
- **Future<Uri?>**
```

--------------------------------

### Registering the FilePickerPlatform instance

Source: https://pub.dev/documentation/file_picker/latest/file_picker/MethodChannelFilePicker/registerWith.html

This method assigns an instance of MethodChannelFilePicker to the FilePickerPlatform.instance property.

```dart
static void registerWith() {
  FilePickerPlatform.instance = MethodChannelFilePicker();
}
```

--------------------------------

### Implementation of saveBytesToFile

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerSaveUtils/saveBytesToFile.html

This method spawns an isolate to handle the file writing process, ensuring the main thread remains responsive. It requires a non-empty Uint8List and a valid file path.

```dart
static Future<void> saveBytesToFile(Uint8List bytes, String path) async {
  if (bytes.isEmpty) {
    return;
  }

  final receivePort = ReceivePort();
  final transferable = TransferableTypedData.fromList([bytes]);

  await Isolate.spawn(_saveBytesIsolateEntry, [
    receivePort.sendPort,
    path,
    transferable,
  ]);

  final result = await receivePort.first;

  receivePort.close();

  if (result is Exception) {
    throw result;
  }
}
```

--------------------------------

### Define MethodChannel for FilePicker

Source: https://pub.dev/documentation/file_picker/latest/file_picker/MethodChannelFilePicker/methodChannel.html

This snippet initializes the MethodChannel with the plugin's specific channel name and standard codec, marked as visible for testing.

```dart
@visibleForTesting
final methodChannel = const MethodChannel(
  'miguelruivo.flutter.plugins.filepicker',
  StandardMethodCodec(),
);
```

--------------------------------

### getDirectoryPath

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker/getDirectoryPath.html

Opens a directory picker dialog and returns the absolute path of the selected directory or null if canceled.

```APIDOC
## getDirectoryPath

### Description
Selects a directory and returns its absolute path. Returns null if the user cancels the operation.

### Signature
`Future<String?> getDirectoryPath({String? dialogTitle, bool lockParentWindow = false, String? initialDirectory, Object? androidSafOptions, AndroidOptions androidOptions = const AndroidOptions(), WindowsOptions windowsOptions = const WindowsOptions(), LinuxOptions linuxOptions = const LinuxOptions(), WebOptions webOptions = const WebOptions()})`

### Parameters
- **dialogTitle** (String?) - Optional - The title for the directory picker dialog.
- **lockParentWindow** (bool) - Optional - Deprecated. Use platform-specific options instead.
- **initialDirectory** (String?) - Optional - The initial directory path for the picker.
- **androidSafOptions** (Object?) - Optional - Deprecated. Use androidOptions instead.
- **androidOptions** (AndroidOptions) - Optional - Platform-specific configuration for Android.
- **windowsOptions** (WindowsOptions) - Optional - Platform-specific configuration for Windows.
- **linuxOptions** (LinuxOptions) - Optional - Platform-specific configuration for Linux.
- **webOptions** (WebOptions) - Optional - Platform-specific configuration for Web.

### Returns
- **Future<String?>** - The absolute path of the selected directory, or null if the user canceled.
```

--------------------------------

### Retrieve FilePickerPlatform instance

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform/instance.html

Access the current singleton instance of the FilePickerPlatform.

```dart
static FilePickerPlatform get instance => _instance;
```

--------------------------------

### Save-file dialog

Source: https://pub.dev/documentation/file_picker/latest/index.html

Use saveFile to open a native dialog for saving a file. Requires the file bytes and an optional default filename.

```dart
Uri? outputFile = await FilePicker.saveFile(
  dialogTitle: 'Please select an output file:',
  fileName: 'output-file.pdf',
  bytes: pdfBytes,
);

if (outputFile == null) {
  // User canceled the picker
}
```

--------------------------------

### length method signature

Source: https://pub.dev/documentation/file_picker/latest/file_picker/PlatformFile/length.html

The method signature for retrieving the file length as a Future integer.

```dart
Future<int> length();
```

--------------------------------

### saveFile method signature

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform/saveFile.html

The method signature for saveFile, defining parameters for file data, dialog configuration, and platform-specific options.

```dart
Future<Uri?> saveFile({
  1. required String fileName, 
  2. required Uint8List bytes, 
  3. required String mimeType, 
  4. String? dialogTitle, 
  5. String? initialDirectory, 
  6. dynamic onFileSaving(
    1. FilePickerStatus
)?, 
  7. WindowsOptions windowsOptions = const WindowsOptions(), 
  8. LinuxOptions linuxOptions = const LinuxOptions(), 
  9. WebOptions webOptions = const WebOptions(), 

})
```

--------------------------------

### Define EventChannel for File Picker

Source: https://pub.dev/documentation/file_picker/latest/file_picker/MethodChannelFilePicker/eventChannel.html

Initializes the EventChannel with the plugin's specific communication string for receiving native events.

```dart
@visibleForTesting
final eventChannel = const EventChannel(
  'miguelruivo.flutter.plugins.filepickerevent',
);
```

--------------------------------

### readAsBytes method signature

Source: https://pub.dev/documentation/file_picker/latest/file_picker/PlatformFile/readAsBytes.html

The abstract method definition for reading file bytes.

```dart
Future<Uint8List> readAsBytes();
```

--------------------------------

### PlatformFile.path

Source: https://pub.dev/documentation/file_picker/latest/file_picker/PlatformFile/path.html

Retrieves the local file path of the underlying file. Returns null if the file is not located on the local disk.

```APIDOC
## String? path

### Description
The local file path of the underlying file. Returns `null` if the file is not on the local disk.

### Signature
`String? get path`

### Returns
- **String?** - The absolute file path if the URI scheme is 'file', otherwise `null`.
```

--------------------------------

### Define acceptLabel property

Source: https://pub.dev/documentation/file_picker/latest/file_picker/LinuxOptions/acceptLabel.html

The property is defined as a nullable String within the LinuxOptions configuration.

```dart
final String? acceptLabel;
```

--------------------------------

### Future<int> length()

Source: https://pub.dev/documentation/file_picker/latest/file_picker/PlatformFile/length.html

Retrieves the size of the file in bytes.

```APIDOC
## Future<int> length()

### Description
Returns the length of the file in bytes.

### Signature
`Future<int> length()`

### Returns
- **Future<int>** - A future that completes with the file size in bytes.
```

--------------------------------

### FileType.values

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FileType/values-constant.html

A constant List of all available FileType values, ordered as declared in the enum.

```APIDOC
## values constant 
List<FileType> const values
A constant List of the values in this enum, in order of their declaration.
```

--------------------------------

### Stream<Uint8List> readAsByteStream()

Source: https://pub.dev/documentation/file_picker/latest/file_picker/PlatformFile/readAsByteStream.html

Reads the file content as a stream of bytes.

```APIDOC
## readAsByteStream

### Description
Reads the file content as a stream of bytes.

### Signature
`Stream<Uint8List> readAsByteStream()`

### Returns
- **Stream<Uint8List>** - A stream containing the file's byte data.
```

--------------------------------

### Accessing the path property

Source: https://pub.dev/documentation/file_picker/latest/file_picker/PlatformFile/path.html

Retrieves the local file path if the URI scheme is 'file', otherwise returns null.

```dart
String? get path => uri.scheme == 'file' ? uri.toFilePath() : null;
```

--------------------------------

### saveFile(fileName, bytes, mimeType, ...)

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform/saveFile.html

Saves the provided byte data to a file using the native save file dialog. Returns the Uri of the saved file or null if the operation is canceled.

```APIDOC
## saveFile

### Description
Saves the given `bytes` to a file with the given `fileName`, using the native save file dialog. The method supports platform-specific options for Windows, Linux, and Web.

### Signature
`Future<Uri?> saveFile({required String fileName, required Uint8List bytes, required String mimeType, String? dialogTitle, String? initialDirectory, Function(FilePickerStatus)? onFileSaving, WindowsOptions windowsOptions, LinuxOptions linuxOptions, WebOptions webOptions})`

### Parameters
- **fileName** (String) - Required - The default file name for saving.
- **bytes** (Uint8List) - Required - The raw byte data to write.
- **mimeType** (String) - Required - The MIME type of the file.
- **dialogTitle** (String) - Optional - The title for the save file dialog.
- **initialDirectory** (String) - Optional - The initial directory path for the save file dialog.
- **onFileSaving** (Function) - Optional - Callback triggered when the save dialog changes status.
- **windowsOptions** (WindowsOptions) - Optional - Platform-specific configurations for Windows.
- **linuxOptions** (LinuxOptions) - Optional - Platform-specific configurations for Linux.
- **webOptions** (WebOptions) - Optional - Platform-specific configurations for Web.

### Returns
- **Uri?** - The Uri of the saved file, or null if the user canceled the operation.
```

--------------------------------

### Clear temporary files implementation

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker/clearTemporaryFiles.html

This method invokes the platform-specific implementation to clean up temporary files created during file selection.

```dart
static Future<void> clearTemporaryFiles() async {
  await FilePickerPlatform.instance.clearTemporaryFiles();
}
```

--------------------------------

### readAsByteStream method definition

Source: https://pub.dev/documentation/file_picker/latest/file_picker/PlatformFile/readAsByteStream.html

The abstract method signature for reading file content as a stream of bytes.

```dart
Stream<Uint8List> readAsByteStream();
```

--------------------------------

### lockParentWindow property

Source: https://pub.dev/documentation/file_picker/latest/file_picker/DesktopWindowOptions-class.html

Accesses the configuration setting for modal window locking.

```APIDOC
## lockParentWindow

### Description
Returns a boolean indicating whether the parent window is locked modally when the file picker dialog is active.

### Type
bool (final)
```

--------------------------------

### clearTemporaryFiles implementation

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerPlatform/clearTemporaryFiles.html

The default implementation of the clearTemporaryFiles method, which performs no action.

```dart
Future<void> clearTemporaryFiles() async {}
```

--------------------------------

### acceptLabel property

Source: https://pub.dev/documentation/file_picker/latest/file_picker/LinuxOptions/acceptLabel.html

The acceptLabel property defines the text for the accept button in the file chooser dialog. It corresponds to the accept_label option in the XDG Desktop Portal FileChooser documentation.

```APIDOC
## acceptLabel

### Description
The label for the accept button of the file chooser dialog. This property maps to the `accept_label` option in the XDG Desktop Portal FileChooser documentation.

### Type
String?

### Implementation
```dart
final String? acceptLabel;
```
```

--------------------------------

### Accessing the uri property

Source: https://pub.dev/documentation/file_picker/latest/file_picker/PlatformFile/uri.html

The uri property returns a Uri object representing the file location.

```dart
Uri get uri;
```

--------------------------------

### Future<void> saveBytesToFile(Uint8List bytes, String path)

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerSaveUtils/saveBytesToFile.html

Saves the provided byte array to the specified file path. This operation is performed in a separate isolate to avoid blocking the main thread.

```APIDOC
## saveBytesToFile

### Description
Saves the given `bytes` to a file at the specified `path`.

### Signature
`Future<void> saveBytesToFile(Uint8List bytes, String path)`

### Parameters
- **bytes** (Uint8List) - The data to be written to the file.
- **path** (String) - The destination file path.

### Returns
- **Future<void>** - A future that completes when the file has been saved.
```

--------------------------------

### Future<Uint8List> readAsBytes()

Source: https://pub.dev/documentation/file_picker/latest/file_picker/PlatformFile/readAsBytes.html

Reads the bytes of the file as a single chunk. It is recommended to use readAsByteStream for large files to avoid memory issues.

```APIDOC
## Future<Uint8List> readAsBytes()

### Description
Reads the bytes of the file as a single chunk. Prefer using `readAsByteStream` when dealing with large files to optimize memory usage.

### Signature
`Future<Uint8List> readAsBytes()`

### Returns
- **Future<Uint8List>**: A future that completes with the file content as a list of unsigned 8-bit integers.
```

--------------------------------

### lockParentWindow

Source: https://pub.dev/documentation/file_picker/latest/file_picker/DesktopWindowOptions/lockParentWindow.html

A boolean property used to control the modal behavior of the parent window when the file picker is active.

```APIDOC
## lockParentWindow

### Description
Determines whether to lock the parent window modally when showing the file picker dialog.

### Type
bool

### Usage
final bool lockParentWindow;
```

--------------------------------

### IllegalCharacterInFileNameException(String message)

Source: https://pub.dev/documentation/file_picker/latest/file_picker/IllegalCharacterInFileNameException-class.html

Creates an instance of the IllegalCharacterInFileNameException class with a provided error message.

```APIDOC
## Constructor: IllegalCharacterInFileNameException(String message)

### Description
Creates an instance of IllegalCharacterInFileNameException. This exception is thrown when a file name contains characters that are not allowed for the underlying platform.

### Parameters
- **message** (String) - Required - The error message describing the exception.
```

--------------------------------

### String toString()

Source: https://pub.dev/documentation/file_picker/latest/file_picker/IllegalCharacterInFileNameException/toString.html

Returns a string representation of the IllegalCharacterInFileNameException, including the error message.

```APIDOC
## String toString()

### Description
Returns a string representation of this object. This method is typically used for debugging or logging to provide useful information about the exception.

### Signature
`String toString()`

### Returns
- **String**: A string formatted as 'IllegalCharacterInFileNameException: $message'.
```

--------------------------------

### IllegalCharacterInFileNameException Constructor Implementation

Source: https://pub.dev/documentation/file_picker/latest/file_picker/IllegalCharacterInFileNameException/IllegalCharacterInFileNameException.html

The constructor for IllegalCharacterInFileNameException, which takes a message string as an argument.

```dart
const IllegalCharacterInFileNameException(this.message);
```

--------------------------------

### clearTemporaryFiles

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker-class.html

Asks the underlying platform to remove any temporary files created by this plugin.

```APIDOC
## clearTemporaryFiles()

### Description
Asks the underlying platform to remove any temporary files created by this plugin.

### Returns
- **Future<void>**
```

--------------------------------

### saveBytesToFile

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePickerSaveUtils-class.html

Saves the provided byte data to a specified file path.

```APIDOC
## static Future<void> saveBytesToFile(Uint8List bytes, String path)

### Description
Saves the given `bytes` to a file at the specified `path`.

### Parameters
- **bytes** (Uint8List) - The byte data to be saved.
- **path** (String) - The destination file path.

### Returns
- **Future<void>** - A future that completes when the file has been saved.
```

--------------------------------

### Implementation of lockParentWindow

Source: https://pub.dev/documentation/file_picker/latest/file_picker/DesktopWindowOptions/lockParentWindow.html

The property is defined as a final boolean value.

```dart
final bool lockParentWindow;
```

--------------------------------

### Implementation of skipEntitlementsChecks

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker/skipEntitlementsChecks.html

The static method definition including the deprecation annotation.

```dart
@Deprecated(
  'Entitlements checks are handled automatically by file_picker_darwin.',
)
static Future<void> skipEntitlementsChecks() async {}
```

--------------------------------

### FileType Enum Values

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FileType.html

The FileType enum provides several constants to restrict or allow specific file types during selection.

```APIDOC
## FileType Enum

### Description
Defines the category of files to be selected by the file picker.

### Values
- **any**: Select any file.
- **media**: Select video and image files.
- **image**: Select image files.
- **video**: Select video files.
- **audio**: Select audio files.
- **custom**: Select files with specific extensions.
```

--------------------------------

### Accessing the message property

Source: https://pub.dev/documentation/file_picker/latest/file_picker/IllegalCharacterInFileNameException/message.html

The message property is a final string containing the error details.

```dart
final String message;
```

--------------------------------

### Implementation of toString for IllegalCharacterInFileNameException

Source: https://pub.dev/documentation/file_picker/latest/file_picker/IllegalCharacterInFileNameException/toString.html

Overrides the default toString method to return a formatted string containing the exception message.

```dart
@override
String toString() => 'IllegalCharacterInFileNameException: $message';
```

--------------------------------

### Future<void> skipEntitlementsChecks()

Source: https://pub.dev/documentation/file_picker/latest/file_picker/FilePicker/skipEntitlementsChecks.html

A static method used for legacy compatibility regarding entitlement checks. This method is deprecated and should no longer be used as entitlements are handled automatically.

```APIDOC
## skipEntitlementsChecks

### Description
Deprecated entitlement check helper for legacy compatibility. Entitlements checks are handled automatically by file_picker_darwin.

### Signature
`static Future<void> skipEntitlementsChecks()`
```
Tokens:
Raw