com.atlassian.confluence.plugins.easyuser
Interface EasyUserManager

All Known Implementing Classes:

DefaultEasyUserManager

public interface EasyUserManager

Provides methods for adding users easily.

Since:

4.2

Method Summary

boolean	canSignUpWith(String token) Return true if the given token is valid for a user to self-sign-up.
String	getRelativeSignupURL()
SignupMode	getSignupMode() Returns the sign-up mode for this instance.
String	getSignUpToken() Gets the current sign-up token, or creates a new one and returns it.
String	getSignupURL()
boolean	isEmailSentOnInviteSignUp()
boolean	isPublicSignupPermitted() Returns true if users can sign themselves for this instance.
String	refreshAndGetToken() Creates a new sign-up token and returns it.
String	restorePreviousToken() Restore the previous private-signup token and returns it.
NotificationSendResult	sendInvites(SendUserInviteEvent event) Send invitation emails with a message to a list of email addresses.
void	setEmailSentOnInviteSignUp(boolean notify)
void	setSignupMode(SignupMode signupMode) Sets the sign-up mode for this instance.

Method Detail

getSignUpToken

String getSignUpToken()

Gets the current sign-up token, or creates a new one and returns it.

Returns:

a random sign-up token

canSignUpWith

boolean canSignUpWith(String token)

Return true if the given token is valid for a user to self-sign-up.

Parameters:

token - a sign-up token from a URL given to an invited user

refreshAndGetToken

String refreshAndGetToken()

Creates a new sign-up token and returns it. This invalidates the previous token.

Returns:

a random sign-up token

isEmailSentOnInviteSignUp

boolean isEmailSentOnInviteSignUp()

Returns:

true if notification emails should be sent to admins when a user signs themselves up.

setEmailSentOnInviteSignUp

void setEmailSentOnInviteSignUp(boolean notify)

Parameters:

notify - true if notification emails should be sent to admins when a user signs themselves up, false if not

restorePreviousToken

String restorePreviousToken()

Restore the previous private-signup token and returns it.

getSignupURL

String getSignupURL()

getRelativeSignupURL

String getRelativeSignupURL()

getSignupMode

SignupMode getSignupMode()

Returns the sign-up mode for this instance.

setSignupMode

void setSignupMode(SignupMode signupMode)

Sets the sign-up mode for this instance.

isPublicSignupPermitted

boolean isPublicSignupPermitted()

Returns true if users can sign themselves for this instance.

sendInvites

NotificationSendResult sendInvites(SendUserInviteEvent event)

Send invitation emails with a message to a list of email addresses.

Returns:

the number of emails sent