Namespace sap.m.MessageBoxModule: sap/m/MessageBox

Displays an alert dialog with the given message and an OK button (no icons).

sap.m.MessageBox.alert("This message should appear in the alert", {
    title: "Alert",                                      // default
    onClose: null,                                       // default
    styleClass: ""                                       // default
    initialFocus: null                                   // default
    textDirection: sap.ui.core.TextDirection.Inherit     // default
});

If a callback is given, it is called after the alert dialog has been closed by the user via the OK button. The callback is called with the following signature:

  function (oAction)

where oAction can be either sap.m.MessageBox.Action.OK when the alert dialog is closed by tapping on the OK button or null when the alert dialog is closed by calling sap.m.InstanceManager.closeAllDialogs().

The alert dialog opened by this method is processed asynchronously. Applications have to use fnCallback to continue work after the user closed the alert dialog.

Displays a confirmation dialog with the given message, a QUESTION icon, an OK button and a Cancel button. If a callback is given, it is called after the confirmation box has been closed by the user with one of the buttons.

sap.m.MessageBox.confirm("This message should appear in the confirmation", {
    title: "Confirm",                                    // default
    onClose: null                                        // default
    styleClass: ""                                       // default
    initialFocus: null                                   // default
    textDirection: sap.ui.core.TextDirection.Inherit     // default
    });

The callback is called with the following signature

  function(oAction)

where oAction is set by one of the following three values: 1. sap.m.MessageBox.Action.OK: OK (confirmed) button is tapped. 2. sap.m.MessageBox.Action.Cancel: Cancel (unconfirmed) button is tapped. 3. null: Confirm dialog is closed by calling sap.m.InstanceManager.closeAllDialogs()

The confirmation dialog opened by this method is processed asynchronously. Applications have to use fnCallback to continue work after the user closed the confirmation dialog

Displays an error dialog with the given message, an ERROR icon, a CLOSE button.. If a callback is given, it is called after the error box has been closed by the user with one of the buttons.

sap.m.MessageBox.error("This message should appear in the error message box", {
    title: "Error",                                      // default
    onClose: null                                        // default
    styleClass: ""                                       // default
    initialFocus: null                                   // default
    textDirection: sap.ui.core.TextDirection.Inherit     // default
    });

The callback is called with the following signature

  function (oAction)

The error dialog opened by this method is processed asynchronously. Applications have to use fnCallback to continue work after the user closed the error dialog.

Displays an information dialog with the given message, an INFO icon, an OK button. If a callback is given, it is called after the info box has been closed by the user with one of the buttons.

sap.m.MessageBox.information("This message should appear in the information message box", {
    title: "Information",                                // default
    onClose: null                                        // default
    styleClass: ""                                       // default
    initialFocus: null                                   // default
    textDirection: sap.ui.core.TextDirection.Inherit     // default
    });

The callback is called with the following signature *

  function (oAction)

The information dialog opened by this method is processed asynchronously. Applications have to use fnCallback to continue work after the user closed the information dialog

Creates and displays a sap.m.Dialog with type sap.m.DialogType.Message with the given text and buttons, and optionally other parts. After the user has tapped a button, the onClose function is invoked when given.

The only mandatory parameter is vMessage. Either a string with the corresponding text or even a layout control could be provided.

sap.m.MessageBox.show("This message should appear in the message box", {
    icon: sap.m.MessageBox.Icon.NONE,                    // default
    title: "",                                           // default
    actions: sap.m.MessageBox.Action.OK                  // default
    onClose: null                                        // default
    styleClass: ""                                       // default
    initialFocus: null                                   // default
    textDirection: sap.ui.core.TextDirection.Inherit     // default
});

The created dialog is executed asynchronously. When it has been created and registered for rendering, this function returns without waiting for a user reaction.

When applications have to react on the users choice, they have to provide a callback function and postpone any reaction on the user choice until that callback is triggered.

The signature of the callback is

function (oAction);

where oAction is the button that the user has tapped. For example, when the user has pressed the close button, a sap.m.MessageBox.Action.Close is returned.

Displays a success dialog with the given message, a SUCCESS icon, an OK button. If a callback is given, it is called after the success box has been closed by the user with one of the buttons.

sap.m.MessageBox.success("This message should appear in the success message box", {
    title: "Success",                                    // default
    onClose: null                                        // default
    styleClass: ""                                       // default
    initialFocus: null                                   // default
    textDirection: sap.ui.core.TextDirection.Inherit     // default
    });

The callback is called with the following signature

  function(oAction)

The success dialog opened by this method is processed asynchronously. Applications have to use fnCallback to continue work after the user closed the success dialog

Displays a warning dialog with the given message, a WARNING icon, an OK button. If a callback is given, it is called after the warning box has been closed by the user with one of the buttons.

sap.m.MessageBox.warning("This message should appear in the warning message box", {
    title: "Warning",                                    // default
    onClose: null                                        // default
    styleClass: ""                                       // default
    initialFocus: null                                   // default
    textDirection: sap.ui.core.TextDirection.Inherit     // default
    });

The callback is called with the following signature *

  function (oAction)

The warning dialog opened by this method is processed asynchronously. Applications have to use fnCallback to continue work after the user closed the warning dialog