Banners are messages that inform the user about system and app events. Banners are displayed prominently at the top or bottom of the Magnolia shell. They capture the user's attention effectively but do not interrupt what the user is currently working on. Banners are the only persistent message type. The user can safely close the banner and read the full message in the Pulse later.
Showing a banner message in app code
To show a banner message:
SubAppContextinto your class so that you can access the messaging convenience methods.
getSubAppContextinside your App or SubApp classes. If you extend the
BaseSubAppyou always have access to
- Create a new Message object. Pass the MessageType only if you want to do your own message types.
Showing a banner message to a named user
AppContext provides convenience methods for sending messages. The user will be notified instantly with a popup if they are currently signed in. In any case, the message is stored in the Pulse as unread.
Showing a banner message to all users in a group
The users in the group will be notified instantly with a popup if they are currently signed in. In any case, the message is stored in the Pulse as unread.
Showing a banner message to the current user
The following code snippet does the same as
Broadcast a banner message to all users
The users will be notified instantly with a popup if they are currently signed in. In any case, the message will be stored in the Pulse as unread.
See MessagesMainSubapp.java for examples.
Showing a banner message using the Messages app
The Messages app is a tool that allows you to send messages to individual users, groups or all users. You can find the app in the Dev group. The Dev group is only available to the
superuser role by default, as configured in app launcher permissions.
The sent message is displayed in the Pulse.