Jive API (3.0.13) Core Javadocs

com.jivesoftware.community.event
Class AnnouncementEvent

java.lang.Object
  extended by 
      extended by com.jivesoftware.community.event.AnnouncementEvent

public class AnnouncementEvent
extends

A class for Announcement events. This class will be passed to EventListeners whenever an announcement 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
CREATED None
DELETED None
MODIFIEDNone


Nested Class Summary
static class AnnouncementEvent.Type
           
 
Constructor Summary
AnnouncementEvent()
           
AnnouncementEvent(AnnouncementEvent.Type eventType, Announcement announcement, Map<String,? extends Object> params)
          Creates a new announcement event.
 
Method Summary
 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

AnnouncementEvent

public AnnouncementEvent()

AnnouncementEvent

public AnnouncementEvent(AnnouncementEvent.Type eventType,
                         Announcement announcement,
                         Map<String,? extends Object> params)
Creates a new announcement event.

Parameters:
eventType - the type of the announcement event.
announcement - the announcement the event corresponds to.
params - parameters corresponding to the event.
Method Detail

getContentModificationType

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

Returns:
a ModificationType.

Jive Product Page

Copyright © 1999-2007 Jive Software.