public interface CollabUser
CollabUser
represents a user in Social Collaboration applications.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ANONYMOUS
The name for an anonymous user.
|
static java.lang.String |
PROP_EMAIL
The property name for the email address.
|
static java.lang.String |
PROP_NAME
The property name for the user name.
|
static java.lang.String |
PROP_WEBSITE
The property name for the website URL.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getEmail()
Returns the email address of the user.
|
java.lang.String |
getGravatar(java.lang.String defaultImage)
Returns the URL to the user's gravatar image.
|
java.lang.String |
getId()
Returns the identifier of the user.
|
java.lang.String |
getName()
Returns the name of the user.
|
java.lang.String |
getWebsite(java.lang.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(java.lang.String email)
Sets the email address of the user.
|
void |
setName(java.lang.String name)
Sets the name of the user.
|
void |
setWebsite(java.lang.String website)
Sets the URL of the user's website.
|
static final java.lang.String ANONYMOUS
static final java.lang.String PROP_NAME
static final java.lang.String PROP_WEBSITE
static final java.lang.String PROP_EMAIL
java.lang.String getId()
java.lang.String getName()
void setName(java.lang.String name)
name
- The user namejava.lang.String getEmail()
void setEmail(java.lang.String email)
email
- The email addressjava.lang.String getWebsite(java.lang.String defaultUrl)
defaultUrl
- The default URL to use if undefinedvoid setWebsite(java.lang.String website)
website
- The websitejava.lang.String getGravatar(java.lang.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
SocialException
- if saving failsCopyright © 2010 - 2020 Adobe. All Rights Reserved