com.jivesoftware.community.webservices
Class WSAvatar

java.lang.Object
  com.jivesoftware.community.webservices.WSJiveObject
      com.jivesoftware.community.webservices.WSAvatar

public class WSAvatar
extends WSJiveObject

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.

Since:

2.0

Field Summary

Fields inherited from class com.jivesoftware.community.webservices.WSJiveObject

id, objectType

Constructor Summary

WSAvatar()

Method Summary

WSAttachment	getAttachment() Returns the attachment for this avatar
WSUser	getOwner() Returns user who created this avatar, if the user is null then this is a global avatar
java.util.HashMap<java.lang.String,java.lang.String>	getProperties() Retrieve a map of all the extended properties for the avatar.
void	setAttachment(WSAttachment attachment) Sets the attachment for this avatar
void	setOwner(WSUser owner) Set the user who created this avatar, if the user is null then this is a global avatar
void	setProperties(java.util.HashMap<java.lang.String,java.lang.String> properties) Sets a map of all the extended properties for the avatar.

Methods inherited from class com.jivesoftware.community.webservices.WSJiveObject

equals, getID, getObjectType, hashCode, setID, setObjectType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WSAvatar

public WSAvatar()

Method Detail

getAttachment

public WSAttachment getAttachment()
                           throws AttachmentNotFoundException

Returns the attachment for this avatar

Returns:

the attachment for this avatar

Throws:

AttachmentNotFoundException - if we could not find an attachment for this avatar

setAttachment

public void setAttachment(WSAttachment attachment)

Sets the attachment for this avatar

Parameters:

attachment - the attachment for this avatar

getOwner

public WSUser getOwner()

Returns user who created this avatar, if the user is null then this is a global avatar

Returns:

user who created the avatar

setOwner

public void setOwner(WSUser owner)

Set the user who created this avatar, if the user is null then this is a global avatar

Parameters:

owner - the user who created this avatar

getProperties

public java.util.HashMap<java.lang.String,java.lang.String> getProperties()

Retrieve a map of all the extended properties for the avatar. Each avatar can have an arbitrary number of extended properties. This allows for enhanced functionality that is not part of the base interface. The map is not alterable.

Returns:

a map of avatar extended properties.

setProperties

public void setProperties(java.util.HashMap<java.lang.String,java.lang.String> properties)

Sets a map of all the extended properties for the avatar. Each avatar can have an arbitrary number of extended properties. This allows for enhanced functionality that is not part of the base interface.

Parameters:

properties - a map of avatar extended properties.