For the complete documentation index, see llms.txt. You can also append .md to any page URL to get its markdown version.
Skip to main content
For the complete documentation index, see llms.txt.

For the complete documentation index, see llms.txt

Controller state

The controller contains a state of the ongoing operation, which is propagated though the state change interface onStateChanged(...).

Example: State of ongoing operation
interface AsyncStateChangedCallback {
fun onStateChanged(state: EncapController.State)
}

Controller states

To learn about the possible states for each ongoing operation, see the tables in the sections below.

Activation states

The table below shows a list of possible states which indicate that the controller is performing an activation, or is ready to start it:

Authentication states

The table below shows a list of possible states which indicate that the controller is performing an authentication, or is ready to start it:

Add or update states

The table below shows a list of possible states which indicate that the controller is performing an add or update, or is ready to start it:

Deactivation states

The table below shows a list of possible states which indicate that the controller is performing a deactivation, or is ready to start it:

States returned during deactivation

When using the deactivation method deactivate() with parameter localOnly set to false, a device authentication happens towards the server.

This means that during deactivation, the state also contains values shown in the Authentication states section.

Adding a recovery states

The table below shows a list of possible states which indicate that the controller is adding a recovery, or is ready to start it:

Performing a recovery states

The table below shows a list of possible states which indicate that the controller is performing a recovery or is ready to start it:

Deleting a recovery states

The table below shows a list of possible states which indicate that the controller is deleting a recovery or is ready to start it:

Blocking states

Blocking states indicate that there is an operation that has to be finished first. The table below shows a list of states that block other operations: