[shared_preferences] Adds Shared preferences as option in shared preferences async android

packages/shared_preferences/shared_preferences/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.3.4
+
+* Adds information about Android SharedPreferences support.
+
 ## 2.3.3
 
 * Clarifies scope of prefix handling in README.

packages/shared_preferences/shared_preferences/README.md

@@ -50,9 +50,22 @@ latest data stored on the native platform regardless of what process was used to
 
 ### Android platform storage
 
-The [SharedPreferences] API uses the native [Android Shared Preferences](https://developer.android.com/reference/android/content/SharedPreferences) tool to store data.
+The [SharedPreferencesAsync] and [SharedPreferencesWithCache] APIs can use [DataStore Preferences](https://developer.android.com/topic/libraries/architecture/datastore) or [Android SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences) to store data.
+In most cases you should use the default option of DataStore Preferences, as it is the platform-recommended preferences storage system. 
+However, in some cases you may need to interact with preferences that were written to SharedPreferences by code you don't control.
 
-The [SharedPreferencesAsync] and [SharedPreferencesWithCache] APIs use [DataStore Preferences](https://developer.android.com/topic/libraries/architecture/datastore) to store data.
+To use the `Android SharedPreferences` backend, use the `SharedPreferencesAsyncAndroidOptions` when using [SharedPreferencesAsync] on Android.
+
+<?code-excerpt "readme_excerpts.dart (Android_Options)"?>
+```dart
+const SharedPreferencesAsyncAndroidOptions options =
+    SharedPreferencesAsyncAndroidOptions(
+        backend: SharedPreferencesAndroidBackendLibrary.SharedPreferences,
+        originalSharedPreferencesOptions:
+            AndroidSharedPreferencesStoreOptions(fileName: 'the_name_of_a_file'));
+```
+
+The [SharedPreferences] API uses the native [Android SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences) tool to store data.
 
 ## Examples
 Here are small examples that show you how to use the API.
@@ -187,7 +200,7 @@ the new prefix otherwise the old preferences will be inaccessible.
 
 | Platform | SharedPreferences | SharedPreferencesAsync/WithCache |
 | :--- | :--- | :--- |
-| Android | SharedPreferences | DataStore Preferences |
+| Android | SharedPreferences | DataStore Preferences or SharedPreferences |
 | iOS | NSUserDefaults | NSUserDefaults |
 | Linux | In the XDG_DATA_HOME directory | In the XDG_DATA_HOME directory |
 | macOS | NSUserDefaults | NSUserDefaults |

packages/shared_preferences/shared_preferences/example/lib/readme_excerpts.dart

@@ -4,6 +4,7 @@
 
 // ignore_for_file: public_member_api_docs, unused_local_variable, invalid_use_of_visible_for_testing_member
 import 'package:shared_preferences/shared_preferences.dart';
+import 'package:shared_preferences_android/shared_preferences_android.dart';
 
 Future<void> readmeSnippets() async {
   // #docregion Write
@@ -92,3 +93,11 @@ Future<void> readmeTestSnippets() async {
   SharedPreferences.setMockInitialValues(values);
   // #enddocregion Tests
 }
+
+// #docregion Android_Options
+const SharedPreferencesAsyncAndroidOptions options =
+    SharedPreferencesAsyncAndroidOptions(
+        backend: SharedPreferencesAndroidBackendLibrary.SharedPreferences,
+        originalSharedPreferencesOptions: AndroidSharedPreferencesStoreOptions(
+            fileName: 'the_name_of_a_file'));
+// #enddocregion Android_Options

packages/shared_preferences/shared_preferences/example/pubspec.yaml

@@ -16,6 +16,7 @@ dependencies:
     # The example app is bundled with the plugin so we use a path dependency on
     # the parent directory to use the current plugin's version.
     path: ../
+  shared_preferences_android: ^2.4.0
   shared_preferences_platform_interface: ^2.4.0
 
 dev_dependencies:
@@ -27,3 +28,8 @@ dev_dependencies:
 
 flutter:
   uses-material-design: true
+
+# FOR TESTING AND INITIAL REVIEW ONLY. DO NOT MERGE.
+# See https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changing-federated-plugins
+dependency_overrides:
+   {shared_preferences_android: {path: ../../../../packages/shared_preferences/shared_preferences_android}}

packages/shared_preferences/shared_preferences/pubspec.yaml

@@ -3,7 +3,7 @@ description: Flutter plugin for reading and writing simple key-value pairs.
   Wraps NSUserDefaults on iOS and SharedPreferences on Android.
 repository: https://github.com/flutter/packages/tree/main/packages/shared_preferences/shared_preferences
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+shared_preferences%22
-version: 2.3.3
+version: 2.3.4
 
 environment:
   sdk: ^3.4.0

packages/shared_preferences/shared_preferences_android/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.4.0
+
+* Adds `SharedPreferences` support within `SharedPreferencesAsyncAndroid` API.
+
 ## 2.3.4
 
 * Restrict types when decoding preferences.

packages/shared_preferences/shared_preferences_android/README.md

@@ -11,5 +11,22 @@ so you do not need to add it to your `pubspec.yaml`.
 However, if you `import` this package to use any of its APIs directly, you
 should add it to your `pubspec.yaml` as usual.
 
+## Options
+
+The [SharedPreferencesAsync] and [SharedPreferencesWithCache] APIs can use [DataStore Preferences](https://developer.android.com/topic/libraries/architecture/datastore) or [Android SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences) to store data.
+
+To use the `Android SharedPreferences` backend, use the `SharedPreferencesAsyncAndroidOptions` when using [SharedPreferencesAsync].
+
+<?code-excerpt "readme_excerpts.dart (Android_Options)"?>
+```dart
+const SharedPreferencesAsyncAndroidOptions options =
+    SharedPreferencesAsyncAndroidOptions(
+        backend: SharedPreferencesAndroidBackendLibrary.SharedPreferences,
+        originalSharedPreferencesOptions:
+            AndroidSharedPreferencesStoreOptions(fileName: 'the_name_of_a_file'));
+```
+
+The [SharedPreferences] API uses the native [Android SharedPreferences](https://developer.android.com/reference/android/content/SharedPreferences) tool to store data.
+
 [1]: https://pub.dev/packages/shared_preferences
 [2]: https://flutter.dev/to/endorsed-federated-plugin

packages/shared_preferences/shared_preferences_android/android/build.gradle

@@ -60,7 +60,8 @@ android {
     }
     dependencies {
         implementation 'androidx.datastore:datastore:1.0.0'
-        implementation 'androidx.datastore:datastore-preferences:1.0.0'    
+        implementation 'androidx.datastore:datastore-preferences:1.0.0'
+        implementation 'androidx.preference:preference:1.2.1'
         testImplementation 'junit:junit:4.13.2'
         testImplementation 'androidx.test:core-ktx:1.5.0'
         testImplementation 'androidx.test.ext:junit-ktx:1.2.1'