com.jivesoftware.community.event
Class AvatarEvent

java.lang.Object
  com.jivesoftware.community.event.AvatarEvent

All Implemented Interfaces:

com.jivesoftware.community.JiveEvent

public class AvatarEvent
extends Object
implements com.jivesoftware.community.JiveEvent

A class for Avatar events. This class will be passed to AvatarListeners whenever an avatar event is fired and contains all the pertinent information to the event. Certain event types will populate the params Map with additional objects as outlined below:

Event Type

Extra Params

AVATAR_CREATED

None

AVATAR_DELETED

None

ACTIVE_AVATAR_MODIFIED

Description	Name
The user's username	username

Field Summary

static int	ACTIVE_AVATAR_MODIFIED The active Avatar of a user was modified.
static int	AVATAR_CREATED Avatar was added to the system.
static int	AVATAR_DELETED Avatar was deleted.

Constructor Summary

AvatarEvent(int eventType, Avatar avatar, Map<String,? extends Object> params)
Creates a new avatar event.

Method Summary

Avatar	getAvatar() Returns the Avatar that the event corresponds to.
Date	getDate()
int	getEventType()
Map<String,? extends Object>	getParams()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AVATAR_CREATED

public static final int AVATAR_CREATED

Avatar was added to the system.

See Also:

Constant Field Values

AVATAR_DELETED

public static final int AVATAR_DELETED

Avatar was deleted.

See Also:

Constant Field Values

ACTIVE_AVATAR_MODIFIED

public static final int ACTIVE_AVATAR_MODIFIED

The active Avatar of a user was modified.

See Also:

Constant Field Values

Constructor Detail

AvatarEvent

public AvatarEvent(int eventType,
                   Avatar avatar,
                   Map<String,? extends Object> params)

Creates a new avatar event.

Parameters:

eventType - the type of the announcement event.

avatar - the avatar the event corresponds to.

params - parameters corresponding to the event.

Method Detail

getEventType

public int getEventType()

Specified by:

getEventType in interface com.jivesoftware.community.JiveEvent

getAvatar

public Avatar getAvatar()

Returns the Avatar that the event corresponds to.

Returns:

the avatar the event corresponds to.

getParams

public Map<String,? extends Object> getParams()

Specified by:

getParams in interface com.jivesoftware.community.JiveEvent

getDate

public Date getDate()

Specified by:

getDate in interface com.jivesoftware.community.JiveEvent