Skip to content

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 string Optional
_Type const Required

CancelPendingActions

Controls if when the action runs any other pending actions are cancelled or not.

  • type: boolean
  • default: false

DismissModal

Control how the page is closed.

  • type: string

DismissModal Known Values

Value Description
Action.Type.ClosePage.Canceled Closes the page after pending actions are executed.
Action.Type.ClosePage.Completed 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

{
  "_Type": "Action.Type.ClosePage"
}

Close page with CANCEL specified

{
  "_Type": "Action.Type.ClosePage",
  "DismissModal": "Action.Type.ClosePage.Cancel"
}

Close page with COMPLETED specified

{
  "_Type": "Action.Type.ClosePage",
  "DismissModal": "Action.Type.ClosePage.Completed"
}