The 5.7 branch of Magnolia reached End-of-Life on December 31, 2023, as specified in our End-of-life policy. This means the 5.7 branch is no longer maintained or supported. Please upgrade to the latest Magnolia release. By upgrading, you will get the latest release of Magnolia featuring significant improvements to the author and developer experience. For a successful upgrade, please consult our Magnolia 6.2 documentation. If you need help, please contact info@magnolia-cms.com.
A message view defines how a message is displayed in the Pulse and what users can do with the message. Magnolia's default
message view can display any system messages and allows the user to delete them. For a more advanced example, see the workflow
message view in /modules/workflow/messageViews/workflow
.
Definition
Here's how the default
message view is defined in /modules/ui-admincentral/messageViews/default
. Copy or extend it as a starting point for your own view.
actions: delete: icon: icon-delete class: info.magnolia.ui.admincentral.shellapp.pulse.message.action.DeleteMessageActionDefinition form: tabs: - name: message fields: - name: sender fieldType: text - name: message rows: 7 fieldType: text actionbar: defaultAction: delete sections: - name: messageActions groups: - name: deleteActions items: - name: delete
Node name | Value |
---|---|
modules | |
ui-admincentral | |
messageViews | |
default | |
actions | |
delete | |
class | info.magnolia.ui.admincentral.shellapp.pulse.message.action.DeleteMessageActionDefinition |
icon | icon-delete |
form | |
tabs | |
message | |
fields | |
sender | |
fieldType | text |
message | |
class | text |
rows | 7 |
actionbar | |
sections | |
messageActions | |
groups | |
deleteActions | |
items | |
delete | |
defaultAction | delete |
Nodes:
<view name> | required Name of view. |
| required An action definition that defines what actions the user can perform on the message. For example, a user can approve or reject a published page. |
| required A form definition that defines what message details are displayed in the view, such as the sender and the subject. The form fields are rendered as static text in the message view, not as fillable fields. |
| required An action bar definition that references actions defined in the message view or somewhere else. The action bar is displayed on side of the message view. |
Here is what a message looks like the default
view.
Using a view in code
To use your custom message view in code, set the view on the
private sendMessageWithCustomView(String messageText) { final Message message = new Message(); message.setMessage(messageText); message.setType(MessageType.INFO); // format when referencing a view // module-name:view-name (as defined in the configuration) message.setView("ui-admincentral:myCustomView"); messagesManager.sendLocalMessage(message); }