Class UserProfileTaskFactory


  • public class UserProfileTaskFactory
    extends Object
    Factory for creating user profile tasks. The tasks are only created and not executed.
    Since:
    8.0.1
    Author:
    XIMA MEDIA GmbH
    • Method Detail

      • changePrimaryEmail

        public static IUserEmailTask changePrimaryEmail​(String token)
                                                 throws RedirectException
        Creates a task to change the primary email address of a user profile.
        Parameters:
        token - for changing the primary user email. The token needs to be set within the user email.
        Returns:
        a task to change the primary email address of a user profile.
        Throws:
        RedirectException - if the task could not be created.
      • verifyEmail

        public static IUserEmailTask verifyEmail​(String token)
                                          throws RedirectException
        Creates a task to verify an email address of a user profile.
        Parameters:
        token - for verifying a user email. The token needs to be set within the user email.
        Returns:
        a task to verify a user email.
        Throws:
        RedirectException - if the task could not be created.
      • removeIdentity

        public static IUserIdentityTask removeIdentity​(String token)
                                                throws RedirectException
        Creates a task to remove a user identity from a user profile.
        Parameters:
        token - for removing a user identity. The token needs to be set within the user identity.
        Returns:
        a task to remove a user identity.
        Throws:
        RedirectException - if the task could not be created.
      • removeMfa

        public static IUserProfileTask removeMfa​(String token)
                                          throws RedirectException
        Creates a task to remove the user profile MFA config from a user profile and thereby disabling it.
        Parameters:
        token - for removing the user profile MFA config. The token needs to be set within the user profile MFA config.
        Returns:
        a task to remove the user profile MFA config.
        Throws:
        RedirectException - if the task could not be created.