Package com.atlassian.bamboo.notification

Interface Notification

All Known Subinterfaces:
ExtendedNotification, Notification.HtmlImContentProvidingNotification
All Known Implementing Classes:
AbstractAccessTokenNotification, AbstractCompletedNotification, AbstractNotification, AbstractTrackingNotification, AccessTokenCreatedNotification, AccessTokenDeletedNotification, AfterXFailedNotification, BuildCompletedNotification, BuildErrorNotification, BuildHungNotification, BuildMissingCapableAgentNotification, BuildQueueTimeoutNotification, ChainCompletedNotification, CommentNotification, DeploymentFinishedNotification, DeploymentStartedNotification, RssNotification, StageCompletedNotification, UserResponsibilityAddedNotification, UserResponsibilityRemovedNotification
public interface Notification
Represents a Notification ready to be sent.

  • Method Details

    • getDescription

      @NotNull @NotNull String getDescription()
      Text describing this notification object - used for logging/debugging purposes.
      Returns:
      Notification's description

    • getTextEmailContent

      @Nullable @Nullable String getTextEmailContent() throws Exception
      Generates the text email content for the notifications
      Returns:
      Email content formatted as text for this notification
      Throws:
      Exception - if there is a problem preventing production of the e-mail content.

    • getHtmlEmailContent

      @Nullable @Nullable String getHtmlEmailContent() throws Exception
      Generates the html for the html part of an email notification.
      Returns:
      Email content formatted as HTML for this notification
      Throws:
      Exception - if there is a problem preventing production of the e-mail content.

    • applyDefaultCssStyles

      @ExperimentalApi boolean applyDefaultCssStyles()
      Determines if this notification HTML templates should be decorated with default CSS styles.
      Returns:
      true, if default styles should be applied and inlined, false otherwise
      See Also:

    • getEmailSubject

      @Nullable @Nullable String getEmailSubject() throws Exception
      Retrieves the subject for the notification.
      Returns:
      Email subject for this notification
      Throws:
      Exception - if there is a problem preventing production of the e-mail subject.

    • getIMContent

      @Nullable @Nullable String getIMContent()
      Retrieves the content for the IM notification
      Returns:
      IM message content for this notification

    • setEvent

      @Deprecated void setEvent(@Nullable @Nullable BambooEvent event)
      Deprecated.
      since 10.0
      Sets the event object that triggered this notification Before 10.0 this method received a com.atlassian.event.Event object. Now it receives BambooEvent.
      Parameters:
      event - Event object that triggered this notification

    • setEvent

      void setEvent(@Nullable @Nullable Object event)
      Sets the event object that triggered this notification
      Parameters:
      event - Event object that triggered this notification

    • getEvent

      @Nullable @Nullable BambooEvent getEvent()
      Retrieves the event object that triggered this notification. Before 10.0 this method returned a com.atlassian.event.Event object. Now it returns BambooEvent.
      Returns:
      Event object that triggered this notification
      Since:
      10.0

    • getPojoEvent

      @Nullable @Nullable Object getPojoEvent()
      Retrieves the event object that triggered this notification
      Returns:
      Event object that triggered this notification

    • getNotificationRecipients

      @NotNull @NotNull Set<NotificationRecipient> getNotificationRecipients()
      Returns the recipients of this Notification
      Returns:
      Set of notification recipients

    • getExcludedNotificationRecipients

      @NotNull @NotNull Set<NotificationRecipient> getExcludedNotificationRecipients()
      Returns the excluded recipients of this Notification
      Returns:
      Set of excluded notification recipients

    • setNotificationRecipients

      void setNotificationRecipients(@NotNull @NotNull Set<NotificationRecipient> recipients)
      Sets the recipients for this Notification
      Parameters:
      recipients - Set of notification recipients

    • setExcludedNotificationRecipients

      void setExcludedNotificationRecipients(@NotNull @NotNull Set<NotificationRecipient> recipients)
      Sets the excluded recipients for this Notification
      Parameters:
      recipients - Set of excluded notification recipients

    • addRecipient

      void addRecipient(@NotNull @NotNull NotificationRecipient recipient)
      Add a singular recipient to this notification
      Parameters:
      recipient - Recipient to be added to notification

    • excludeRecipient

      void excludeRecipient(@NotNull @NotNull NotificationRecipient recipient)
      Exclude a singular recipient from this notification. Recipient exclusion takes precedence over inclusion.
      Parameters:
      recipient - Recipient to be excluded from notification