Class UserData

Adds a value or array of values to the list stored for the given key.

Example

userData.add('names', 'Oswald', B.time.Instant.now().plus(1, 'HOURS'));
userData.add('names', ['Sebastian', 'Torben', 'Rory']);
console.log(userData.get('names')); // ['Oswald', 'Sebastian', 'Torben', 'Rory']
Copy

explore example

[[Time]], [[Java.Time.InstantStatic.now]], [[Java.Time.Instant.plus]]

Example

Using the JavaScript Date constructor

userData.add('names', 'Vincent', new Date().getTime() + 60*60*1000);
Copy

Removes all values stored for the given name. Returns true if this caused a change to the values stored.

Example

console.log(`${key} was ${userData.clear(key) ? '' : 'un'}successfully cleared from UserData`);
Copy

Sets the expiration of the value(s) connected to key to the time when the user next logs out or is automatically logged out by session timeout.

Example

const willExpire = userData.expireOnLogout('myKey');
Copy

Gets the first value stored for the given name

Example

const firstListVal = userData.getFirst('names'); // 'Oswald'
Copy

Gets the list of values stored for a key. Returns an empty list if the key doesn't exist or contains an empty list.

Example

const listVal = userData.get('names'); // ['Oswald', Sebastian', 'Torben', 'Rory']
Copy

Returns true if there are no values stored for the given name

Example

let keyIsEmpty = userData.clear('names');
Copy

Gets the last value stored for the given name.

Example

const lastListVal = userData.getLast('names'); // 'Rory'
Copy

Gets the last value stored for the given name and removes it from the list.

Example

console.log(userData.get('names')); // ['Oswald', 'Sebastian', 'Torben', 'Rory']
userData.pop('names');
console.log(userData.get('names')); // ['Oswald', 'Sebastian', 'Torben']
Copy

Removes the value at the given index from the list of values stored for the name given. Returns the value removed.

Example

console.log(userData.get('names')); // ['Oswald', 'Sebastian', 'Torben', 'Rory']
userData.removeByIndex('names', 1);
console.log(userData.get('names')); // ['Oswald', 'Torben', 'Rory']
Copy

Removes the value given from the list of values stored for the name given. Returns true if the value was found and removed successfully.

Example

console.log(userData.get('names')); // ['Oswald', 'Sebastian', 'Torben', 'Rory']
const didRemove = userData.removeByValue('myKey', 'Torben');
console.log(userData.get('names')); // ['Oswald', 'Sebastian', 'Rory']
Copy

Clears any currently stored values and replaces them with a new list of values. The string values will be added to the list in the order defined by the index values, but the index values themselves will be discarded.

Example

console.log(userData.get('dates')); // ['2005-05-05','2015-05-05','2025-05-05']
userData.set('dates', ['2000-01-01','2010-01-01','2020-01-01']);
console.log(userData.get('dates')); // ['2000-01-01','2010-01-01','2020-01-01']
Copy

Gets the first value stored for the given name and removes it from the list.

Example

console.log(userData.get('names')); // ['Oswald', 'Sebastian', 'Torben', 'Rory']
userData.shift('names');
console.log(userData.get('names')); // ['Sebastian', 'Torben', 'Rory']
Copy

Returns a JSON of all of the active userData keys and their cooresponding values.