PathProviderPlatform class Null safety

The interface that implementations of path_provider must implement.

Platform implementations should extend this class rather than implement it as PathProvider 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 PathProviderPlatform methods.

Inheritance

Constructors

PathProviderPlatform()
Constructs a PathProviderPlatform.

Properties

hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

getApplicationDocumentsPath() Future<String?>
Path to a directory where the application may place data that is user-generated, or that cannot otherwise be recreated by your application.
getApplicationSupportPath() Future<String?>
Path to a directory where the application may place application support files.
getDownloadsPath() Future<String?>
Path to the directory where downloaded files can be stored. This is typically only relevant on desktop operating systems.
getExternalCachePaths() Future<List<String>?>
Paths to directories where application specific external cache data can be stored. These paths typically reside on external storage like separate partitions or SD cards. Phones may have multiple storage directories available.
getExternalStoragePath() Future<String?>
Path to a directory where the application may access top level storage. The current operating system should be determined before issuing this function call, as this functionality is only available on Android.
getExternalStoragePaths({StorageDirectory? type}) Future<List<String>?>
Paths to directories where application specific data can be stored. These paths typically reside on external storage like separate partitions or SD cards. Phones may have multiple storage directories available.
getLibraryPath() Future<String?>
Path to the directory where application can store files that are persistent, backed up, and not visible to the user, such as sqlite.db.
getTemporaryPath() Future<String?>
Path to the temporary directory on the device that is not backed up and is suitable for storing caches of downloaded files.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() String
A string representation of this object. [...]
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited

Static Properties

instance PathProviderPlatform
The default instance of PathProviderPlatform to use. [...]
read / write