com.brightech.mb.workflow.js

Class JSNotificationManager

java.lang.Object

org.mozilla.javascript.ScriptableObject

com.brightech.xmp.js.MBScriptableObject

com.brightech.xmp.js.ReleasableScriptableObject

com.brightech.mb.workflow.js.JSBaseScriptableObject

com.brightech.mb.workflow.js.JSNotificationManager

All Implemented Interfaces:

java.io.Serializable, org.mozilla.javascript.ConstProperties, org.mozilla.javascript.ContextFactory.Listener, org.mozilla.javascript.debug.DebuggableObject, org.mozilla.javascript.Scriptable

public class JSNotificationManager
extends JSBaseScriptableObject

User: Nate Solas Manage client-side notifications: progress bars, system notifications / actions. Is available in workflow context pre-initialized as "notificationManager"

See Also:

Serialized Form

Field Summary

Fields inherited from class org.mozilla.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.mozilla.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
JSNotificationManager()

Method Summary

Modifier and Type	Method and Description
int	(JavaScript Function) getCurrentPercent(int theUserId, java.lang.String theProgressBarId) Get the percent for a known progress ID for a user.
void	(JavaScript Function) publishSystemAction(int theUserId, java.lang.Object theActionMap) Post a system action
void	(JavaScript Function) publishSystemMessage(int theUserId, java.lang.String theMessage) Post a system message that will show on a logged-in user's screen.
void	(JavaScript Function) updateStatus(int theUserId, java.lang.String theProgressBarId, java.lang.String theMessage, int thePercent, java.lang.String theTitle) Create or update a progress bar for a user.

Methods inherited from class org.mozilla.javascript.ScriptableObject

associateValue, avoidObjectDetection, callMethod, callMethod, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasInstance, hasProperty, hasProperty, isConst, isEmpty, isExtensible, isSealed, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mozilla.javascript.ContextFactory.Listener

contextCreated, contextReleased

Constructor Detail

JSNotificationManager

public JSNotificationManager()

Method Detail

(JavaScript Function) updateStatus

public void (JavaScript Function) updateStatus(int theUserId,
                                    java.lang.String theProgressBarId,
                                    java.lang.String theMessage,
                                    int thePercent,
                                    java.lang.String theTitle)

Create or update a progress bar for a user. Obviously the user must be logged in to see the bar in the UI.

Parameters:

theUserId - User ID this progress bar is for.

theProgressBarId - Unique progress ID for this user.

theMessage - Message for this update, may be null.

thePercent - What percent should the bar show, from 1 to 100?

theTitle - Title of the progress bar, required if creating.

(JavaScript Function) getCurrentPercent

public int (JavaScript Function) getCurrentPercent(int theUserId,
                                        java.lang.String theProgressBarId)

Get the percent for a known progress ID for a user.

Parameters:

theUserId - Whose progress bar?

theProgressBarId - The id of the bar we're looking for.

Returns:

the percent of the bar from 1 to 100, and 0 if not found.

(JavaScript Function) publishSystemMessage

public void (JavaScript Function) publishSystemMessage(int theUserId,
                                            java.lang.String theMessage)

Post a system message that will show on a logged-in user's screen. Note: system messages will persist on screen until the percent is set to 100, so save this ID.

Parameters:

theUserId - who's it for? -2 for all users.

theMessage - What's it say?

(JavaScript Function) publishSystemAction

public void (JavaScript Function) publishSystemAction(int theUserId,
                                           java.lang.Object theActionMap)

Post a system action

Parameters:

theUserId - who's it for? -2 for all users.

theActionMap - map of keys and values to pass to client-side event, including special "action" key