Package pl.edu.icm.unity.engine.api.confirmation

Interface MobileNumberConfirmationManager

public interface MobileNumberConfirmationManager

Confirmation manager for mobile number

Author:

P. Piernik

Method Summary

Modifier and Type	Method	Description
Optional<MobileNumberConfirmationConfiguration>	getConfirmationConfigurationForAttribute(String attributeName)
SMSCode	sendConfirmationRequest(MobileNumberConfirmationConfiguration configEntry, String mobileToConfirm, ConfirmationInfo relatedConfirmationInfo)	Send confirmation request to the user.Message template id is taken from given mobile number confirmation configuration.

Method Detail

sendConfirmationRequest

SMSCode sendConfirmationRequest(MobileNumberConfirmationConfiguration configEntry,
                                String mobileToConfirm,
                                ConfirmationInfo relatedConfirmationInfo)
                         throws EngineException

Send confirmation request to the user.Message template id is taken from given mobile number confirmation configuration. The template is filled by manager with confirmation code and the whole message is sent via configured notification channel. Also relevant confirmationInfo is update.

Parameters:

configEntry -

mobileToConfirm -

relatedConfirmationInfo -

Returns:

sms code

Throws:

EngineException

getConfirmationConfigurationForAttribute

Optional<MobileNumberConfirmationConfiguration> getConfirmationConfigurationForAttribute(String attributeName)

Returns:

attribute confirmation configuration