Method DeleteObjectAsync

Namespace

WhalesSecret.TradeScriptLib.API

Assembly

WhalesSecret.TradeScriptLib.dll

DeleteObjectAsync(byte[])

Deletes an object, identified by the given key, from the persistent storage.

Task<bool> DeleteObjectAsync(byte[] key)

Parameters

key byte[]

Key under which the object is stored.

Returns

Task<bool>

true if the object was deleted, false if there is no data stored under the given key.

Exceptions

DatabaseErrorException

Thrown if a database error occurred.

InvalidArgumentException

Thrown if key is null.

DeleteObjectAsync(string)

Deletes an object, identified by the given key, from the persistent storage.

Task<bool> DeleteObjectAsync(string key)

Parameters

key string

Key under which the object is stored. They key is interpreted as UTF-8 string and converted to a binary representation.

Returns

Task<bool>

true if the object was deleted, false if there is no data stored under the given key.

Exceptions

DatabaseErrorException

Thrown if a database error occurred.

InvalidArgumentException

Thrown if key is null.