|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RegistrationManager
Manages validation settings and validating new user accounts.
Field Summary | |
---|---|
static java.lang.String |
PROPERTY_EMAIL_ADDRESS
|
static java.lang.String |
PROPERTY_EMAIL_BODY
|
static java.lang.String |
PROPERTY_EMAIL_NAME
|
static java.lang.String |
PROPERTY_EMAIL_SUBJECT
|
static java.lang.String |
PROPERTY_HUMAN_VALIDATION_ENABLED
|
static java.lang.String |
PROPERTY_TERMS_ENABLED
|
static java.lang.String |
PROPERTY_TERMS_URL
|
static java.lang.String |
PROPERTY_USER_VALIDATION_KEY
|
static java.lang.String |
PROPERTY_VALIDATION_ENABLED
|
Method Summary | |
---|---|
java.lang.String |
getEmailAddress()
Gets the email address that validation emails will appear to be from |
java.lang.String |
getEmailBody(java.util.Locale locale)
Gets the text for the body of the validation emails. |
java.lang.String |
getEmailName()
Gets the name that validation emails will appear to be from |
java.lang.String |
getEmailSubject(java.util.Locale locale)
Gets the text for the subject of validation emails |
java.lang.String |
getTermsURL()
Gets the string url representing the terms and conditions page |
boolean |
isAccountValidated(long userID)
Checks if a user account has been validated |
boolean |
isHumanValidationEnabled()
Returns true if the human input validation feature is turned on. |
boolean |
isTermsEnabled()
Returns true if terms and conditions is enabled |
boolean |
isValidationEnabled()
Returns true if the validation feature is turned on. |
void |
markAccountForValidation(User user)
Marks the user account for validation and sends a validation request to the user. |
void |
setEmailAddress(java.lang.String emailAddress)
Sets the email address that validation emails will appear to be from |
void |
setEmailBody(java.lang.String emailBody,
java.util.Locale locale)
Sets the text for the body of of validation emails. |
void |
setEmailName(java.lang.String emailName)
Sets The name that validation emails will appear to be from |
void |
setEmailSubject(java.lang.String emailSubject,
java.util.Locale locale)
Sets the text for the subject of validation emails |
void |
setHumanValidationEnabled(boolean humanValidationEnabled)
Enables or disables the human input validation feature. |
void |
setTermsEnabled(boolean termsEnabled)
Sets terms and conditions to be enabled / disabled |
void |
setTermsURL(java.lang.String termsURL)
Sets the string url representing the terms and conditions page |
void |
setValidationEnabled(boolean validationEnabled)
Enables or disables the validation feature. |
boolean |
validateAccount(long userID,
java.lang.String validationKey)
Validates a user account using a unique validation key |
Field Detail |
---|
static final java.lang.String PROPERTY_VALIDATION_ENABLED
static final java.lang.String PROPERTY_HUMAN_VALIDATION_ENABLED
static final java.lang.String PROPERTY_EMAIL_NAME
static final java.lang.String PROPERTY_EMAIL_ADDRESS
static final java.lang.String PROPERTY_EMAIL_SUBJECT
static final java.lang.String PROPERTY_EMAIL_BODY
static final java.lang.String PROPERTY_USER_VALIDATION_KEY
static final java.lang.String PROPERTY_TERMS_ENABLED
static final java.lang.String PROPERTY_TERMS_URL
Method Detail |
---|
boolean isValidationEnabled()
void setValidationEnabled(boolean validationEnabled)
validationEnabled
- true to enable the validation feature, false to disable.boolean isHumanValidationEnabled()
void setHumanValidationEnabled(boolean humanValidationEnabled)
humanValidationEnabled
- true to enable the human input validation feature, false to disable.java.lang.String getEmailName()
void setEmailName(java.lang.String emailName)
emailName
- the name that validation emails will appear to be fromjava.lang.String getEmailAddress()
void setEmailAddress(java.lang.String emailAddress)
emailAddress
- the email address that validation emails will appear to be fromjava.lang.String getEmailSubject(java.util.Locale locale)
locale
-
void setEmailSubject(java.lang.String emailSubject, java.util.Locale locale)
emailSubject
- the text for the subject of validation emailslocale
- java.lang.String getEmailBody(java.util.Locale locale)
locale
-
void setEmailBody(java.lang.String emailBody, java.util.Locale locale)
emailBody
- the text for the body of the validation emailslocale
- boolean isTermsEnabled()
void setTermsEnabled(boolean termsEnabled)
termsEnabled
- true to enavled terms and conditions; false to disabledjava.lang.String getTermsURL()
void setTermsURL(java.lang.String termsURL)
termsURL
- the string url of the terms and conditions pagevoid markAccountForValidation(User user)
boolean validateAccount(long userID, java.lang.String validationKey) throws UserNotFoundException
userID
- the userID representing the user account to validatevalidationKey
- the unique validation key
UserNotFoundException
- if the user object can not be foundboolean isAccountValidated(long userID) throws UserNotFoundException
userID
- the userID to check
UserNotFoundException
- if the user object can not be found
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |