public interface CollabUser
CollabUser
represents a user in Social Collaboration applications.Modifier and Type | Field and Description |
---|---|
static String |
ANONYMOUS
The name for an anonymous user.
|
static String |
PROP_EMAIL
The property name for the email address.
|
static String |
PROP_NAME
The property name for the user name.
|
static String |
PROP_WEBSITE
The property name for the website URL.
|
Modifier and Type | Method and Description |
---|---|
String |
getEmail()
Returns the email address of the user.
|
String |
getGravatar(String defaultImage)
Returns the URL to the user's gravatar image.
|
String |
getId()
Returns the identifier of the user.
|
String |
getName()
Returns the name of the user.
|
String |
getWebsite(String defaultUrl)
Returns the URL of the user's website.
|
boolean |
isModified()
Returns whether this user has been modified and needs to be saved.
|
void |
save()
Saves all changes made to this user.
|
void |
setEmail(String email)
Sets the email address of the user.
|
void |
setName(String name)
Sets the name of the user.
|
void |
setWebsite(String website)
Sets the URL of the user's website.
|
static final String ANONYMOUS
static final String PROP_NAME
static final String PROP_WEBSITE
static final String PROP_EMAIL
String getId()
String getName()
void setName(String name)
name
- The user nameString getEmail()
void setEmail(String email)
email
- The email addressString getWebsite(String defaultUrl)
defaultUrl
- The default URL to use if undefinedvoid setWebsite(String website)
website
- The websiteString getGravatar(String defaultImage)
defaultImage
- The default image to display if no gravatar is availableboolean isModified()
true
if user is modified, false
otherwisesave()
void save() throws SocialException
CollabException
- if saving failsSocialException
"Copyright © 2006 - 2015 Adobe Systems Incorporated. All Rights Reserved"