com.sun.im.desktop
Class MessengerAppContext

java.lang.Object
  extended bycom.sun.im.desktop.MessengerAppContext

public class MessengerAppContext
extends java.lang.Object

Base interface for all application contexts in which extensions may be invoked. Provides application information to an extension's module.


Constructor Summary
MessengerAppContext()
           
 
Method Summary
 void addMessageListener(MessengerMessageListener listener)
          set a listener for a specific type of alert/notification message
 void addMessageListener(java.lang.String contentType, MessengerMessageListener listener)
          set a listener for a specific type of alert/notification message
 void displayAlert(java.lang.String originator, java.lang.String subject, java.lang.String content)
          display html alert
 void displayBotAlert(java.lang.String originator, java.lang.String subject, java.lang.String content)
          Dispalys HTML alert.
static MessengerAppContext getAppContext()
           
 java.lang.String getDisplayName(java.lang.String uid)
          return the display name of a user from its user id
 java.lang.String getProperty(java.lang.String name)
          return the value of an application/applet property
 java.lang.String getUserId()
          returns the user ID of the user
 java.lang.String getUserPreference(java.lang.String prefix, java.lang.String name, java.lang.String defaultValue)
          retrieve a bean specific user preference.
 void setUserPreference(java.lang.String prefix, java.lang.String name, java.lang.String value)
          set a bean specific user preference.
 void showURL(java.lang.String url, java.lang.String target)
          bring up a web page in the browser
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MessengerAppContext

public MessengerAppContext()
Method Detail

getAppContext

public static MessengerAppContext getAppContext()

getUserId

public java.lang.String getUserId()
returns the user ID of the user


getProperty

public java.lang.String getProperty(java.lang.String name)
return the value of an application/applet property

Parameters:
name - nume of the property to retrieve.

getDisplayName

public java.lang.String getDisplayName(java.lang.String uid)
return the display name of a user from its user id

Parameters:
uid - user ID.
Returns:
display name

showURL

public void showURL(java.lang.String url,
                    java.lang.String target)
             throws MessengerException
bring up a web page in the browser

Parameters:
url - HTTP user to use in the browser
target - browser window
Throws:
MessengerException

setUserPreference

public void setUserPreference(java.lang.String prefix,
                              java.lang.String name,
                              java.lang.String value)
                       throws MessengerException
set a bean specific user preference. User preferences are persistant.

Parameters:
prefix - preference prefix specific to the extension
name - name option name
value - preference value
Throws:
MessengerException

getUserPreference

public java.lang.String getUserPreference(java.lang.String prefix,
                                          java.lang.String name,
                                          java.lang.String defaultValue)
                                   throws MessengerException
retrieve a bean specific user preference. User preferences are persistant.

Parameters:
prefix - preference prefix specific to the extension
name - name option name
defaultValue - default preference value returned if
Throws:
MessengerException

addMessageListener

public void addMessageListener(java.lang.String contentType,
                               MessengerMessageListener listener)
                        throws MessengerException
set a listener for a specific type of alert/notification message

Parameters:
contentType - message content-type for which this listener should be invoked
listener - message listener
Throws:
MessengerException

addMessageListener

public void addMessageListener(MessengerMessageListener listener)
                        throws MessengerException
set a listener for a specific type of alert/notification message

Parameters:
listener - message listener
Throws:
MessengerException

displayAlert

public void displayAlert(java.lang.String originator,
                         java.lang.String subject,
                         java.lang.String content)
display html alert


displayBotAlert

public void displayBotAlert(java.lang.String originator,
                            java.lang.String subject,
                            java.lang.String content)
Dispalys HTML alert. Call this method when you have messages from automated users who cannot interact, like calendar BOT. This will show an alert which will disable certain functionality from alerts.