Package com.smartfoxserver.components.signup

Interface ISignUpAssistantPlugin

public interface ISignUpAssistantPlugin

ADVANCED USERS ONLY

Allows to plug custom code in the SignUp Assistant process flow. This is useful if you want to implement advanced functionalities, such as processing the custom validation and application logic, response email customizations etc...

You can attach a plugin either BEFORE or AFTER the process, depending on the type of operation you need to execute.

See Also:

• SignUpAssistantComponent
• SignUpConfiguration

Method Summary

Modifier and Type	Method	Description
void	execute(User user, ISFSObject params, SignUpConfiguration config)	Handles the execution of the plugin logic

Method Details

execute

void execute(User user,
 ISFSObject params,
 SignUpConfiguration config)
      throws SignUpValidationException

Handles the execution of the plugin logic

Parameters:

user - the client

params - the client's parameters

config - the current SignUp Assistant configuration

Throws:

SignUpValidationException - firing an exception will result in stopping the process