Added in API level 35

MutableKeyValueStore


public interface MutableKeyValueStore
implements KeyValueStore

android.adservices.ondevicepersonalization.MutableKeyValueStore


This interface is deprecated.
The ODP APIs are deprecated and will not be supported in future Android releases. There is no direct replacement API available. Developers currently integrated with these APIs must cease further integration efforts. For comprehensive details regarding this deprecation and the future roadmap of Privacy Sandbox on Android, please consult the official Privacy Sandbox developer documentation and announcements: https://privacysandbox.google.com

An interface to a read-write key-value store. Used as a Data Access Object for the LOCAL_DATA table.

Summary

Public methods

abstract byte[] put(String key, byte[] value)

Associates the specified value with the specified key.

abstract byte[] remove(String key)

Removes the mapping for the specified key.

Inherited methods

Public methods

put

Added in API level 35
public abstract byte[] put (String key, 
                byte[] value)

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 byte: value to be associated with the specified key.
This value cannot be null.

Returns
byte[] the previous value associated with key, or null if there was no mapping for key.

remove

Added in API level 35
public abstract byte[] remove (String key)

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.

Returns
byte[] the previous value associated with key, or null if there was no mapping for key.