WaitAction Class Reference

Specifies a time period that elapses before the action finishes. You can use this action to create a pause in sequential actions. More...

Inherits IntegrationAction.

Public Member Functions
void	InitializeProperties_WaitAction ()
	Creates an action. More...

Properties
int	TimeToWait [get, set]
	Specifies the amount of time, in milliseconds, that the action waits before it finishes. More...
CommonActionProperties
Describes the common action properties for Actions and ActionGroups.
string	Name [get, set]
	Specifies the name. This property cannot be empty and must be unique in the YAML script. More...
string	Description [get, set]
	Specifies the description. The default value is "". More...
ActionRunType	RunType [get, set]
	Runs the action by using one of the following types: More...
bool	IgnoreErrors [get, set]
	Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false. More...
int	FailureRetries [get, set]
	Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0. More...
int	RetryInterval [get, set]
	Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000. More...

Detailed Description

Specifies a time period that elapses before the action finishes. You can use this action to create a pause in sequential actions.

For common action properties, see IntegrationAction.
Example:

Actions:
- WaitAction:
    TimeToWait: 3000
    Name: Wait 3 seconds
    # And more common action properties
    ... 

Member Function Documentation

InitializeProperties_WaitAction()

void InitializeProperties_WaitAction ( )

inline

Creates an action.

Property Documentation

TimeToWait

int TimeToWait

getset

Specifies the amount of time, in milliseconds, that the action waits before it finishes.

Name

string Name

getsetinherited

Specifies the name. This property cannot be empty and must be unique in the YAML script.

Description

string Description

getsetinherited

Specifies the description. The default value is "".

RunType

ActionRunType RunType

getsetinherited

Runs the action by using one of the following types:

• Always (default)
• Never

IgnoreErrors

bool IgnoreErrors

getsetinherited

Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.

FailureRetries

int FailureRetries

getsetinherited

Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.

RetryInterval

int RetryInterval

getsetinherited

Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000.

---

The documentation for this class was generated from the following file:

• WaitAction.Properties.cs