|
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 |
java.lang.Objectcom.jivesoftware.forum.proxy.AvatarProxy
public class AvatarProxy
Constructor Summary | |
---|---|
AvatarProxy(Avatar avatar,
AuthToken authToken,
Permissions permissions)
|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AvatarProxy(Avatar avatar, AuthToken authToken, Permissions permissions)
Method Detail |
---|
public long getID()
Avatar
getID
in interface Avatar
public int getModValue()
Avatar
getModValue
in interface Avatar
public Attachment getAttachment() throws AttachmentNotFoundException
Avatar
getAttachment
in interface Avatar
AttachmentNotFoundException
- if we could not find an attachment for this avatarpublic java.lang.String getProperty(java.lang.String name)
Avatar
getProperty
in interface Avatar
name
- the name of the property to get.
public void setProperty(java.lang.String name, java.lang.String value) throws UnauthorizedException
Avatar
If the property referenced by
name
already exists, its
value will be updated.
setProperty
in interface Avatar
name
- the name of the property to set.value
- the new value for the property.
UnauthorizedException
- if does not have admin permissions.public void deleteProperty(java.lang.String name) throws UnauthorizedException
Avatar
name
does not exist, this method will do nothing.
deleteProperty
in interface Avatar
name
- the name of the property to delete.
UnauthorizedException
- if does not have ADMIN permissions.public java.util.Iterator getPropertyNames()
Avatar
getPropertyNames
in interface Avatar
public User getOwner()
Avatar
getOwner
in interface Avatar
public void setModValue(int modValue) throws UnauthorizedException
Avatar
setModValue
in interface Avatar
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 |