Uploaded image for project: 'Magnolia UI'
  1. Magnolia UI
  2. MGNLUI-2066

Messaging method names and Javadoc unclear

    XMLWordPrintable

Details

    • Bug
    • Resolution: Obsolete
    • Neutral
    • None
    • 5.1
    • app framework
    • None

    Description

      1) Shell and AbstractUIContext have two methods with almost the same name:

      • info.magnolia.ui.api.shell
        • showNotification(String message)
      • info.magnolia.ui.framework.context.AbstractUIContext
        • openNotification

      It is unclear what the difference between "opening" and "showing" a notification is. Please rename the methods so that they match the actual message type they display.

      2) Javadoc for the openNotification methods is confusing. The description mixes up notifications and banners.

      info.magnolia.ui.framework.context.AbstractUIContext

      • openNotification(MessageStyleType type, boolean doesTimeout, String title)
        • Notification indicator is a message banner that only shows a message to user.
      • openNotification(MessageStyleType type, boolean doesTimeout, String title, String linkText, NotificationCallback cb)
        • Notification indicator is a message banner that only shows a message to user.
      • openNotification(MessageStyleType type, boolean doesTimeout, View viewToShow)
        • Notification indicator is a message banner that only shows a message to user.

      A notification is not a banner. Notification is transient box, like a Post-IT note, that shows the message and then goes away in 3s automatically. See Showing notifications as notes.

      A banner is a persistent, viewport-wide banner that must be clicked to close. The message is stored and viewable in the Pulse. See Showing system and app messages using banners.

      Please correct the Javadoc.

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

              Unassigned Unassigned
              ahietala Antti Hietala
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Checklists

                  Bug DoR
                  Task DoD