DataLayer

Class: DataLayer

This class provides persistent and volatile data storage for key-value data to be included with every tracked event.

The following methods are available for the DataLayer class.

all

Returns a map of all the key-value pairs currently stored in the data layer.

val dataLayer = tealium.dataLayer.all()

clear

Clears all items currently stored in the data layer.

tealium.dataLayer.clear()

contains

Returns true if the given key exists in the data layer, otherwise false.

tealium.dataLayer.contains("KEY")

count

Returns a the number of items currently stored in the data layer.

tealium.dataLayer.count()

get

Retrieves the value at the given key. Return types match one of the allowed types, else null is returned.

The method gets a variable of type Any (equivalent to Java’s Object). Inspect the type by using type casting or instanceof to use the data type appropriately.

val any = tealium.dataLayer.get("KEY")

getBoolean

Retrieves the Boolean value at the given key. If the value at this key is not a Boolean, then null is returned.

val bool = tealium.dataLayer.getBoolean("KEY")

getBooleanArray

Retrieves the Array<Boolean> value at the given key. If the value at this key is not a Array<Boolean>, then null is returned.

val booleanArray = tealium.dataLayer.getBooleanArray("KEY")

getDouble

Retrieves the Double value at the given key. If the value at this key is not a Double, then null is returned.

val double = tealium.dataLayer.getDouble("KEY")

getDoubleArray

Retrieves the Array<Double> value at the given key. If the value at this key is not a Array<Double>, then null is returned.

val doubleArray = tealium.dataLayer.getDoubleArray("KEY")

getInt

Retrieves the Int value at the given key. If the value at this key is not a Int, then null is returned.

val int = tealium.dataLayer.getInt("KEY")

getIntArray

Retrieves the Array<Int> value at the given key. If the value at this key is not a Array<Int>, then null is returned.

val intArray = tealium.dataLayer.getIntArray("KEY")

getJsonArray

Retrieves the org.json.JSONArray value at the given key. If the value at this key is not a JSONArray, then null is returned.

val jsonArray = tealium.dataLayer.getJsonArray("KEY")

getJsonObject

Retrieves the org.json.JSONObject value at the given key. If the value at this key is not a JSONObject, then null is returned.

val jsonObject = tealium.dataLayer.getJsonObject("KEY")

getLong

Retrieves the Long value at the given key. If the value at this key is not a Long, then null is returned.

val long = tealium.dataLayer.getLong("KEY")

getLongArray

Retrieves the Array<Long> value at the given key. If the value at this key is not a Array<Long>, then null is returned.

val longArray = tealium.dataLayer.getLongArray("KEY")

getString

Retrieves the String value at the given key. If the value at this key is not a String, then null is returned.

val string = tealium.dataLayer.getString("KEY")

getStringArray

Retrieves the Array<String> value at the given key. If the value at this key is not a Array<String>, then null is returned.

val stringArray = tealium.dataLayer.getStringArray("KEY")

keys

Returns the List<String> of all keys currently stored in the data layer

tealium.dataLayer.keys()

putBoolean

Stores a Boolean value at the given key.

tealium.dataLayer.putBoolean("KEY", true, Expiry.FOREVER)

putBooleanArray

Stores a Array<Boolean> value at the given key.

tealium.dataLayer.putBooleanArray("KEY", arrayOf(true, false, true), Expiry.FOREVER)

putDouble

Stores a Double value at the given key.

tealium.dataLayer.putDouble("KEY", 10.5, Expiry.FOREVER)

putDoubleArray

Stores a Array<Double> value at the given key.

tealium.dataLayer.putDoubleArray("KEY", arrayOf(0.1, 10.5), Expiry.FOREVER)

putInt

Stores a Int value at the given key.

tealium.dataLayer.putInt("KEY", 10, Expiry.FOREVER)

putIntArray

Stores a Array<Int> value at the given key.

tealium.dataLayer.putIntArray("KEY", arrayOf(100, Int.MAX_VALUE), Expiry.FOREVER)

putJsonArray

Stores an org.json.JSONArray value at the given key.

val my_list = new JSONArray();
my_list.put("value_1");
my_list.put("value_2");
tealium.dataLayer.putJsonArray("KEY", my_list, Expiry.FOREVER);

putJsonObject

Stores an org.json.JSONObject value at the given key.

val my_obj = new JSONObject();
my_obj.put("key", "value");
tealium.dataLayer.putJsonObject("KEY", my_obj, Expiry.FOREVER);

putLong

Stores a Long value at the given key.

tealium.dataLayer.putLong("KEY", Long.MAX_VALUE, Expiry.FOREVER)

putLongArray

Stores a Array<Long> value at the given key.

tealium.dataLayer.putLongArray("KEY", arrayOf(1000L, Long.MAX_VALUE), Expiry.FOREVER)

putString

Stores a String value at the given key.

tealium.dataLayer.putString("KEY", "String Value", Expiry.FOREVER)

putStringArray

Stores a Array<String> value at the given key.

tealium.dataLayer.putStringArray("KEY",
    arrayOf("String 1", "String 2"), Expiry.FOREVER)

remove

Removes the value stored at the given key

tealium.dataLayer.remove("KEY")