c

github4s.interpreters

PullRequestsInterpreter

class PullRequestsInterpreter[F[_]] extends PullRequests[F]

Linear Supertypes
PullRequests[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PullRequestsInterpreter
  2. PullRequests
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PullRequestsInterpreter()(implicit client: HttpClient[F])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addReviewers(owner: String, repo: String, pullRequest: Int, reviewers: ReviewersRequest, headers: Map[String, String]): F[GHResponse[PullRequest]]
    Definition Classes
    PullRequestsInterpreter → PullRequests
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. def createPullRequest(owner: String, repo: String, newPullRequest: NewPullRequest, head: String, base: String, maintainerCanModify: Option[Boolean], headers: Map[String, String]): F[GHResponse[PullRequest]]

    Create a pull request

    Create a pull 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).

    headers

    Optional user headers to include in the request

    Definition Classes
    PullRequestsInterpreter → PullRequests
  8. def createReview(owner: String, repo: String, pullRequest: Int, createPRReviewRequest: CreatePRReviewRequest, headers: Map[String, String]): F[GHResponse[PullRequestReview]]

    Create a review for a pull request

    Create a review for a pull request

    owner

    Owner of the repo

    repo

    Name of the repo

    pullRequest

    ID number of the PR to get reviews for

    createPRReviewRequest

    Data to create a review

    headers

    Optional user header to include in the request

    returns

    a GHResponse with the created review

    Definition Classes
    PullRequestsInterpreter → PullRequests
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def getPullRequest(owner: String, repo: String, number: Int, headers: Map[String, String]): F[GHResponse[PullRequest]]

    Get a single pull request for a repository

    Get a single pull request for a repository

    owner

    of the repo

    repo

    name of the repo

    number

    of the pull request

    headers

    optional user headers to include in the request

    returns

    a GHResponse with the pull request.

    Definition Classes
    PullRequestsInterpreter → PullRequests
  13. def getReview(owner: String, repo: String, pullRequest: Int, review: Long, headers: Map[String, String]): F[GHResponse[PullRequestReview]]

    Get a specific pull request review.

    Get a specific pull request review.

    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.

    headers

    Optional user header to include in the request

    Definition Classes
    PullRequestsInterpreter → PullRequests
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def listFiles(owner: String, repo: String, number: Int, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[PullRequestFile]]]

    List files for a specific pull request

    List files for a specific pull 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

    headers

    optional user headers to include in the request

    returns

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

    Definition Classes
    PullRequestsInterpreter → PullRequests
  17. def listPullRequests(owner: String, repo: String, filters: List[PRFilter], pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[PullRequest]]]

    List pull requests for a repository

    List pull requests for a repository

    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

    headers

    optional user headers to include in the request

    returns

    a GHResponse with the pull request list.

    Definition Classes
    PullRequestsInterpreter → PullRequests
  18. def listReviewers(owner: String, repo: String, pullRequest: Int, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[ReviewersResponse]]
    Definition Classes
    PullRequestsInterpreter → PullRequests
  19. def listReviews(owner: String, repo: String, pullRequest: Int, pagination: Option[Pagination], headers: Map[String, String]): F[GHResponse[List[PullRequestReview]]]

    List pull request reviews.

    List pull request reviews.

    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

    headers

    Optional user header to include in the request

    Definition Classes
    PullRequestsInterpreter → PullRequests
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def removeReviewers(owner: String, repo: String, pullRequest: Int, reviewers: ReviewersRequest, headers: Map[String, String]): F[GHResponse[PullRequest]]
    Definition Classes
    PullRequestsInterpreter → PullRequests
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. def updateBranch(owner: String, repo: String, pullRequest: Int, expectedHeadSha: Option[String] = None, headers: Map[String, String] = Map()): F[GHResponse[BranchUpdateResponse]]

    This is an experimental API and could be changed or removed

    This is an experimental API and could be changed or removed

    Definition Classes
    PullRequestsInterpreter → PullRequests
  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( ... ) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from PullRequests[F]

Inherited from AnyRef

Inherited from Any

Ungrouped