|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Avatar
An object that represents a user's avatar. Avatars give a user the ability to specify an image that will be displayed alongside their username throughout the application.
Method Summary | |
---|---|
void |
deleteProperty(java.lang.String name)
Deletes an extended property. |
Attachment |
getAttachment()
Returns the attachment for this avatar |
long |
getID()
Returns the unique ID of the avatar |
int |
getModValue()
Returns the moderation value for this Avatar |
User |
getOwner()
Returns user who created this avatar, if the user is null then this is a global avatar |
java.lang.String |
getProperty(java.lang.String name)
Returns an extended property of the attachment. |
java.util.Iterator |
getPropertyNames()
Returns an Iterator for the names of the extended properties. |
void |
setModValue(int modValue)
Modifies the moderation value of this specific avatar |
void |
setProperty(java.lang.String name,
java.lang.String value)
Sets an extended property of the attachment. |
Method Detail |
---|
long getID()
int getModValue()
Attachment getAttachment() throws AttachmentNotFoundException
AttachmentNotFoundException
- if we could not find an attachment for this avatarjava.lang.String getProperty(java.lang.String name)
name
- the name of the property to get.
void setProperty(java.lang.String name, java.lang.String value) throws UnauthorizedException
If the property referenced by
name
already exists, its
value will be updated.
name
- the name of the property to set.value
- the new value for the property.
UnauthorizedException
- if does not have admin permissions.void deleteProperty(java.lang.String name) throws UnauthorizedException
name
does not exist, this method will do nothing.
name
- the name of the property to delete.
UnauthorizedException
- if does not have ADMIN permissions.java.util.Iterator getPropertyNames()
User getOwner()
void setModValue(int modValue) throws UnauthorizedException
modValue
- change the moderation value
UnauthorizedException
- thrown if the user does not have moderation privileges
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |