public class

PullRequestActivitySearchRequest

extends AbstractPullRequestRequest
java.lang.Object
   ↳ com.atlassian.stash.pull.AbstractPullRequestRequest
     ↳ com.atlassian.stash.pull.PullRequestActivitySearchRequest

Class Overview

Request for searching for pull requests' activities.

See Also

Summary

Nested Classes
class PullRequestActivitySearchRequest.Builder  
Public Methods
@Nonnull Set<CommentAction> getCommentActions()
Limits the comment activities to the ones performing the specified comment actions.
@Nonnull Set<Long> getCommentIds()
Limits the comment activities to the ones affecting the specified comments.
@Nonnull Set<PullRequestActivityType> getTypes()
Specifies the type(s) of activities to search for.
boolean isWithProperties()
@Deprecated boolean isWithPullRequestAttributes()
This method is deprecated. in 3.4 for removal in 4.0, in favour of properties.
[Expand]
Inherited Methods
From class com.atlassian.stash.pull.AbstractPullRequestRequest
From class java.lang.Object

Public Methods

@Nonnull public Set<CommentAction> getCommentActions ()

Limits the comment activities to the ones performing the specified comment actions.

Note: this is only valid if the searched types include comment activities.

Returns
  • comment actions the comment activities must perform (can be empty)

@Nonnull public Set<Long> getCommentIds ()

Limits the comment activities to the ones affecting the specified comments.

Note: this is only valid if the searched types include comment activities.

Returns
  • the IDs of the comments the comment activities affect (can be empty)

@Nonnull public Set<PullRequestActivityType> getTypes ()

Specifies the type(s) of activities to search for.

Returns
  • the types of activities to retrieve (can be empty)
See Also

public boolean isWithProperties ()

Returns
  • true to fetch the pull requests' properties

@Deprecated public boolean isWithPullRequestAttributes ()

This method is deprecated.
in 3.4 for removal in 4.0, in favour of properties.

Specifies whether the attributes of the activities' pull requests should also be fetched.

Returns
  • true to fetch the pull requests' attributes