Vault 🔒

The Vault System provides robust mechanisms for secure data storage and management within the mobile app.

Custom Block Code Editor version: 1.8+

Functions

initialize

Description

Initializes a new Vault instance using the provided vaultKey and scope. This method returns a promise that resolves to a vault object with various methods for interacting with the Vault. This method can throw an VaultUserException or any of its children.

Parameters

Returns

A Promise that resolves to a Vault Object with the following methods or throws:

Scoping

The scope defines who should have access to the data stored within the vault.

For safety, if a vault is created with a "user" scope, when the user logs out all interactions with the vault from that moment forward will throw a VaultAccessException

Example

const vault = await Tapcart.actions.vault.initialize("test", "user");
vault.get('myKey')
    .then(value => console.log(value))
    .catch((error)=>{console.log(error)});

Vault Object

Description
The vault object returned by the initialize method provides the following methods for interacting with the Vault.

Get

get(key)

Gets the value associated with the given key.
Returns a promise that resolves to the associated value.

Example

const vault = await Tapcart.actions.vault.initialize("test", "user");
vault.get('myKey')
    .then(value => console.log(value))
    .catch((error)=>{console.log(error)});

const vault = await Tapcart.actions.vault.initialize("test", "user");
vault.get('myKey')
    .then(value => console.log(value))
    .catch((error)=>{console.log(error)});

Set

set(key, value)

Sets the value associated with the given key. Calling set with a null value is the same as calling remove(key)

Params

Return

A Promise that resolves true when the action was succesful.

Example

const vault = await Tapcart.actions.vault.initialize("test", "user");
await vault.set('myKey','foo') 
console.log(await vault.get('myKey')) //will print 'foo'

Clear

clear()

Clears all values from the Vault.

Return

Returns a Promise that resolves true when the action was succesful.

Example

const vault = await Tapcart.actions.vault.initialize("test", "user");
await vault.set('myKey','foo') 
console.log(await vault.get('myKey')) //will print 'foo'
await vault.clear()
console.log(await vault.get('myKey')) //will return undefined

Remove

remove(key)

Removes the value associated with the given key.

Params

Return

A Promise that resolves true when the action was succesful.

Example

const vault = await Tapcart.actions.vault.initialize("test", "user");
await vault.set('myKey','foo') 
console.log(await vault.get('myKey')) //will print 'foo'
await vault.remove('myKey')
console.log(await vault.get('myKey')) //will return undefined

Keys

keys()

Retrieves a list of all keys in the Vault.

Return

Returns a promise that resolves to an array of key values.

Example

const vault = await Tapcart.actions.vault.initialize("test", "user");
await vault.set('myKey','foo') 
await vault.set('myKey2','bar') 
console.log(await vault.keys()) //will return ['foo','bar']

Observe

observe(key, observer, errorHandler)

Observes changes to the value associated with the given key.

Return

Returns a promise that resolves when the observer is fully registered and can begin listening for updates.

Example

const vault = await Tapcart.actions.vault.initialize("test", "user");
await vault.set('myKey','foo') 
await vault.observe('myKey',(value)=>{console.log(value}),(error)=>{console.log(error)}}
await vault.set('myKey','bar')  //    ^ the observer will log 'bar'

Error Handling

The Vault System introduces various classes for handling different types of errors:
These are availble for use with instanceof under

Tapcart.actions.vault.errorTypes //returns an array of the possible Exception types