Skip to content

Commit a356f16

Browse files
authored
feat: adds a SharedPreferencesMigration example (preferences) (#761)
* feat: adds android_datastore_preferences_migrate snippet * addresses reviewer comments * undo changes to PreferencesDataStore.kt * Apply Spotless --------- Co-authored-by: telpirion <7399197+telpirion@users.noreply.github.com>
1 parent 112aa76 commit a356f16

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/*
2+
* Copyright 2026 The Android Open Source Project
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.example.datastore.snippets.sharedprefsmigration
18+
19+
import android.content.Context
20+
import androidx.datastore.preferences.SharedPreferencesMigration
21+
import androidx.datastore.preferences.preferencesDataStore
22+
23+
// [START android_datastore_preferences_migrate]
24+
// Be sure to pass the original SharedPreferences name when creating the migration.
25+
private const val SETTINGS_NAME = "settings"
26+
27+
private val Context.dataStore by preferencesDataStore(
28+
name = SETTINGS_NAME,
29+
produceMigrations = { context ->
30+
listOf(SharedPreferencesMigration(context, SETTINGS_NAME))
31+
}
32+
)
33+
// [END android_datastore_preferences_migrate]

0 commit comments

Comments
 (0)