Skip to content

EULA Screen

The EulaScreenStep displays the Eula Agreement for the given version to the user, who must accept or decline. (The iOS equivalent is EULAStep.swift.)

Input Parameters

Mandatory input parameters:

  • context – Specifies the caller activity (root activity or logon activity set on the flowContext by the app developer at the start of the flow).

  • secureStore – Specifies the Secure Store which is used to store the data (set on the flowContext).

  • flowPresentationActionHandler – Specifies the Action Handler for Flow Presentation. If the user does not want to specify it's functionality, the default implementation can be used instead. (This is set on the flowContext by the app developer at the start of the flow.)

  • eulaVersion – Specifies the version of the Eula Agreement. The accepted version is saved to the secure store. If the reset is called on this step, the saved version is deleted from the store and the Eula Agreement must be accepted again.

    In the restore scenario, in case the given version differs from the one saved to the secure store, acceptance of the new Eula Agreement is required. Otherwise, the Eula Agreement is skipped. (This setting has to be provided in the step itself.)

Optional input parameters:

  • eulaScreenSettings – Specifies the settings for the Eula Screen. If there are no specified values passed for the view objects of the screen, the default string values are set. (This setting has to be provided in the step itself.)

Using EulaScreenStep

  1. Set the Secure Store and the Flow Presentation Action Handler in the flowContext.

    1
    2
    flowContext.setSecureStore(secureStore);
        flowContext.setFlowPresentationActionHandler(new FlowPresentationActionHandlerImpl(this));
    
  2. Initiate the step setting eulaScreenSettings and defining eulaVersion:

    1
    2
    3
    EulaScreenStep eulaScreenStep = new EulaScreenStep();
        eulaScreenStep.setEulaScreenSettings(eulaScreenSettings);
        eulaScreenStep.setEulaVersion("0.1");
    
  3. Specify the execute method's FlowActionHandler parameter's "onFailure" and "onSuccess" behaviour:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
        flowManagerService.execute(flow, flowContext, new FlowActionHandler() {
            @Override
            public void onFailure(Throwable t) {
              //error handling
            }
    
            @Override
            public void onSuccess(FlowContext result) {
              //read the result
            }
        });