setIncludeDefaultCustomVariables

The setIncludeDefaultCustomVariables() method controls whether the SDK gets the platform, operating system, an app version from the tracker instance. This setting is turned on by default.

Syntax

await PiwikProSdk.setIncludeDefaultCustomVariables(shouldInclude);

Parameters

shouldInclude (boolean, required)

Whether platform, OS and app version are fetched from the tracker instance.

  • true if the values are fetched
  • false if the values aren’t fetched

Examples

To turn off automatic fetching of platform, OS and app version from the tracker instance:

await PiwikProSdk.setIncludeDefaultCustomVariables(false);

Notes

  • When setIncludeDefaultCustomVariables(true) is enabled, indexes 1-3 are used to track the platform, operating system, and app version as custom variables.