Package com.atlassian.bitbucket.pull

Enum Class PullRequestAction

java.lang.Object

java.lang.Enum<PullRequestAction>

com.atlassian.bitbucket.pull.PullRequestAction

All Implemented Interfaces:

Serializable, Comparable<PullRequestAction>, Constable

public enum PullRequestAction
extends Enum<PullRequestAction>

Enumerates the actions which can be taken on a pull request, defining the activities that may occur. Each action may have an associated activity type.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPROVED	A user has approved a pull request Activity: PullRequestActivity Event: PullRequestParticipantApprovedEvent
AUTO_MERGE_CANCELLED	Auto-merge was cancelled on a pull request.
AUTO_MERGE_REQUESTED	Auto-merge was requested on a pull request.
COMMENTED	A comment has been added, deleted, edited or replied to on the pull request.
DECLINED	The pull request has been rejected and declined without merging.
DELETED	The pull request has been deleted.
MERGED	The pull request has been accepted and merged to the target.
OPENED	A new pull request has been opened.
REOPENED	A previously declined pull request has been reopened.
RESCOPED	The scope of the pull request has been changed and commits have been added or removed.
REVIEW_COMMENTED	A pending comment has been added or replied on the pull request.
REVIEW_DISCARDED	Discard a user's pull request review where pending comments were added to a pull request.
REVIEW_FINISHED	The pull request review where the user has added pending comments on a pull request is finished.
REVIEWED	A user has finished reviewing the changes in a pull request.
UNAPPROVED	A user has removed a approval from a pull request Activity: PullRequestActivity Event: PullRequestParticipantUnapprovedEvent
UPDATED	The details of the pull request, such as title or description, have been updated.

Method Summary

Modifier and Type	Method	Description
static PullRequestAction	fromId(int id)
int	getId()
static PullRequestAction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PullRequestAction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

APPROVED

public static final PullRequestAction APPROVED

A user has approved a pull request

• Activity: PullRequestActivity
• Event: PullRequestParticipantApprovedEvent

AUTO_MERGE_CANCELLED

public static final PullRequestAction AUTO_MERGE_CANCELLED

Auto-merge was cancelled on a pull request.

• Activity: PullRequestAutoMergeCancelledActivity
• Event: PullRequestAutoMergeCancelledEvent

Since:

8.13

AUTO_MERGE_REQUESTED

public static final PullRequestAction AUTO_MERGE_REQUESTED

Auto-merge was requested on a pull request.

• Activity: PullRequestActivity
• Event: PullRequestAutoMergeRequestedEvent

Since:

8.13

COMMENTED

public static final PullRequestAction COMMENTED

A comment has been added, deleted, edited or replied to on the pull request.

• Activity: PullRequestCommentActivity
• Events:
  • PullRequestCommentAddedEvent
  • PullRequestCommentDeletedEvent
  • PullRequestCommentEditedEvent
  • PullRequestCommentRepliedEvent

DECLINED

public static final PullRequestAction DECLINED

The pull request has been rejected and declined without merging.

• Activity: PullRequestActivity
• Event: PullRequestDeclinedEvent

DELETED

public static final PullRequestAction DELETED

The pull request has been deleted.

• Event: PullRequestDeletedEvent

Note: Since the pull request has been deleted, along with all of its activities and comments, this action will never be returned by an activity.

Since:

5.1

MERGED

public static final PullRequestAction MERGED

The pull request has been accepted and merged to the target.

• Activity: PullRequestMergeActivity
• Event: PullRequestMergedEvent

OPENED

public static final PullRequestAction OPENED

A new pull request has been opened.

• Activity: PullRequestActivity
• Events:
  • PullRequestOpenRequestedEvent
  • PullRequestOpenedEvent

REOPENED

public static final PullRequestAction REOPENED

A previously declined pull request has been reopened.

• Activity: PullRequestActivity
• Event: PullRequestReopenedEvent

RESCOPED

public static final PullRequestAction RESCOPED

The scope of the pull request has been changed and commits have been added or removed.

• Activity: PullRequestRescopeActivity
• Event: PullRequestRescopedEvent

REVIEW_COMMENTED

public static final PullRequestAction REVIEW_COMMENTED

A pending comment has been added or replied on the pull request. NOTE: This action does not create an activity item.

• Events:
  • PullRequestReviewCommentAddedEvent
  • PullRequestReviewCommentRepliedEvent

Since:

7.7

REVIEW_DISCARDED

public static final PullRequestAction REVIEW_DISCARDED

Discard a user's pull request review where pending comments were added to a pull request. NOTE: This action does not create an activity item.

• Event: PullRequestReviewDiscardedEvent

Since:

7.7

REVIEW_FINISHED

public static final PullRequestAction REVIEW_FINISHED

The pull request review where the user has added pending comments on a pull request is finished. NOTE: This action does not create an activity item.

• Event: PullRequestReviewFinishedEvent

Since:

7.7

REVIEWED

public static final PullRequestAction REVIEWED

A user has finished reviewing the changes in a pull request. They have provided feedback which needs to be addressed before they can approve. NOTE: This action does not create an activity item.

• Event: PullRequestParticipantReviewedEvent

Since:

4.4

UNAPPROVED

public static final PullRequestAction UNAPPROVED

A user has removed a approval from a pull request

• Activity: PullRequestActivity
• Event: PullRequestParticipantUnapprovedEvent

UPDATED

public static final PullRequestAction UPDATED

The details of the pull request, such as title or description, have been updated.

• Activity: PullRequestActivity
• Event: PullRequestUpdatedEvent

Method Details

values

public static PullRequestAction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PullRequestAction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromId

public static PullRequestAction fromId(int id)

getId

public int getId()