com.atlassian.bitbucket.event.pull

Class PullRequestParticipantsUpdatedEvent

java.lang.Object

java.util.EventObject

com.atlassian.bitbucket.event.ApplicationEvent

com.atlassian.bitbucket.event.pull.PullRequestEvent

com.atlassian.bitbucket.event.pull.PullRequestParticipantsUpdatedEvent

All Implemented Interfaces:

Serializable

@AsynchronousPreferred
public class PullRequestParticipantsUpdatedEvent
extends PullRequestEvent

An event raised when the total set of reviewers and role-less participants for a pull request changes.

This may happen for any of the following reasons in isolation or in combination:

• A user is added as a reviewer for the first time. In this case they will appear in the Set returned from getAddedParticipants()
• A user who is neither a reviewer, author nor role-less participant gives their +1 to, posts a comment to or edits a pull request. In this case they will appear in the Set returned from getAddedParticipants()
• A reviewer is removed from the pull request and because, as reviewer, they never commented, edited or gave their approval they have been completely removed from the pull request. In this case they will appear in the Set returned from getRemovedParticipants()

  Note: if a reviewer posts a comment, gives their approval or edits a pull request then any subsequent operation to remove them as a reviewer would merely relegate them from a reviewer to a participant and this event will not be fired for that change.

This event is internally audited with CoverageLevel.BASE coverage level

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
PullRequestParticipantsUpdatedEvent(Object source, PullRequest pullRequest, Set<ApplicationUser> added, Set<ApplicationUser> removed)

Method Summary

Modifier and Type	Method and Description
Set<ApplicationUser>	getAddedParticipants()
Set<ApplicationUser>	getRemovedParticipants()

Methods inherited from class com.atlassian.bitbucket.event.pull.PullRequestEvent

getAction, getPullRequest

Methods inherited from class com.atlassian.bitbucket.event.ApplicationEvent

getDate, getUser

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PullRequestParticipantsUpdatedEvent

public PullRequestParticipantsUpdatedEvent(@Nonnull
                                           Object source,
                                           @Nonnull
                                           PullRequest pullRequest,
                                           @Nonnull
                                           Set<ApplicationUser> added,
                                           @Nonnull
                                           Set<ApplicationUser> removed)

Method Detail

getAddedParticipants

@Nonnull
public Set<ApplicationUser> getAddedParticipants()

Returns:

the set of users who have participated in the pull request for the first time

getRemovedParticipants

@Nonnull
public Set<ApplicationUser> getRemovedParticipants()

Returns:

the set of users who are no longer participating in the pull request