StringVariable¶
- class StringVariable¶
Returned by
- Clone()¶
Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.
- Returns:
A copy of this object
- Return type:
- GetDescription()¶
Returns the description of the variable.
- Returns:
Description of variable
- Return type:
str
- GetInitialValue()¶
Returns the initial value of the variable or None if it is not a String.
- Returns:
Initial value of the variable
- Return type:
str
- GetName()¶
Returns the name of the variable.
- Returns:
Name of variable
- Return type:
str
- GetTranslatedInitialValue(language)¶
Returns the initial value of the variable for the specified language.
- Returns:
Initial value of the variable
- Return type:
str
- Parameters:
- language : str¶
Language of the value (‘en_US’, ‘de_DE’, ‘zh_CN’)
- GetType()¶
Returns the type of the initial value of the variable.
- Returns:
type of the initial value
- Return type:
str
- IsParameter()¶
Returns whether the variable is a parameter.
- Returns:
True if parameter, else False
- Return type:
boolean
- IsRecorded()¶
Returns whether the variable is recorded during execution.
- Returns:
True if recorded, else False
- Return type:
boolean
- IsReturn()¶
Returns whether the variable is a return value.
- Returns:
True if return value, else False
- Return type:
boolean
- SetDescription(description)¶
Sets the description of the variable.
- Parameters:
- description : str¶
Description of variable
- SetInitialValue(value)¶
Sets the initial value of the variable.
- Parameters:
- value : str¶
Initial value of the variable
-
SetParameter(enable=
True)¶ Sets whether the variable is a parameter or not.
- Parameters:
- enable : boolean¶
Whether the variable is a parameter or not
-
SetRecorded(enable=
True)¶ Sets the recording state of the variable to the value of enable.
- Parameters:
- enable : boolean¶
Whether to enable the recording of the variable