RegisterHandlerInterface
interface RegisterHandlerInterface (View source)
Represents the base requirements for implementing an MFA Method's RegisterHandler, which has the responsibility of initiating and managing registration of the MFA Method in question against the current Member.
Methods
Stores any data required to handle a registration process with a method, and returns relevant state to be applied to the front-end application managing the process.
Confirm that the provided details are valid for a registration returning a Result describing the outcome of this validation. Detail to be persisted against the member should be set as context on the result.
Provide a localised URL to a support article about the registration process for this MFA Method.
Provide a localised string to describe the support link {getSupportLink} about this MFA Method.
Get the key that a React UI component is registered under (with @silverstripe/react-injector on the front-end)
Details
array
start(StoreInterface $store)
Stores any data required to handle a registration process with a method, and returns relevant state to be applied to the front-end application managing the process.
Result
register(HTTPRequest $request, StoreInterface $store)
Confirm that the provided details are valid for a registration returning a Result describing the outcome of this validation. Detail to be persisted against the member should be set as context on the result.
string
getDescription()
Provide a localised description of this MFA Method.
eg. "Verification codes are created by an app on your phone"
string
getSupportLink()
Provide a localised URL to a support article about the registration process for this MFA Method.
string
getSupportText()
Provide a localised string to describe the support link {getSupportLink} about this MFA Method.
string
getComponent()
Get the key that a React UI component is registered under (with @silverstripe/react-injector on the front-end)