Package com.intellij.openapi.externalSystem.service.notification

Class ExternalSystemNotificationManager

java.lang.Object

com.intellij.openapi.externalSystem.service.notification.ExternalSystemNotificationManager

All Implemented Interfaces:

Disposable

public class ExternalSystemNotificationManager
extends java.lang.Object
implements Disposable

ExternalSystemNotificationManager provides creation and managements of user-friendly notifications for external system integration-specific events.

One example use-case is a situation when an error occurs during external project refresh. We need to show corresponding message to the end-user.

Thread-safe.

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Constructor Summary

Constructors

Constructor and Description
ExternalSystemNotificationManager(Project project)

Method Summary

Modifier and Type	Method and Description
void	clearNotifications(NotificationSource notificationSource, ProjectSystemId externalSystemId) Deprecated.
void	clearNotifications(java.lang.String groupName, NotificationSource notificationSource, ProjectSystemId externalSystemId) Deprecated.
NotificationData	createNotification(java.lang.String title, java.lang.Throwable error, ProjectSystemId externalSystemId, Project project, DataProvider dataProvider) Create NotificationData for error happened during the external system invocation which can be shown to the end user.
void	dispose() Usually not invoked directly, see class javadoc.
static java.lang.String	getContentDisplayName(NotificationSource notificationSource, ProjectSystemId externalSystemId) Deprecated.
static ExternalSystemNotificationManager	getInstance(Project project)
boolean	isNotificationActive(Key<java.lang.String> notificationKey)
NewErrorTreeViewPanel	prepareMessagesView(ProjectSystemId externalSystemId, NotificationSource notificationSource, boolean activateView) Deprecated.
void	showNotification(ProjectSystemId externalSystemId, NotificationData notificationData)
void	showNotification(ProjectSystemId externalSystemId, NotificationData notificationData, Key<java.lang.String> notificationKey)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExternalSystemNotificationManager

public ExternalSystemNotificationManager(Project project)

Method Detail

getInstance

public static ExternalSystemNotificationManager getInstance(Project project)

createNotification

public NotificationData createNotification(java.lang.String title,
                                           java.lang.Throwable error,
                                           ProjectSystemId externalSystemId,
                                           Project project,
                                           DataProvider dataProvider)

Create NotificationData for error happened during the external system invocation which can be shown to the end user.

Returns:

NotificationData or null for not user-friendly errors.

isNotificationActive

public boolean isNotificationActive(Key<java.lang.String> notificationKey)

showNotification

public void showNotification(ProjectSystemId externalSystemId,
                             NotificationData notificationData)

showNotification

public void showNotification(ProjectSystemId externalSystemId,
                             NotificationData notificationData,
                             Key<java.lang.String> notificationKey)

clearNotifications

@Deprecated
public void clearNotifications(NotificationSource notificationSource,
                               ProjectSystemId externalSystemId)

Deprecated.

clearNotifications

@Deprecated
public void clearNotifications(java.lang.String groupName,
                               NotificationSource notificationSource,
                               ProjectSystemId externalSystemId)

Deprecated.

prepareMessagesView

@Deprecated
public NewErrorTreeViewPanel prepareMessagesView(ProjectSystemId externalSystemId,
                                                 NotificationSource notificationSource,
                                                 boolean activateView)

Deprecated.

getContentDisplayName

@Deprecated
public static java.lang.String getContentDisplayName(NotificationSource notificationSource,
                                                     ProjectSystemId externalSystemId)

Deprecated.

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable