com.jivesoftware.community.event
Class PrivateMessageEvent

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

public class PrivateMessageEvent
extends 

A class for PrivateMessage events. This class will be passed to EventListeners whenever a private message 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
SENT	None
READ	None

Nested Class Summary

static class

PrivateMessageEvent.Type

Constructor Summary

PrivateMessageEvent()

PrivateMessageEvent(PrivateMessageEvent.Type eventType, PrivateMessage privateMessage, Map<String,? extends Object> params)
Creates a new private message event.

Method Summary

ContentEvent.ModificationType

getContentModificationType() A modification type from the list below that corresponds to the implementing event's type.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrivateMessageEvent

public PrivateMessageEvent()

PrivateMessageEvent

public PrivateMessageEvent(PrivateMessageEvent.Type eventType,
                           PrivateMessage privateMessage,
                           Map<String,? extends Object> params)

Creates a new private message event.

Parameters:

eventType - the type of the message event.

privateMessage - the private message the event corresponds to.

params - parameters corresponding to the event.

Method Detail

getContentModificationType

public ContentEvent.ModificationType getContentModificationType()

A modification type from the list below that corresponds to the implementing event's type.

Returns:

a ModificationType.