Class BrowserKeyValueStore

An IKeyValueStore implementation that uses browser host capabilities for storage.

Inheritance

Object

BrowserKeyValueStore

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: Unity.Cloud.Common.Runtime

Syntax

public class BrowserKeyValueStore : IKeyValueStore

Constructors

BrowserKeyValueStore()

Creates a BrowserKeyValueStore instance.

Declaration

public BrowserKeyValueStore()

Exceptions

Type	Condition
PlatformNotSupportedException	Thrown if used outside a Unity WebGL execution context.

Methods

DeleteCacheAsync(String)

A Task that deletes a unique filename in the current IKeyValueStore.

Declaration

public Task DeleteCacheAsync(string filename)

Parameters

Type	Name	Description
String	filename	The unique filename to delete from the current IKeyValueStore.

Returns

Type	Description
Task	A Task that deletes a unique filename in the current IKeyValueStore.

Implements

IKeyValueStore.DeleteCacheAsync(String)

Exceptions

Type	Condition
ArgumentException	Thrown if the filename is null or empty.

ReadCacheAsync(String)

A Task that reads a cached string from the current IKeyValueStore.

Declaration

public Task<string> ReadCacheAsync(string filename)

Parameters

Type	Name	Description
String	filename	The unique filename to look for in the current IKeyValueStore.

Returns

Type	Description
Task<String>	A Task that results in the cached string value.

Implements

IKeyValueStore.ReadCacheAsync(String)

Exceptions

Type	Condition
ArgumentException	Thrown if the filename is null or empty.
FileNotFoundException	Thrown if the filename does not exist.

ValidateFilenameExistsAsync(String)

A Task that validates if a filename exists in the IKeyValueStore.

Declaration

public Task<bool> ValidateFilenameExistsAsync(string filename)

Parameters

Type	Name	Description
String	filename	The unique filename to look for in the current IKeyValueStore.

Returns

Type	Description
Task<Boolean>	A task that has a result of true if the filename is found, false otherwise.

Implements

IKeyValueStore.ValidateFilenameExistsAsync(String)

Exceptions

Type	Condition
ArgumentException	Thrown if the filename is null or empty.

WriteToCacheAsync(String, String)

A Task that writes a string content value under a unique filename in the current IKeyValueStore.

Declaration

public Task WriteToCacheAsync(string filename, string content)

Parameters

Type	Name	Description
String	filename	The unique filename that will hold the content value in the current IKeyValueStore.
String	content	The string content to write.

Returns

Type	Description
Task	A Task that writes a string content value under a unique filename in the current IKeyValueStore.

Implements

IKeyValueStore.WriteToCacheAsync(String, String)

Remarks

Overwrite any previous value.

Exceptions

Type	Condition
ArgumentException	Thrown if the filename is null or empty.