Packages

c

github4s.api

Issues

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

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 addLabels(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, number: Int, labels: List[String]): M[GHResponse[List[Label]]]

    Add the specified labels to an Issue

    Add the specified labels to 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

    number

    Issue number

    labels

    the list of labels to add to the issue

    returns

    a GHResponse with the list of labels added to the Issue.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. 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]]

    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.

  8. def createComment(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, number: Int, body: String): M[GHResponse[Comment]]

    Create a comment

    Create a comment

    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

    Issue number

    body

    Comment body

    returns

    a GHResponse with the created Comment

  9. def deleteComment(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, id: Int): M[GHResponse[Unit]]

    Delete a comment

    Delete a comment

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    owner

    of the repo

    repo

    name of the repo

    id

    Comment id

    returns

    a unit GHResponse

  10. 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]]

    Edit an issue

    Edit 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

    issue

    number

    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.

  11. def editComment(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, id: Int, body: String): M[GHResponse[Comment]]

    Edit a comment

    Edit a comment

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    owner

    of the repo

    repo

    name of the repo

    id

    Comment id

    body

    Comment body

    returns

    a GHResponse with the edited Comment

  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def get(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, number: Int): M[GHResponse[Issue]]

    Get a single issue of a repository

    Get a single issue of 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

    number

    Issue number

    returns

    a GHResponse with the issue list.

  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. val httpClient: HttpClient[C, M]
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def list(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String): M[GHResponse[List[Issue]]]

    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.

  21. def listAvailableAssignees(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, pagination: Option[Pagination] = None): M[GHResponse[List[User]]]

    List available assignees for issues

    List available assignees for issues

    accessToken

    to identify the authenticated user

    headers

    optional user headers to include in the request

    owner

    repo owner

    repo

    repo name

    pagination

    Limit and Offset for pagination

    returns

    a GHResponse with the list of available assignees for issues in specified repository

  22. def listComments(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, number: Int): M[GHResponse[List[Comment]]]

    List comments to an Issue

    List comments to 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

    number

    Issue number

    returns

    a GHResponse with the comment list of the Issue.

  23. def listLabels(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, number: Int): M[GHResponse[List[Label]]]

    List the labels assigned to an Issue

    List the labels assigned to 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

    number

    Issue number

    returns

    a GHResponse with the list of labels for the Issue.

  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. def removeLabel(accessToken: Option[String] = None, headers: Map[String, String] = Map(), owner: String, repo: String, number: Int, label: String): M[GHResponse[List[Label]]]

    Remove the specified label from an Issue

    Remove the specified label from 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

    number

    Issue number

    label

    the name of the label to remove from the issue

    returns

    a GHResponse with the list of labels removed from the Issue.

  28. def search(accessToken: Option[String] = None, headers: Map[String, String] = Map(), query: String, searchParams: List[SearchParam]): M[GHResponse[SearchIssuesResult]]

    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.

  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped