Package velox.api.layer1.agreement

Interface AgreementComponent

All Known Implementing Classes:

AgreementComponent.RadioButtonGroup

public interface AgreementComponent

Represents an additional UI component that can be displayed in an agreement dialog, below the agreement text and above the accept/decline buttons.

Components allow collecting extra input from the user when they accept an agreement. Each component has a unique id() used to store the user's input in the agreements database.

See Also:

• AgreementInfo.Builder.setAgreementComponents(java.util.List)
• AgreementInfo.Builder.addRadioButtonGroup(String, String, RadioButtonGroup.Option[])

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	AgreementComponent.RadioButtonGroup	A radio button group component that presents the user with a set of mutually exclusive options.

Method Summary

Modifier and Type	Method	Description
String	id()	Unique identifier for the component within the agreement.

Method Details

id

String id()

Unique identifier for the component within the agreement. Used to store the user's input for this component in the agreements' database. Should be unique across all components in the agreement. Should not change for a specific component of a given agreement every time the agreement is shown with the given agreementId.

Returns:

the unique identifier of the component