Stay organized with collections
Save and categorize content based on your preferences.
MutableKeyValueStore
interface MutableKeyValueStore : KeyValueStore
An interface to a read-write key-value store. Used as a Data Access Object for the LOCAL_DATA table.
Summary
| Public methods |
| abstract ByteArray? |
Associates the specified value with the specified key.
|
| abstract ByteArray? |
Removes the mapping for the specified key.
|
| Inherited functions |
From class KeyValueStore
ByteArray? |
get(key: String)
Looks up a key in a read-only store.
This method may take several seconds to complete, so it should only be called from a worker thread.
|
MutableSet<String!> |
keySet()
Returns a Set view of the keys contained in the REMOTE_DATA table.
This method may take several seconds to complete, so it should only be called from a worker thread.
|
|
Public methods
put
abstract fun put(
key: String,
value: ByteArray
): ByteArray?
Associates the specified value with the specified key. If a value already exists for that key, the old value is replaced.
This method may take several seconds to complete, so it should only be called from a worker thread.
| Parameters |
key |
String: key with which the specified value is to be associated This value cannot be null. |
value |
ByteArray: value to be associated with the specified key This value cannot be null. |
| Return |
ByteArray? |
the previous value associated with key, or null if there was no mapping for key. |
remove
abstract fun remove(key: String): ByteArray?
Removes the mapping for the specified key.
This method may take several seconds to complete, so it should only be called from a worker thread.
| Parameters |
key |
String: key whose mapping is to be removed This value cannot be null. |
| Return |
ByteArray? |
the previous value associated with key, or null if there was no mapping for key. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# MutableKeyValueStore\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nMutableKeyValueStore\n====================\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/adservices/ondevicepersonalization/MutableKeyValueStore \"View this page in Java\") \n\n```\ninterface MutableKeyValueStore : KeyValueStore\n```\n\n|----------------------------------------------------------------------|\n| [android.adservices.ondevicepersonalization.MutableKeyValueStore](#) |\n\nAn interface to a read-write key-value store. Used as a Data Access Object for the LOCAL_DATA table.\n\nSummary\n-------\n\n| Public methods ||\n|---------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)? | [put](#put(kotlin.String,%20kotlin.ByteArray))`(`key:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, `value:` `[ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)`)` Associates the specified value with the specified key. |\n| abstract [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)? | [remove](#remove(kotlin.String))`(`key:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` Removes the mapping for the specified key. |\n\n| Inherited functions ||\n|---|---|\n| From class [KeyValueStore](/reference/kotlin/android/adservices/ondevicepersonalization/KeyValueStore) |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)? | [get](/reference/kotlin/android/adservices/ondevicepersonalization/KeyValueStore#get(kotlin.String))`(`key:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`)` Looks up a key in a read-only store. This method may take several seconds to complete, so it should only be called from a worker thread. \u003cbr /\u003e | | [MutableSet](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-set/index.html)\u003c[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!\u003e | [keySet](/reference/kotlin/android/adservices/ondevicepersonalization/KeyValueStore#keySet())`()` Returns a Set view of the keys contained in the REMOTE_DATA table. This method may take several seconds to complete, so it should only be called from a worker thread. \u003cbr /\u003e | ||\n\nPublic methods\n--------------\n\n### put\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun put(\n key: String, \n value: ByteArray\n): ByteArray?\n```\n\nAssociates the specified value with the specified key. If a value already exists for that key, the old value is replaced. \nThis method may take several seconds to complete, so it should only be called from a worker thread.\n\n| Parameters ||\n|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `key` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html): key with which the specified value is to be associated This value cannot be `null`. |\n| `value` | [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html): value to be associated with the specified key This value cannot be `null`. |\n\n| Return ||\n|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|\n| [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)? | the previous value associated with key, or null if there was no mapping for key. |\n\n### remove\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun remove(key: String): ByteArray?\n```\n\nRemoves the mapping for the specified key. \nThis method may take several seconds to complete, so it should only be called from a worker thread.\n\n| Parameters ||\n|-------|---------------------------------------------------------------------------------------------------------------------------------------------------|\n| `key` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html): key whose mapping is to be removed This value cannot be `null`. |\n\n| Return ||\n|------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|\n| [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)? | the previous value associated with key, or null if there was no mapping for key. |"]]
