PullRequests

Value Members

1. final def !=(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

2. final def !=(arg0: Any): Boolean

   Definition Classes

   Any

3. final def ##(): Int

   Definition Classes

   AnyRef → Any

4. final def ==(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

5. final def ==(arg0: Any): Boolean

   Definition Classes

   Any

6. final def asInstanceOf[T0]: T0

   Definition Classes

   Any

7. def clone(): AnyRef

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

8. def create(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, newPullRequest: NewPullRequest, head: String, base: String, maintainerCanModify: Option[Boolean] = Some(true)): M[GHResponse[PullRequest]]

   Create a pull request

   Create a pull request

   accessToken

   Token to identify the authenticated user

   headers

   Optional user headers to include in the request

   owner

   Owner of the repo

   repo

   Name of the repo

   newPullRequest

   The title and body parameters or the issue parameter

   head

   The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

   base

   The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that

   maintainerCanModify

   Indicates whether maintainers can modify the pull request, Default:Some(true).

9. final def eq(arg0: AnyRef): Boolean

   Definition Classes

   AnyRef

10. def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

11. def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

12. def get(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, number: Int): M[GHResponse[PullRequest]]

    Get a single pull request for a repository

    Get a single pull request for a repository

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    owner

    of the repo

    repo

    name of the repo

    number

    of the pull request

    returns

    a GHResponse with the pull request.

13. final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

14. def getReview(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, pullRequest: Int, review: Int): M[GHResponse[PullRequestReview]]

    Get a specific pull request review.

    Get a specific pull request review.

    accessToken

    Token to identify the authenticated user

    headers

    Optional user header to include in the request

    owner

    Owner of the repo

    repo

    Name of the repo

    pullRequest

    ID number of the PR to get reviews for

    review

    ID number of the review to retrieve.

15. def hashCode(): Int

    Definition Classes

    AnyRef → Any

16. val httpClient: HttpClient[C, M]

17. final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

18. def list(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, filters: List[PRFilter] = Nil, pagination: Option[Pagination] = None): M[GHResponse[List[PullRequest]]]

    List pull requests for a repository

    List pull requests for a repository

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    owner

    of the repo

    repo

    name of the repo

    filters

    define the filter list. Options are:

    • state: Either open, closed, or all to filter by state. Default: open
    • head: Filter pulls by head user and branch name in the format of user:ref-name. Example: github:new-script-format.
    • base: Filter pulls by base branch name. Example: gh-pages.
    • sort: What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month). Default: created
    • direction: The direction of the sort. Can be either asc or desc. Default: desc when sort is created or sort is not specified, otherwise asc.

    pagination

    Limit and Offset for pagination

    returns

    a GHResponse with the pull request list.

19. def listFiles(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, number: Int, pagination: Option[Pagination] = None): M[GHResponse[List[PullRequestFile]]]

    List files for a specific pull request

    List files for a specific pull request

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    owner

    of the repo

    repo

    name of the repo

    number

    of the pull request for which we want to list the files

    pagination

    Limit and Offset for pagination

    returns

    a GHResponse with the list of files affected by the pull request identified by number.

20. def listReviews(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, pullRequest: Int, pagination: Option[Pagination] = None): M[GHResponse[List[PullRequestReview]]]

    List pull request reviews.

    List pull request reviews.

    accessToken

    Token to identify the authenticated user

    headers

    Optional user header to include in the request

    owner

    Owner of the repo

    repo

    Name of the repo

    pullRequest

    ID number of the PR to get reviews for.

    pagination

    Limit and Offset for pagination

21. final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

22. final def notify(): Unit

    Definition Classes

    AnyRef

23. final def notifyAll(): Unit

    Definition Classes

    AnyRef

24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

25. def toString(): String

    Definition Classes

    AnyRef → Any

26. final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

27. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

28. final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )