Class

github4s.api

Issues

Related Doc: package api

Permalink

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

Factory to encapsulate calls related to Issues operations

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

Instance Constructors

  1. new Issues()(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, title: String, body: String, milestone: Option[Int], labels: List[String], assignees: List[String]): M[GHResponse[Issue]]

    Permalink

    Create an issue

    Create an issue

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    owner

    of the repo

    repo

    name of the repo

    title

    The title of the issue.

    body

    The contents of the issue.

    milestone

    The number of the milestone to associate this issue with.

    labels

    Labels to associate with this issue.

    assignees

    Logins for Users to assign to this issue.

  7. def edit(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, issue: Int, state: String, title: String, body: String, milestone: Option[Int], labels: List[String], assignees: List[String]): M[GHResponse[Issue]]

    Permalink

    Edit an issue

    Edit an issue

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    state

    State of the issue. Either open or closed.

    title

    The title of the issue.

    body

    The contents of the issue.

    milestone

    The number of the milestone to associate this issue with.

    labels

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty list to clear all Labels from the Issue.

    assignees

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty list to clear all assignees from the Issue.

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  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): M[GHResponse[List[Issue]]]

    Permalink

    List issues for a repository

    List issues for a repository

    Note: In the past, pull requests and issues were more closely aligned than they are now. As far as the API is concerned, every pull request is an issue, but not every issue is a pull request.

    This endpoint may also return pull requests in the response. If an issue is a pull request, the object will include a pull_request key.

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    owner

    of the repo

    repo

    name of the repo

    returns

    a GHResponse with the issue list.

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

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

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

    Permalink
    Definition Classes
    AnyRef
  19. def search(accessToken: Option[String] = None, headers: Map[String, String] = Map(), query: String, searchParams: List[SearchParam]): M[GHResponse[SearchIssuesResult]]

    Permalink

    Search for issues

    Search for issues

    Note: In the past, pull requests and issues were more closely aligned than they are now. As far as the API is concerned, every pull request is an issue, but not every issue is a pull request.

    This endpoint may also return pull requests in the response. If an issue is a pull request, the object will include a pull_request key.

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    query

    the query string for the search

    searchParams

    list of search params

    returns

    a GHResponse with the result of the search.

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped