How to consume the notifications messages on the client in sdlweb8.5

Question

I am sending the notification messages to the client in component save event through below code.

            var message = new NotificationMessage
            {
                Action = "Save",
                SubjectIds = new[] { component.Id.ToString() },
                Details = string.Format("Component was updated by {0}", session.AccessToken.Title)
            };
            session.NotificationsManager.BroadcastNotification(message);

My question is how I can consume the above notifications using GUI using NotificationBroadCaster.js in below location, But It's not very detailed to understand and to make the changes to work.

If your GUI extension communicates with Content Manager, use the Notification Broadcaster (as found in the file %TRIDION_HOME%\web\WebUI\Core\Client\NotificationBroadcaster\NotificationBroadCaster.js) to catch these notifications

Can you please provide suggestions or solution on this.

Answer 1

How you hook into the push notifications on the client side is briefly outlined on the documentation page entitled "Notification framework".

To summarize, you create an event handler for all incoming push notifications:

var notificationHandler = function(evt) { console.log("Push event received! Details:", evt); }

And then you hook into the "notification" event on the aforementioned NotificationBroadcaster object:

var notificationBroadcaster = Tridion.Web.UI.Core.NotificationBroadcaster.getInstance();
notificationBroadcaster.addEventListener("notification", notificationHandler);

Now, as this will get called on every push event, you'll want to check the "data" properties of the "evt" argument to check that it is an event you want to handle. For example:

switch (evt.data.action)
{
   case "tcm:updated":
      // The default push notification for any save action
      break;
   case "Save":
      // Your new, custom save notification. You might want to prefix this one, by the way :)
      break;
}

As mentioned in the documentation and in my example above, there is already an event for the save of every item (action='tcm:updated'). But it doesn't include the name of the person who did the save, so if that is what you need you will indeed have to introduce your own notification.

Answer 2

Final logic Implemented and using below code for GUI Receiving notification.

Tridion.ContentManager.SDLWebResponder = function SDLWebResponder()
{   
    Tridion.OO.enableInterface(this, "Tridion.ContentManager.SDLWebResponder");
    this.addInterface("Tridion.MarshallableObject");
    this.addInterface("Tridion.InitializableObject");

    this.initialize();
};

Tridion.ContentManager.SDLWebResponder.IDENTIFIER = "tcm:SDLWebResponder";

Tridion.ContentManager.SDLWebResponder.prototype._initialize = function SDLWebResponder$_initialize()
{   
    Tridion.Web.UI.Core.NotificationBroadcaster.getInstance().addEventListener("notification", this.getDelegate(this.handleNotification));
};


// This method should include the necessary logic for processing notifications.
// For example, loading an item if it's in an existing list.

Tridion.ContentManager.SDLWebResponder.prototype.handleNotification = function SDLWebResponder$handleNotification(event)
{
    $messages.registerNotification("Notification", "SDLWebResponder handleNotification", true, false);
    var data = event.data;
};

if (!$models.getFromRepository(Tridion.ContentManager.SDLWebResponder.IDENTIFIER))
{
    $models.createInRepository(Tridion.ContentManager.SDLWebResponder.IDENTIFIER, "Tridion.ContentManager.SDLWebResponder");
};