VolatileData Module | Modules | Preview of Tealium Docs

Usage

The VolatileData module allows data variables to be stored in main memory (RAM). Data is stored and added to all dispatches/tracking calls until the app is restarted.

Usage of this module is mandatory. If you do not implement it, vital variables become missing from tracking calls.

The following platforms are supported:

iOS
tvOS
watchOS
macOS

Install

Install the VolatileData module with CocoaPods or Carthage.

CocoaPods

To install the VolatileData module with CocoaPods, add the following pod to your Podfile:

pod 'tealium-swift/TealiumVolatileData'

The framework is auto-instantiated. It has a dependency on the TealiumCore pod. Learn more about CocoaPods installation for iOS.

Carthage

To install the VolatileData module with Carthage, following these steps:

Go to the app target’s General configuration page in Xcode.
Add the following framework to the Embedded Binaries section:
```
TealiumVolatileData.framework
```
To store volatile data through the VolatileData API, add the following required import statement to your project:
```
import TealiumVolatileData
```

The framework is auto-instantiated. It has a dependency on TealiumCore. No additional import statements are necessary. Learn more about Carthage installation for iOS.

Included Variables

Variable	Description	Example	Supported Platforms
`tealium_random`	Random number	`"8449989974958830"`	iOS, tvOS, watchOS, macOS
`tealium_session_id`	Tealium Session ID	`"1511262829677"`	iOS, tvOS, watchOS, macOS
`tealium_timestamp_epoch`	Current Unix timestamp (1970 epoch) in seconds	`"1511262829"`	iOS, tvOS, watchOS, macOS
`tealium_account`	Current Tealium account (from TealiumConfig object)	`"tealium"`	iOS, tvOS, watchOS, macOS
`tealium_profile`	Current Tealium profile (from TealiumConfig object)	`"mobile"`	iOS, tvOS, watchOS, macOS
`tealium_environment`	Current Tealium environment (from TealiumConfig object)	[`"dev"`, `"qa"`, `"prod"`]	iOS, tvOS, watchOS, macOS
`tealium_library_name`	Tealium library name	`"swift"`	iOS, tvOS, watchOS, macOS
`tealium_library_version`	Tealium library version	`"1.4.0"`	iOS, tvOS, watchOS, macOS
`event_timestamp_iso*`	Event timestamp in ISO8601 (Zulu Time), UTC	`"2017-11-20T14:48:00Z"`	iOS, tvOS, watchOS, macOS
`timestamp`	Event timestamp in ISO8601 (Zulu Time), UTC	`"2017-11-20T14:48:00Z"`	iOS, tvOS, watchOS, macOS
`event_timestamp_local_iso*`	Event timestamp in ISO8601 local timezone	`"2017-11-20T06:48:00"`	iOS, tvOS, watchOS, macOS
`timestamp_local`	Event timestamp in ISO8601 local timezone	`"2017-11-20T06:48:00"`	iOS, tvOS, watchOS, macOS
`event_timestamp_offset_hours*`	Current offset from UTC in hours	`-8`	iOS, tvOS, watchOS, macOS
`timestamp_offset`	Current offset from UTC in hours	`-8`	iOS, tvOS, watchOS, macOS
`event_timestamp_unix_millis*`	Current Unix timestamp (1970 epoch) in milliseconds	`1511189280337`	iOS, tvOS, watchOS, macOS
`timestamp_unix_milliseconds`	Current Unix timestamp (1970 epoch) in milliseconds	`1511189280337`	iOS, tvOS, watchOS, macOS
`event_timestamp_unix*`	Current Unix timestamp (1970 epoch) in seconds	`1511189280`	iOS, tvOS, watchOS, macOS
`timestamp_unix`	Current Unix timestamp (1970 epoch) in seconds	`1511189280`	iOS, tvOS, watchOS, macOS

API Reference

See the TealiumVolatileData class in the iOS (Swift) API.