c

github4s.api

PullRequests

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

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  11. val httpClient: HttpClient[C, M]
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def list(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, filters: List[PRFilter] = Nil): 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.
    returns

    a GHResponse with the pull request list.

  14. def listFiles(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, number: Int): 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

    returns

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

  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped