FAXL3: Variables

From fringDocumentation

FAXL Variables

A FAXL variable is a runtime variable on the device. The following describes how to create and access these variables:

• Create:
  • When using an Action that has an OUT element, supply the FAXL variable name where the data is stored.
  • When giving the attribute name="xxx" inside a FAXL element (where possible by the FAXL scheme), create a new FAXL variable name xxx associated with the data of that element.

• Access:
  • Instead of supplying a <value> element as an argument to an Action, supply a <ref> element with the FAXL variable name. On the device, fring takes the content of that FAXL variable as the argument for the action.
  • Some Actions request arguments as a FAXL variable name. Therefore, they are given a <value> element where the value is a FAXL variable name. If supplied a <ref> attribute on the device, the argument for the action becomes the content of the <ref> FAXL variable.

FAXL Variable Lifecycle

FAXL variables are stored in the client and once created these variables remain until the device is restarted or unsubscribed to the add-on. If a new FAXL variable is created with a name that is already taken (a variable with this name already exists), it replaces the current variable.

FAXL compatibility

Supported from FAXL 3.0