Skip to main content

Storage API

Storage API​

Stores and retrieves data in the device's local storage.

Capacity Limits:

  • Maximum per key: 1MB (1024KB)
  • Maximum total storage: 10MB (10240KB)
  • Only JSON-serializable data is supported

Note: Storage is managed internally by the SDK and automatically syncs data when the app transitions to the background or is terminated.

Async API​

setStorage(options)​

Stores data in local storage.

Options:

ParameterTypeRequiredDescription
keystring✅Key to store
dataany✅Data to store
successfunction-Success callback
failfunction-Failure callback
completefunction-Completion callback
TudadaSDK.setStorage({
key: 'userInfo',
data: { name: 'John', level: 10 },
success: () => console.log('Save complete'),
fail: (err) => console.error('Save failed:', err.errMsg),
});

getStorage(options)​

Retrieves data from local storage.

Options:

ParameterTypeRequiredDescription
keystring✅Key to retrieve
successfunction-Success callback
failfunction-Failure callback
completefunction-Completion callback

Success Response:

FieldTypeDescription
dataanyStored data
TudadaSDK.getStorage({
key: 'userInfo',
success: (res) => console.log('Data:', res.data),
});

removeStorage(options)​

Deletes data from local storage.

Options:

ParameterTypeRequiredDescription
keystring✅Key to delete
successfunction-Success callback
failfunction-Failure callback
completefunction-Completion callback
TudadaSDK.removeStorage({
key: 'tempData',
success: () => console.log('Delete complete'),
});

clearStorage(options?)​

Deletes all data from local storage.

Options:

ParameterTypeRequiredDescription
successfunction-Success callback
failfunction-Failure callback
completefunction-Completion callback
TudadaSDK.clearStorage({
success: () => console.log('Clear complete'),
});

Sync API​

setStorageSync(key, data)​

Synchronously stores data in local storage.

Parameters:

ParameterTypeRequiredDescription
keystring✅Key to store
dataany✅Data to store
TudadaSDK.setStorageSync('score', 1000);
// or
TudadaSDK.setStorageSync({ key: 'score', data: 1000 });

getStorageSync(key)​

Synchronously retrieves data from local storage.

Parameters:

ParameterTypeRequiredDescription
keystring✅Key to retrieve

Return Value:

FieldTypeDescription
(return value)anyStored data (undefined if not found)
const score = TudadaSDK.getStorageSync('score');
// or
const score = TudadaSDK.getStorageSync({ key: 'score' });

removeStorageSync(key)​

Synchronously deletes data from local storage.

Parameters:

ParameterTypeRequiredDescription
keystring✅Key to delete
TudadaSDK.removeStorageSync('tempData');

clearStorageSync()​

Synchronously deletes all data from local storage.

TudadaSDK.clearStorageSync();

getStorageInfoSync()​

Synchronously retrieves storage usage information.

Return Value:

FieldTypeDescription
keysstring[]List of stored keys
currentSizenumberCurrent usage (KB)
limitSizenumberMaximum capacity (KB)
const info = TudadaSDK.getStorageInfoSync();
console.log('Stored keys:', info.keys); // ['score', 'userInfo', ...]
console.log('Used space:', info.currentSize, 'KB'); // 12 KB
console.log('Limit:', info.limitSize, 'KB'); // 10240 KB