Stay organized with collections
Save and categorize content based on your preferences.
KeyValueStore
interface KeyValueStore
An interface to a read-only key-value store. Used as a Data Access Object for the REMOTE_DATA table.
Summary
| Public methods |
| abstract ByteArray? |
Looks up a key in a read-only store.
|
| abstract MutableSet<String!> |
Returns a Set view of the keys contained in the REMOTE_DATA table.
|
Public methods
get
abstract fun get(key: String): ByteArray?
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.
| Parameters |
key |
String: The key to look up. This value cannot be null. |
| Return |
ByteArray? |
the value to which the specified key is mapped, or null if there contains no mapping for the key. |
keySet
abstract fun keySet(): MutableSet<String!>
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# KeyValueStore\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nKeyValueStore\n=============\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/android/adservices/ondevicepersonalization/KeyValueStore \"View this page in Java\") \n\n```\ninterface KeyValueStore\n```\n\n|---------------------------------------------------------------|\n| [android.adservices.ondevicepersonalization.KeyValueStore](#) |\n\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Known Direct Subclasses [MutableKeyValueStore](/reference/kotlin/android/adservices/ondevicepersonalization/MutableKeyValueStore) |-----------------------------------------------------------------------------------------------------------|-----------------------------------------------| | [MutableKeyValueStore](/reference/kotlin/android/adservices/ondevicepersonalization/MutableKeyValueStore) | An interface to a read-write key-value store. | |\n\nAn interface to a read-only key-value store. Used as a Data Access Object for the REMOTE_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)? | [get](#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. |\n| abstract [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](#keySet())`()` Returns a Set view of the keys contained in the REMOTE_DATA table. |\n\nPublic methods\n--------------\n\n### get\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun get(key: String): ByteArray?\n```\n\nLooks up a key in a read-only store. \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): The key to look up. This value cannot be `null`. |\n\n| Return ||\n|------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------|\n| [ByteArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html)? | the value to which the specified key is mapped, or null if there contains no mapping for the key. |\n\n### keySet\n\nAdded in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun keySet(): MutableSet\u003cString!\u003e\n```\n\nReturns a Set view of the keys contained in the REMOTE_DATA table. \nThis method may take several seconds to complete, so it should only be called from a worker thread.\n\n| Return ||\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|\n| [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 | This value cannot be `null`. |"]]
