ClosePage¶
You can close pages with the option to terminate ongoing events or wait until they are complete.
The properties defined in Action are also applicable to this action.
ClosePage Properties¶
| Property | Type | Required | Default |
|---|---|---|---|
| CancelPendingActions | boolean |
Optional | false |
| DismissModal | enum |
Optional | |
| _Type | const |
Required |
CancelPendingActions¶
Controls whether to cancel any other pending actions when the action runs.
- type:
boolean - default:
false
DismissModal¶
Control how the page is closed.
- type:
enum
The value of this property must be equal to one of the known values below.
| Value | Description |
|---|---|
Action.Type.ClosePage.Completed |
Closes the page after pending actions, i.e. actions that haven't been executed, are executed. |
Action.Type.ClosePage.Canceled |
Terminates execution of current and pending actions, and closes the page. |
_Type¶
- type:
const
The value of this property must be equal to:
"Action.Type.ClosePage"
Action Result¶
This action does not have an ActionResult.
Examples¶
Close page¶
Normal close
{
"_Type": "Action.Type.ClosePage"
}
Close page with pending actions cancelled¶
A typical use case is to have a change set action executing. When any of the modal pages are closed with the change set action cancels all pending actions and closes the modal page.
{
"_Type": "Action.Type.ClosePage",
"DismissModal": "Action.Type.ClosePage.Cancel"
}
Close page after compeleting pending actions¶
A typical use case is to have a change set action executing. When the last modal page is closed with the change set action commits and the modal page is closed.
{
"_Type": "Action.Type.ClosePage",
"DismissModal": "Action.Type.ClosePage.Completed"
}