InboxVariable¶
- class InboxVariable¶
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:
-
EnableDiscarding(value=
True)¶ Enables or disables discarding for the inbox.
- Parameters:
- value : bool¶
True to enable discarding, False to disable
-
EnableOverflowWarning(value=
True)¶ Enables or disables overflow warning for the inbox.
- Parameters:
- value : bool¶
True to enable overflow warning, False to disable
- GetDescription()¶
Returns the description of the variable.
- Returns:
Description of variable
- Return type:
str
- GetFetchTimeout()¶
Returns the fetch timeout for the inbox, which corresponds to the maximum time to wait for a message to arrive when fetching from the inbox. :return: Fetch timeout in seconds :rtype: int
- GetName()¶
Returns the name of the variable.
- Returns:
Name of variable
- Return type:
str
- GetSize()¶
Returns the size of the inbox, which corresponds to the number of messages that can be stored in the inbox.
- Returns:
Size of the inbox
- Return type:
int
- GetType()¶
Returns the type of the initial value of the variable.
- Returns:
type of the initial value
- Return type:
str
- IsDiscardingEnabled()¶
Returns whether discarding is enabled for the inbox.
- Returns:
True if discarding is enabled, False otherwise
- Return type:
bool
- IsOverflowWarningEnabled()¶
Returns whether overflow warning is enabled for the inbox. :return: True if overflow warning is enabled, False otherwise :rtype: bool
- 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
- SetFetchTimeout(timeout)¶
Sets the fetch timeout for the inbox, which corresponds to the maximum time to wait for a message to arrive when fetching from the inbox.
- Parameters:
- timeout : int¶
Fetch timeout in seconds
-
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