path_provider

https://pub.dev/documentation/path_provider/latest/
Admin
A Flutter plugin for finding commonly used filesystem locations across Android, iOS, Linux, macOS,...
Tokens:6,198
Snippets:69
Trust Score:9.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### getApplicationSupportDirectory()

Source: https://pub.dev/documentation/path_provider/latest/path_provider

Function to get the application support directory.

```APIDOC
## getApplicationSupportDirectory()

### Description
Returns a Future that resolves to a Directory where the application may place application support files.

### Method
Function

### Signature
Future<Directory> getApplicationSupportDirectory()

### Returns
- **Future<Directory>** - A Future that resolves to the application support directory.
```

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

### Get temporary, documents, and downloads directories

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

Use getTemporaryDirectory(), getApplicationDocumentsDirectory(), and getDownloadsDirectory() to retrieve common filesystem paths. Note that getDownloadsDirectory() returns a nullable Directory.

```dart
final Directory tempDir = await getTemporaryDirectory();

final Directory appDocumentsDir = await getApplicationDocumentsDirectory();

final Directory? downloadsDir = await getDownloadsDirectory();

```

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

### getLibraryDirectory()

Source: https://pub.dev/documentation/path_provider/latest/path_provider

Function to get the library directory.

```APIDOC
## getLibraryDirectory()

### Description
Returns a Future that resolves to a Directory where the application can store files that are persistent, backed up, and not visible to the user, such as sqlite.db.

### Method
Function

### Signature
Future<Directory> getLibraryDirectory()

### Returns
- **Future<Directory>** - A Future that resolves to the library directory.
```

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

### getApplicationDocumentsDirectory()

Source: https://pub.dev/documentation/path_provider/latest/path_provider

Function to get the application documents directory.

```APIDOC
## getApplicationDocumentsDirectory()

### Description
Returns a Future that resolves to a Directory where the application may place data that is user-generated, or that cannot otherwise be recreated by your application.

### Method
Function

### Signature
Future<Directory> getApplicationDocumentsDirectory()

### Returns
- **Future<Directory>** - A Future that resolves to the application documents directory.
```

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

### getTemporaryDirectory()

Source: https://pub.dev/documentation/path_provider/latest/path_provider

Function to get the temporary directory.

```APIDOC
## getTemporaryDirectory()

### Description
Returns a Future that resolves to a Directory representing the temporary directory on the device that is not backed up and is suitable for storing caches of downloaded files.

### Method
Function

### Signature
Future<Directory> getTemporaryDirectory()

### Returns
- **Future<Directory>** - A Future that resolves to the temporary directory.
```

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

### getExternalStorageDirectory()

Source: https://pub.dev/documentation/path_provider/latest/path_provider

Function to get the external storage directory.

```APIDOC
## getExternalStorageDirectory()

### Description
Returns a Future that resolves to a Directory where the application may access top level storage.

### Method
Function

### Signature
Future<Directory?> getExternalStorageDirectory()

### Returns
- **Future<Directory?>** - A Future that resolves to the external storage directory, or null if not available.
```

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

### getExternalStorageDirectories implementation

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getExternalStorageDirectories.html

The implementation of getExternalStorageDirectories, which calls the platform-specific method to get external storage paths and maps them to Directory objects. It returns null if no paths are available.

```dart
Future<List<Directory>?> getExternalStorageDirectories({
  /// Optional parameter. See [StorageDirectory] for more informations on
  /// how this type translates to Android storage directories.
  StorageDirectory? type,
}) async {
  final List<String>? paths = await _platform.getExternalStoragePaths(type: type);
  if (paths == null) {
    return null;
  }

  return paths.map((String path) => Directory(path)).toList();
}
```

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

### getApplicationSupportDirectory()

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getApplicationSupportDirectory.html

Returns a Future<Directory> for the application support directory. The directory is created automatically if it does not exist. Throws MissingPlatformDirectoryException if the system cannot provide the directory.

```APIDOC
## getApplicationSupportDirectory()

### Description
Returns a Future<Directory> for the application support directory. The directory is created automatically if it does not exist. Throws MissingPlatformDirectoryException if the system cannot provide the directory.

### Method
Function

### Signature
Future<Directory> getApplicationSupportDirectory()

### Return Value
- **Future<Directory>** - A Future that resolves to a Directory object representing the application support directory.

### Exceptions
- **MissingPlatformDirectoryException** - Thrown if the system is unable to provide the directory.

### Implementation
```dart
Future<Directory> getApplicationSupportDirectory() async {
  final String? path = await _platform.getApplicationSupportPath();
  if (path == null) {
    throw MissingPlatformDirectoryException('Unable to get application support directory');
  }

  return Directory(path);
}
```
```

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

### getApplicationSupportDirectory implementation

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getApplicationSupportDirectory.html

Returns a Future<Directory> for the application support directory. Throws MissingPlatformDirectoryException if the platform returns null. The directory is created automatically if it doesn't exist.

```dart
Future<Directory> getApplicationSupportDirectory() async {
  final String? path = await _platform.getApplicationSupportPath();
  if (path == null) {
    throw MissingPlatformDirectoryException('Unable to get application support directory');
  }

  return Directory(path);
}
```

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

### MissingPlatformDirectoryException class

Source: https://pub.dev/documentation/path_provider/latest/path_provider/MissingPlatformDirectoryException-class.html

This section documents the MissingPlatformDirectoryException class, including its constructor, properties, methods, and operators.

```APIDOC
## MissingPlatformDirectoryException()

### Description
Creates a new exception instance with the given message and optional details.

### Constructor
MissingPlatformDirectoryException(String message, {Object? details})

### Parameters
- **message** (String) - Required - The explanation of the exception.
- **details** (Object?) - Optional - Added details, if any.

### Properties
- **message** → String - The explanation of the exception (final).
- **details** → Object? - Added details, if any (final).

### Inherited Properties
- **hashCode** → int - The hash code for this object.
- **runtimeType** → Type - A representation of the runtime type of the object.

### Methods
- **toString()** → String - A string representation of this object.

### Inherited Methods
- **noSuchMethod(Invocation invocation)** → dynamic - Invoked when a nonexistent method or property is accessed.

### Operators
- **operator ==(Object other)** → bool - The equality operator.
```

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

### getApplicationCacheDirectory()

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getApplicationCacheDirectory.html

Documentation for the getApplicationCacheDirectory function, which returns the application's cache directory path.

```APIDOC
## getApplicationCacheDirectory()

### Description
Returns a Future that resolves to a Directory object representing the application's cache directory. The directory is created automatically if it does not exist. Throws a MissingPlatformDirectoryException if the system is unable to provide the directory.

### Method
Future<Directory> getApplicationCacheDirectory()

### Returns
- **Future<Directory>** - A future that resolves to a Directory object for the application's cache directory.

### Exceptions
- **MissingPlatformDirectoryException** - Thrown if the system is unable to provide the directory.

### Implementation Code
```dart
Future<Directory> getApplicationCacheDirectory() async {
  final String? path = await _platform.getApplicationCachePath();
  if (path == null) {
    throw MissingPlatformDirectoryException('Unable to get application cache directory');
  }
  return Directory(path);
}
```
```

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

### getLibraryDirectory implementation

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getLibraryDirectory.html

Implementation of getLibraryDirectory that calls the platform's getLibraryPath and throws MissingPlatformDirectoryException if the path is null. Use this to obtain a directory for persistent, backed-up files not visible to the user.

```dart
Future<Directory> getLibraryDirectory() async {
  final String? path = await _platform.getLibraryPath();
  if (path == null) {
    throw MissingPlatformDirectoryException('Unable to get library directory');
  }
  return Directory(path);
}
```

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

### getDownloadsDirectory()

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getDownloadsDirectory.html

Documentation for the getDownloadsDirectory function from the path_provider package.

```APIDOC
## getDownloadsDirectory()

### Description
Returns the path to the directory where downloaded files can be stored. The returned directory is not guaranteed to exist, so clients should verify that it does before using it, and potentially create it if necessary.

### Method
Function

### Signature
`Future<Directory?> getDownloadsDirectory()`

### Parameters
None

### Return Value
- **Future<Directory?>** - A Future that resolves to a Directory object representing the downloads directory, or `null` if the platform supports the concept but no such directory is currently available.

### Exceptions
- **UnsupportedError** - Thrown when the current platform has no concept of a downloads directory at all.

### Implementation
```dart
Future<Directory?> getDownloadsDirectory() async {
  final String? path = await _platform.getDownloadsPath();
  if (path == null) {
    return null;
  }
  return Directory(path);
}
```
```

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

### getDownloadsDirectory implementation

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getDownloadsDirectory.html

The implementation of getDownloadsDirectory, which calls the platform's getDownloadsPath and returns a Directory if the path is non-null, otherwise null.

```dart
Future<Directory?> getDownloadsDirectory() async {
  final String? path = await _platform.getDownloadsPath();
  if (path == null) {
    return null;
  }
  return Directory(path);
}
```

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

### getApplicationDocumentsDirectory implementation

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getApplicationDocumentsDirectory.html

Returns a Future<Directory> to the application documents directory. Throws MissingPlatformDirectoryException if the platform cannot provide the path.

```dart
Future<Directory> getApplicationDocumentsDirectory() async {
  final String? path = await _platform.getApplicationDocumentsPath();
  if (path == null) {
    throw MissingPlatformDirectoryException('Unable to get application documents directory');
  }
  return Directory(path);
}
```

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

### getApplicationCacheDirectory implementation

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getApplicationCacheDirectory.html

Returns a Future that resolves to a Directory for application-specific cache files. The directory is created automatically if it does not exist. Throws MissingPlatformDirectoryException if the system cannot provide the directory.

```dart
Future<Directory> getApplicationCacheDirectory() async {
  final String? path = await _platform.getApplicationCachePath();
  if (path == null) {
    throw MissingPlatformDirectoryException('Unable to get application cache directory');
  }
  return Directory(path);
}
```

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

### getTemporaryDirectory implementation

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getTemporaryDirectory.html

The implementation of getTemporaryDirectory as shown in the source. It calls _platform.getTemporaryPath() and throws MissingPlatformDirectoryException if the path is null.

```dart
Future<Directory> getTemporaryDirectory() async {
  final String? path = await _platform.getTemporaryPath();
  if (path == null) {
    throw MissingPlatformDirectoryException('Unable to get temporary directory');
  }
  return Directory(path);
}
```

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

### getExternalCacheDirectories()

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getExternalCacheDirectories.html

Returns a Future<List<Directory>?> containing paths to directories where application-specific cache data can be stored externally. These paths typically reside on external storage like separate partitions or SD cards. Throws an UnsupportedError if not supported on the current platform.

```APIDOC
## getExternalCacheDirectories()

### Description
Returns a Future that resolves to a list of Directory objects representing paths to directories where application-specific cache data can be stored externally. These paths typically reside on external storage like separate partitions or SD cards. Throws an UnsupportedError if not supported on the current platform.

### Method
Function

### Signature
Future<List<Directory>?> getExternalCacheDirectories()

### Parameters
None

### Return Value
- **Future<List<Directory>?>** - A Future that resolves to a list of Directory objects, or null if no external cache directories are available.

### Exceptions
- **UnsupportedError** - Thrown if this function is not supported on the current platform. This is unlikely to be supported on any platform other than Android.

### Implementation Example
```dart
Future<List<Directory>?> getExternalCacheDirectories() async {
  final List<String>? paths = await _platform.getExternalCachePaths();
  if (paths == null) {
    return null;
  }

  return paths.map((String path) => Directory(path)).toList();
}
```
```

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

### getTemporaryDirectory()

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getTemporaryDirectory.html

Returns a Future<Directory> that resolves to the temporary directory path on the device. The directory is not backed up and is suitable for storing caches of downloaded files. Files in this directory may be cleared at any time. The caller is responsible for creating and cleaning up files or directories within this directory. Throws a MissingPlatformDirectoryException if the system is unable to provide the directory.

```APIDOC
## getTemporaryDirectory()

### Description
Returns a Future<Directory> that resolves to the temporary directory path on the device. The directory is not backed up and is suitable for storing caches of downloaded files. Files in this directory may be cleared at any time. The caller is responsible for creating and cleaning up files or directories within this directory. Throws a MissingPlatformDirectoryException if the system is unable to provide the directory.

### Method
Future<Directory> getTemporaryDirectory()

### Return Value
- **Future<Directory>** - A Future that resolves to a Directory object representing the temporary directory.

### Exceptions
- **MissingPlatformDirectoryException** - Thrown if the system is unable to provide the directory.

### Platform Implementations
- **iOS/macOS**: Uses `NSCachesDirectory`.
- **Android**: Uses `Context.getCacheDir`.

### Implementation
```dart
Future<Directory> getTemporaryDirectory() async {
  final String? path = await _platform.getTemporaryPath();
  if (path == null) {
    throw MissingPlatformDirectoryException('Unable to get temporary directory');
  }
  return Directory(path);
}
```
```

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

### getApplicationDocumentsDirectory()

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getApplicationDocumentsDirectory.html

Returns a Future<Directory> for the application's documents directory. This directory is intended for user-generated data or data that cannot be recreated. Throws MissingPlatformDirectoryException if the system cannot provide the directory.

```APIDOC
## getApplicationDocumentsDirectory()

### Description
Returns a Future<Directory> for the application's documents directory. This directory is intended for user-generated data or data that cannot be recreated by the application. Throws MissingPlatformDirectoryException if the system cannot provide the directory.

### Method
Function

### Signature
Future<Directory> getApplicationDocumentsDirectory()

### Returns
- **Future<Directory>** - A Future that resolves to a Directory object representing the application's documents directory.

### Exceptions
- **MissingPlatformDirectoryException** - Thrown if the system is unable to provide the directory.

### Implementation
```dart
Future<Directory> getApplicationDocumentsDirectory() async {
  final String? path = await _platform.getApplicationDocumentsPath();
  if (path == null) {
    throw MissingPlatformDirectoryException('Unable to get application documents directory');
  }
  return Directory(path);
}
```
```

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

### set disablePathProviderPlatformOverride(bool override)

Source: https://pub.dev/documentation/path_provider/latest/path_provider/disablePathProviderPlatformOverride.html

A deprecated setter that was previously used to disable platform overrides in path_provider. It is now a no-op and should not be used.

```APIDOC
## set disablePathProviderPlatformOverride(bool override)

### Description
Deprecated setter that is now a no-op. Previously used to disable platform overrides in path_provider.

### Method
set

### Signature
set disablePathProviderPlatformOverride(bool override)

### Parameters
- **override** (bool) - Required - The value to set (ignored).

### Implementation
```dart
@visibleForTesting
@Deprecated('This is no longer necessary, and is now a no-op')
set disablePathProviderPlatformOverride(bool override) {}
```

### Deprecation
This property is deprecated and is now a no-op.
```

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

### getExternalCacheDirectories() implementation

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getExternalCacheDirectories.html

Implementation of getExternalCacheDirectories() that calls the platform's getExternalCachePaths() method and maps the resulting paths to Directory objects. Returns null if the platform returns null.

```dart
Future<List<Directory>?> getExternalCacheDirectories() async {
  final List<String>? paths = await _platform.getExternalCachePaths();
  if (paths == null) {
    return null;
  }

  return paths.map((String path) => Directory(path)).toList();
}
```

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

### getExternalStorageDirectory()

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getExternalStorageDirectory.html

Returns a Future<Directory?> that resolves to the top-level storage directory accessible by the application. Throws UnsupportedError on platforms where this is not supported, such as iOS.

```APIDOC
## getExternalStorageDirectory()

### Description
Returns a Future<Directory?> that resolves to the top-level storage directory accessible by the application. Throws UnsupportedError on platforms where this is not supported, such as iOS.

### Method
Future<Directory?> getExternalStorageDirectory()

### Parameters
None.

### Return Value
- **Future<Directory?>** - A Future that resolves to a Directory object representing the external storage directory, or null if not available.

### Exceptions
- **UnsupportedError** - Thrown if the platform does not support external storage access (e.g., iOS).

### Example Implementation
```dart
Future<Directory?> getExternalStorageDirectory() async {
  final String? path = await _platform.getExternalStoragePath();
  if (path == null) {
    return null;
  }
  return Directory(path);
}
```
```

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

### getExternalStorageDirectory implementation

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getExternalStorageDirectory.html

The actual implementation of the getExternalStorageDirectory function. It calls the platform-specific getExternalStoragePath method and returns a Directory if the path is not null, otherwise null.

```dart
Future<Directory?> getExternalStorageDirectory() async {
  final String? path = await _platform.getExternalStoragePath();
  if (path == null) {
    return null;
  }
  return Directory(path);
}
```

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

### getExternalStorageDirectories

Source: https://pub.dev/documentation/path_provider/latest/path_provider/getExternalStorageDirectories.html

Documentation for the getExternalStorageDirectories function, which retrieves external storage directories on Android.

```APIDOC
## getExternalStorageDirectories

### Description
Returns a list of directories where application-specific data can be stored externally. These paths typically reside on external storage like separate partitions or SD cards. Phones may have multiple storage directories available.

### Method
Function

### Signature
```dart
Future<List<Directory>?> getExternalStorageDirectories({
  StorageDirectory? type,
})
```

### Parameters
- **type** (StorageDirectory?) - Optional - Specifies the type of storage directory to retrieve. See [StorageDirectory] for more information on how this type translates to Android storage directories.

### Return Value
- **Future<List<Directory>?>** - A future that resolves to a list of directories where application-specific data can be stored externally, or null if no such directories are available.

### Exceptions
- **UnsupportedError** - Thrown if this is not supported on the current platform. This is unlikely to ever be supported on any platform other than Android.

### Implementation
```dart
Future<List<Directory>?> getExternalStorageDirectories({
  StorageDirectory? type,
}) async {
  final List<String>? paths = await _platform.getExternalStoragePaths(type: type);
  if (paths == null) {
    return null;
  }

  return paths.map((String path) => Directory(path)).toList();
}
```
```
Tokens:
Raw