Skip to content

adding-custom-messages-5a9a2a0.md

Latest commit

 

History

History
52 lines (35 loc) · 3.05 KB

adding-custom-messages-5a9a2a0.md

File metadata and controls

52 lines (35 loc) · 3.05 KB

Adding Custom Messages

You can use the securedExecution method from the API for developers of template extensions to add and display custom messages.

This concept for message handling is based on the SAPUI5 Messaging. For more information, see the API Reference for Messaging.

SAP Fiori elements provides the securedExecution method that starts a 'busy session'.

When a busy session starts, all transition messages are removed automatically, since the system assumes that they belong to previous user interaction.

When the busy session ends, all transition messages that have been collected by the Messaging are automatically displayed to the user in a well-defined way, based on the severity of the message. This applies to (transition) messages that have been pushed into the Messaging automatically (for example, because they come from the OData model), and also to transition messages that are pushed to the Messaging explicitly by way of application coding.

Sample Code:

securedExecution: function(oContext, aSelectedContexts) {
   this.editFlow.securedExecution( 
      function() { 
>          // "Messaging" required from module "sap/ui/core/Messaging"
>          // "Message" required from module "sap/ui/core/message/Message"
>          Messaging.addMessages(new Message({
>             message: "Server says hello", 
>             target: "", 
>             persistent: true, 
>             type: sap.ui.core.MessageType.Success, 
>             code: "123" 
>          }));
      } 
   ); 
},

The sample code shows that a message is created as a transition message by setting the attribute persistent to true. This attribute describes the lifetime of this message from the perspective of the SAPUI5 Messaging. The lifecycle of transition messages is not relevant to the Messaging. This means that they are persisted until another agent deletes them from the Messaging. The SAP Fiori elements framework triggers the deletions, which effectively limits the lifetime of these messages.

Note:

Both a code and a target are mandatory. If a target doesn't exist, you must provide an empty string.

For more information about the securedExecution method, see Using the SecuredExecution Method and the API Reference for securedExecution.

For general information about messages, see Using Messages.

Note:

For information about SAP Fiori elements for OData V2, see Adding Custom Messages.

Related Information

Using the SecuredExecution Method

Using Messages