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

Interface MobileNumberConfirmationManager

  • public interface MobileNumberConfirmationManager
    Confirmation manager for mobile number
    Author:
    P. Piernik

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Optional<pl.edu.icm.unity.types.confirmation.MobileNumberConfirmationConfiguration> getConfirmationConfigurationForAttribute​(java.lang.String attributeName)  
      SMSCode sendConfirmationRequest​(pl.edu.icm.unity.types.confirmation.MobileNumberConfirmationConfiguration configEntry, java.lang.String mobileToConfirm, pl.edu.icm.unity.types.confirmation.ConfirmationInfo relatedConfirmationInfo)
      Send confirmation request to the user.Message template id is taken from given mobile number confirmation configuration.

    • Method Detail

      • sendConfirmationRequest

        SMSCode sendConfirmationRequest​(pl.edu.icm.unity.types.confirmation.MobileNumberConfirmationConfiguration configEntry,
                                java.lang.String mobileToConfirm,
                                pl.edu.icm.unity.types.confirmation.ConfirmationInfo relatedConfirmationInfo)
                         throws pl.edu.icm.unity.exceptions.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:
        pl.edu.icm.unity.exceptions.EngineException

      • getConfirmationConfigurationForAttribute

        java.util.Optional<pl.edu.icm.unity.types.confirmation.MobileNumberConfirmationConfiguration> getConfirmationConfigurationForAttribute​(java.lang.String attributeName)
        Returns:
        attribute confirmation configuration