EnvironmentVariable
EnvironmentVariable
The EnvironmentVariable object represents an variable stored in a EnvironmentDomain it will take different values depending upon the current Environment for this domain.
id
id
The unique identifier (UUID) (Read-only).
name
name
The Environment Variable’s name as it is shown in the Environment panel (Writable property only for Importers).
order
order
The order of the Environment Variable in the Environment panel, the order is relative to the parent Environment Domain (Writable property only for Importers).
getCurrentValue
getCurrentValue
Argument:
returnDynamicString: boolean: None
if
true will return the value as a
DynamicString
Returns:
None: DynamicString || string
- If
returnDynamicString is true returns the variable value in the current Environment as a DynamicString
- Otherwise, returns the variable value in the current Environment as a
string
getValue
getValue
Argument:
environment: Environment: None
The
Environment from which to get the value.
Returns:
None: DynamicString
Returns the variable value in the given
Environment.
setCurrentValue
setCurrentValue
Argument: value: DynamicString: None
The value to set.
Sets the variable value in the current Environment.
setValue
setValue
Argument: value: DynamicString: None
The value to set.
Argument:
environment: Environment: None
The
Environment were the value should be set.
Sets the variable value in the given Environment.