com.leafdigital.notification.api
Class NotificationListMsg

java.lang.Object
  extended by leafchat.core.api.Msg
      extended by com.leafdigital.notification.api.NotificationListMsg

public class NotificationListMsg
extends Msg

Message sent to identify available notification types. These are events that the application might want to notify the user about by a popup message.

Plugins that use notification should request this message and, on receiving it, call addType(String, boolean) to register their types.


Field Summary
 
Fields inherited from class leafchat.core.api.Msg
PRIORITY_AFTERNORMAL, PRIORITY_BEFORENORMAL, PRIORITY_EARLY, PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_LATE, PRIORITY_NORMAL
 
Constructor Summary
NotificationListMsg()
           
 
Method Summary
 void addType(java.lang.String type, boolean defaultOn)
          Adds a type.
 java.lang.String[] getDefaultTypes()
           
 java.lang.String[] getTypes()
           
 
Methods inherited from class leafchat.core.api.Msg
isHandled, isStopped, markHandled, markStopped, sequenceBefore, setSequence, setSequence
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NotificationListMsg

public NotificationListMsg()
Method Detail

addType

public void addType(java.lang.String type,
                    boolean defaultOn)
Adds a type. It is safe to add a type multiple times.

Parameters:
type - String defining the type. This should be a user-friendly string as it will be displayed in a preferences interface.
defaultOn -

getTypes

public java.lang.String[] getTypes()
Returns:
Array of all type names so far

getDefaultTypes

public java.lang.String[] getDefaultTypes()
Returns:
Array of all default type names so far


Copyright © 2011 Samuel Marshall. All rights reserved.