diff --git a/docs/Migrate notes/From v0.2.0.md b/docs/Migrate notes/Migrate to v0.3.0.md similarity index 96% rename from docs/Migrate notes/From v0.2.0.md rename to docs/Migrate notes/Migrate to v0.3.0.md index 87477f4..8bf6e3a 100644 --- a/docs/Migrate notes/From v0.2.0.md +++ b/docs/Migrate notes/Migrate to v0.3.0.md @@ -7,7 +7,7 @@ dependencies: shared_storage: v0.3.0 ``` -## SDK Constraint +## SDK constraint In `android\app\build.gradle` set `android.defaultConfig.minSdkVersion` to `19`: @@ -22,7 +22,7 @@ android { } ``` -## Plugin Import +## Plugin import Although this import is still supported: diff --git a/docs/Migrate notes/Migrate to v0.5.0.md b/docs/Migrate notes/Migrate to v0.5.0.md new file mode 100644 index 0000000..afd0e64 --- /dev/null +++ b/docs/Migrate notes/Migrate to v0.5.0.md @@ -0,0 +1,40 @@ +There's major breaking changes when updating to `v0.5.0`, be careful. + +Update your `pubspec.yaml`: + +```yaml +dependencies: + shared_storage: ^0.5.0 +``` + +## Return type of `listFiles` + +Instead of: + +```dart +Stream fileStream = listFiles(uri); +``` + +use: + +```dart +Stream fileStream = listFiles(uri); +``` + +And when reading data from each file: + +```dart +// Old. +PartialDocumentFile file = ... + +String displayName = file.data![DocumentFileColumn.displayName] as String; +DateTime lastModified = DateTime.fromMillisecondsSinceEpoch(file.data![DocumentFileColumn.lastModified] as int); + +// New. +DocumentFile file = ... + +String displayName = file.name; +DateTime lastModified = file.lastModified; +``` + +It now parses all fields as class fields instead `Map` hash map. diff --git a/docs/Usage/Storage Access Framework.md b/docs/Usage/Storage Access Framework.md index 506cbb7..f8d882b 100644 --- a/docs/Usage/Storage Access Framework.md +++ b/docs/Usage/Storage Access Framework.md @@ -89,9 +89,9 @@ const List columns = [ DocumentFileColumn.mimeType, ]; -final List files = []; +final List files = []; -final Stream onNewFileLoaded = documentFileOfMyGrantedUri.listFiles(columns); +final Stream onNewFileLoaded = documentFileOfMyGrantedUri.listFiles(columns); onNewFileLoaded.listen((file) => files.add(file), onDone: () => print('All files were loaded')); ``` @@ -299,7 +299,7 @@ Returns the image thumbnail of a given `uri`, if any (e.g documents that can sho ```dart final Uint8List? imageBytes; -final PartialDocumentFile file = ... +final DocumentFile file = ... final Uri? rootUri = file.metadata?.rootUri; final String? documentId = file.data?[DocumentFileColumn.id] as String?; @@ -345,7 +345,7 @@ const List columns = [ DocumentFileColumn.mimeType, ]; -final Stream onNewFileLoaded = documentFileOfMyGrantedUri.listFiles(columns); +final Stream onNewFileLoaded = documentFileOfMyGrantedUri.listFiles(columns); ``` ### delete @@ -645,7 +645,7 @@ This class is not intended to be instantiated, and it is only used for typing an ### QueryMetadata -This class wraps useful metadata of the source queries returned by the `PartialDocumentFile`. +This class wraps useful metadata of the source queries returned by the `DocumentFile`. This class is not intended to be instantiated, and it is only used for typing and convenience purposes. diff --git a/lib/src/saf/saf.dart b/lib/src/saf/saf.dart index 5532021..7357c21 100644 --- a/lib/src/saf/saf.dart +++ b/lib/src/saf/saf.dart @@ -129,7 +129,7 @@ Future getDocumentThumbnail({ /// ```dart /// /// Usage: /// -/// final myState = []; +/// final myState = []; /// /// final onDocumentFile = listFiles(myUri, [DocumentFileColumn.id]); ///