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, org.mozilla.javascript.SymbolScriptable

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

Nested Class Summary

Nested classes/interfaces inherited from class org.mozilla.javascript.ScriptableObject

org.mozilla.javascript.ScriptableObject.KeyComparator

Field Summary

Fields inherited from class com.brightech.xmp.js.ReleasableScriptableObject

myLogger

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
void	jsFunction_createGlobalStickyNotification(int theEventSourceUser, java.lang.String theMessage, boolean theWarning, java.lang.String theUrlToOpen, java.lang.String theWindowTarget) Create a text notification to be displayed in a at the top of all user's notification's bell at the top right of the interface Example: notificationManager.createGlobalStickyNotification(1, "Test Global Messages", true, "https://www.google.com/", "_blank");
void	jsFunction_createNotification(java.lang.String theResolverUrl, int theUserToAlert, int theEventSourceUser, java.lang.String theMessage, java.lang.String theUrlToOpen, java.lang.String theWindowTarget) Create a notification to be displayed in a user's notification's bell at the top right of the interface Example: notificationManager.createNotification(resolverManager.assetsURLFromAssetIds([201659053, 201659056]), 1, 3, "Test Asset Messages", null, null); Example 2: notificationManager.createNotification(null, 1, 3, "Test System Message", "https://www.google.com/", "_blank");
void	jsFunction_createStickyNotification(int theUserToAlert, int theEventSourceUser, java.lang.String theMessage, boolean theWarning, java.lang.String theUrlToOpen, java.lang.String theWindowTarget) Create a text notification to be displayed in a at the top of a user's notification's bell at the top right of the interface Example: notificationManager.createStickyNotification(1, 3, "Test Sticky Messages", true, "https://www.google.com/", "_blank");
int	jsFunction_getCurrentPercent(int theUserId, java.lang.String theProgressBarId) Get the percent for a known progress ID for a user.
java.lang.String[]	jsFunction_getSubscribedAlerts(int theAssetId, int theUserId) Returns the list of subscribed Alerts for the specified user and asset.
AssetSubscription[]	jsFunction_getSubscriptions() Gets all asset subscriptions.
java.lang.String	jsFunction_publishSystemAction(int theUserId, java.lang.Object theActionMap) Post a system action.
java.lang.String	jsFunction_publishSystemMessage(int theUserId, java.lang.String theMessage) Post a system message that will show on a logged-in user's screen.
void	jsFunction_subscribe(java.lang.String theResolverUrl, int theUserId) Subscribe a user to a particular set of assets for all subscribable Alerts.
void	jsFunction_subscribeAlerts(java.lang.String theResolverUrl, int theUserId, org.mozilla.javascript.NativeArray theAlerts) Subscribes a user to a particular set of assets, for the specified Alerts.
void	jsFunction_unsubscribe(java.lang.String theResolverUrl, int theUserId) Unsubscribe a user to a particular set of assets
void	jsFunction_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.
int	jsGet_kCompletePercent() The percent (100%) that signifies the notification/progress is complete.
java.lang.String	jsGet_kSystemMessageTitle() Title to use when updating status for a system message.
int	jsGet_kSystemMessageUserId() User id to use when posting a system message for all users.

Methods inherited from class org.mozilla.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, equivalentValues, get, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassName, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, has, hasInstance, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

jsGet_kCompletePercent

public int jsGet_kCompletePercent()

The percent (100%) that signifies the notification/progress is complete.

Returns:

the percent.

jsGet_kSystemMessageUserId

public int jsGet_kSystemMessageUserId()

User id to use when posting a system message for all users. (Value is -2.)

Returns:

the user id.

jsGet_kSystemMessageTitle

public java.lang.String jsGet_kSystemMessageTitle()

Title to use when updating status for a system message.

Returns:

the title.

jsFunction_updateStatus

public void jsFunction_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.

jsFunction_getCurrentPercent

public int jsFunction_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.

jsFunction_publishSystemMessage

public java.lang.String jsFunction_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 the progress bar id.

Parameters:

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

theMessage - What's it say?

Returns:

the progress bar id of the published message.

See Also:

JSNotificationManager.jsGet_kSystemMessageUserId(), JSNotificationManager.jsGet_kSystemMessageTitle()

jsFunction_publishSystemAction

public java.lang.String jsFunction_publishSystemAction(int theUserId,
                                                       java.lang.Object theActionMap)

Post a system action. Note: System messages will persist on screen until the percent is set to 100, so save the progress bar id.

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

Returns:

the progress bar id of the published message, or null if there is an error.

See Also:

JSNotificationManager.jsGet_kSystemMessageUserId(), JSNotificationManager.jsGet_kSystemMessageTitle()

jsFunction_getSubscriptions

public AssetSubscription[] jsFunction_getSubscriptions()

Gets all asset subscriptions.

jsFunction_subscribe

public void jsFunction_subscribe(java.lang.String theResolverUrl,
                                 int theUserId)

Subscribe a user to a particular set of assets for all subscribable Alerts.

Parameters:

theResolverUrl - see ResolverManager

theUserId - the user id to subscribe with

jsFunction_subscribeAlerts

public void jsFunction_subscribeAlerts(java.lang.String theResolverUrl,
                                       int theUserId,
                                       org.mozilla.javascript.NativeArray theAlerts)

Subscribes a user to a particular set of assets, for the specified Alerts. Subscribable Alerts are: - Custom - Discussion - Download - Edit - Version

Parameters:

theResolverUrl - see ResolverManager.

theUserId - the user id to subscribe with.

theAlerts - array of Alerts to subscribe to. Null/empty signifies unsubscribe from all Alerts.

jsFunction_getSubscribedAlerts

public java.lang.String[] jsFunction_getSubscribedAlerts(int theAssetId,
                                                         int theUserId)

Returns the list of subscribed Alerts for the specified user and asset. Returns null if the user is not subscribed to any Alerts for this asset. Subscribable Alerts are: - Custom - Discussion - Download - Edit - Version

Parameters:

theAssetId - asset id to check

theUserId - user to check for

Returns:

the list of subscribed Alerts.

jsFunction_unsubscribe

public void jsFunction_unsubscribe(java.lang.String theResolverUrl,
                                   int theUserId)

Unsubscribe a user to a particular set of assets

Parameters:

theResolverUrl - see ResolverManager

theUserId - the user id to subscribe with

jsFunction_createNotification

public void jsFunction_createNotification(java.lang.String theResolverUrl,
                                          int theUserToAlert,
                                          int theEventSourceUser,
                                          java.lang.String theMessage,
                                          java.lang.String theUrlToOpen,
                                          java.lang.String theWindowTarget)

Create a notification to be displayed in a user's notification's bell at the top right of the interface Example: notificationManager.createNotification(resolverManager.assetsURLFromAssetIds([201659053, 201659056]), 1, 3, "Test Asset Messages", null, null); Example 2: notificationManager.createNotification(null, 1, 3, "Test System Message", "https://www.google.com/", "_blank");

Parameters:

theResolverUrl - resolver url to describe which asset the notification is associated with

theUserToAlert - the user id of whom should see the notification, -1 for global notification

theEventSourceUser - the user id who generated the event

theMessage - the message to display to the user

theUrlToOpen - the url to open when the notification is clicked. Leave empty or null to use the resolver to determine the click action

theWindowTarget - Specifies the target attribute or the name of the window. _blank, _parent, _self, or _top

jsFunction_createStickyNotification

public void jsFunction_createStickyNotification(int theUserToAlert,
                                                int theEventSourceUser,
                                                java.lang.String theMessage,
                                                boolean theWarning,
                                                java.lang.String theUrlToOpen,
                                                java.lang.String theWindowTarget)

Create a text notification to be displayed in a at the top of a user's notification's bell at the top right of the interface Example: notificationManager.createStickyNotification(1, 3, "Test Sticky Messages", true, "https://www.google.com/", "_blank");

Parameters:

theEventSourceUser - the user id who generated the event

theUserToAlert - the user id of whom should see the notification, -1 for global notification

theMessage - the message to display to the user

theWarning - true to display message as warning

theUrlToOpen - the url to open when the notification is clicked. Leave empty do do nothing on click

theWindowTarget - Specifies the target attribute or the name of the window. _blank, _parent, _self, or _top

jsFunction_createGlobalStickyNotification

public void jsFunction_createGlobalStickyNotification(int theEventSourceUser,
                                                      java.lang.String theMessage,
                                                      boolean theWarning,
                                                      java.lang.String theUrlToOpen,
                                                      java.lang.String theWindowTarget)

Create a text notification to be displayed in a at the top of all user's notification's bell at the top right of the interface Example: notificationManager.createGlobalStickyNotification(1, "Test Global Messages", true, "https://www.google.com/", "_blank");

Parameters:

theEventSourceUser - the user id who generated the event

theMessage - the message to display to the user

theWarning - true to display message as warning

theUrlToOpen - the url to open when the notification is clicked. Leave empty to do nothing on click

theWindowTarget - Specifies the target attribute or the name of the window. _blank, _parent, _self, or _top