Skip to content

Logout

Define an action that allows the user to log out of the application. Once the user is logged out, no other actions are possible in that session and the welcome screen appears on the application. All stored credentials such as passcode or Touch ID, authentication token, Offline Store, and so on are cleared from the device. However, depending on the value of SkipReset flag it may either just log out and show the Sign In screen or else clears everything as previously mentioned. Also, success or failure event handlers are not applicable to the this action.

The properties defined in Action are also applicable to this action.

Logout Properties

Property Type Required Default
SkipReset boolean Optional false
_Type const Required

SkipReset

If set to true, it will skip reset of application and nothing is cleared from the device. User is simply logged out in this case and taken to Sign In screen. In case passcode policy is not set(along with SkipReset = true) this action will be a no-op.

If set to false, it will reset the application and clear all the data from the device. User is then taken to welcome screen.

  • type: boolean
  • default: false

_Type

  • type: const

The value of this property must be equal to:

"Action.Type.Logout"

Action Result

This action does not have an action result.


Examples

// Logout.action
{
    "Type" : "Action.Type.Logout"
}

json // LogoutSkipReset.action { "Type" : "Action.Type.Logout", "SkipReset": true }