Class

github4s.api

PullRequests

Related Doc: package api

Permalink

class PullRequests[C, M[_]] extends AnyRef

Factory to encapsulate calls related to PullRequests operations

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PullRequests
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PullRequests()(implicit urls: GithubApiUrls, C: Capture[M], httpClientImpl: HttpRequestBuilderExtension[C, M])

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. 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]]

    Permalink

    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).

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

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def getReview(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, pullRequest: Int, review: Int): M[GHResponse[PullRequestReview]]

    Permalink

    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.

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. val httpClient: HttpClient[C, M]

    Permalink
  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. def list(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, filters: List[PRFilter] = Nil): M[GHResponse[List[PullRequest]]]

    Permalink

    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.
    returns

    a GHResponse with the pull request list.

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

    Permalink

    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

    returns

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

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

    Permalink

    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.

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

    Permalink
    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped