Interface IDataStore (1.68.0) 

public interface IDataStore

Stores and manages data objects, where the key is a string and the value is an object. The store will use Instance for serialization.

null keys are not allowed.

Namespace

Google.Apis.Util.Store

Assembly

Google.Apis.Core.dll

Methods

ClearAsync()

Task ClearAsync()

Asynchronously clears all values in the data store.

Returns
Type Description
Task

DeleteAsync<T>(string)

Task DeleteAsync<T>(string key)

Asynchronously deletes the given key. The type is provided here as well because the "real" saved key should contain type information as well, so the data store will be able to store the same key for different types.

Parameter
Name Description
key string

The key to delete.
Returns
Type Description
Task
Type Parameter
Name Description
T

The type to delete from the data store.

GetAsync<T>(string)

Task<T> GetAsync<T>(string key)

Asynchronously returns the stored value for the given key or null if not found.

Parameter
Name Description
key string

The key to retrieve its value.
Returns
Type Description
Task

The stored object deserialized using Instance.
Type Parameter
Name Description
T

The type to retrieve from the data store.

StoreAsync<T>(string, T)

Task StoreAsync<T>(string key, T value)

Asynchronously stores the given value for the given key (replacing any existing value).

Parameters
Name Description
key string

The key.
value T

The value to store. Will be serialized using Instance.
Returns
Type Description
Task
Type Parameter
Name Description
T

The type to store in the data store.

Extension Method