public interface

CustomPullRequestNotificationRenderer

com.atlassian.bitbucket.notification.custom.pull.CustomPullRequestNotificationRenderer

Class Overview

Renders a custom pull request notification.

See Also

Summary

Public Methods
@Nonnull String getId()
@Nonnull Map<ApplicationUser, Collection<CustomNotificationSection>> render(PullRequest pullRequest, Map<ApplicationUser, Collection<CustomNotificationData>> userData)
Render a notification for the specified users and notification data.

Public Methods

@Nonnull public String getId ()

Returns
  • ID that is used to uniquely identify this renderer

@Nonnull public Map<ApplicationUser, Collection<CustomNotificationSection>> render (PullRequest pullRequest, Map<ApplicationUser, Collection<CustomNotificationData>> userData)

Render a notification for the specified users and notification data.

Parameters
pullRequest the pull request that the notifications are about
userData a map from recipients to the notification data that were stored in this batch
Returns
  • a map from recipient to the rendered items. Note that the implementation is free to return as many items as it likes, condensing or even dropping items.