Package com.hybris.backoffice.widgets.notificationarea

Interface NotificationService

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 
      Modifier and Type Method Description
      void clearNotifications​(java.lang.String source)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sends clear event which will remove all notifications from specified source.
      void clearNotifications​(java.lang.String source, NotificationEvent.Level level)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sends clear event which will remove all notifications from specified source of specified importance level.
      java.lang.String getWidgetNotificationSource​(ActionContext<?> context)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets default source for each notification sent by specified action.
      java.lang.String getWidgetNotificationSource​(WidgetInstanceManager widgetInstanceManager)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Gets default source for each notification sent by specified widget.
      default void notifyUser​(ActionContext<?> context, java.lang.String eventType, NotificationEvent.Level level, java.lang.Object... referenceObjects)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sends a notification to end user.
      default void notifyUser​(WidgetInstanceManager widgetInstanceManager, java.lang.String eventType, NotificationEvent.Level level, java.lang.Object... referenceObjects)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sends a notification to end user.
      void notifyUser​(java.lang.String source, java.lang.String eventType, NotificationEvent.Level level, java.lang.Object... referenceObjects)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sends a notification to end user.

    • Method Detail

      • notifyUser

        void notifyUser​(java.lang.String source,
                java.lang.String eventType,
                NotificationEvent.Level level,
                java.lang.Object... referenceObjects)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Sends a notification to end user.
        Parameters:
        source - identity of notification source.
        eventType - type of notification to be sent NotificationEventTypes.
        level - importance level of notification.
        referenceObjects - optional array of objects that are related to event.

      • clearNotifications

        void clearNotifications​(java.lang.String source)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Sends clear event which will remove all notifications from specified source.
        Parameters:
        source - identity of notification source.

      • clearNotifications

        void clearNotifications​(java.lang.String source,
                        NotificationEvent.Level level)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Sends clear event which will remove all notifications from specified source of specified importance level.
        Parameters:
        source - identity of notification source.
        level - importance level of notifications to be removed.

      • getWidgetNotificationSource

        java.lang.String getWidgetNotificationSource​(WidgetInstanceManager widgetInstanceManager)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Gets default source for each notification sent by specified widget.
        Parameters:
        widgetInstanceManager - instance manager of a widget which sends notification.
        Returns:
        source name for notification.

      • notifyUser

        default void notifyUser​(WidgetInstanceManager widgetInstanceManager,
                        java.lang.String eventType,
                        NotificationEvent.Level level,
                        java.lang.Object... referenceObjects)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Sends a notification to end user.
        Parameters:
        widgetInstanceManager - instance manager of a widget which sends notification.
        eventType - type of notification to be sent NotificationEventTypes.
        level - importance level of notification.
        referenceObjects - optional array of objects that are related to event.
        See Also:
        getWidgetNotificationSource(WidgetInstanceManager)

      • getWidgetNotificationSource

        java.lang.String getWidgetNotificationSource​(ActionContext<?> context)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Gets default source for each notification sent by specified action.
        Parameters:
        context - action context.
        Returns:
        source name for notification.

      • notifyUser

        default void notifyUser​(ActionContext<?> context,
                        java.lang.String eventType,
                        NotificationEvent.Level level,
                        java.lang.Object... referenceObjects)
        Deprecated, for removal: This API element is subject to removal in a future version.
        Sends a notification to end user.
        Parameters:
        context - action context.
        eventType - type of notification to be sent NotificationEventTypes.
        level - importance level of notification.
        referenceObjects - optional array of objects that are related to event.
        See Also:
        getWidgetNotificationSource(ActionContext)