trait Issues[F[_]] extends AnyRef
- Alphabetic
- By Inheritance
- Issues
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
addLabels(owner: String, repo: String, number: Int, labels: List[String], headers: Map[String, String] = Map()): F[GHResponse[List[Label]]]
Add the specified labels to an Issue
Add the specified labels to an Issue
- owner
of the repo
- repo
name of the repo
- number
Issue number
- labels
the list of labels to add to the issue
- headers
optional user headers to include in the request
- returns
a GHResponse with the list of labels added to the Issue.
-
abstract
def
createComment(owner: String, repo: String, number: Int, body: String, headers: Map[String, String] = Map()): F[GHResponse[Comment]]
Create a comment
Create a comment
- owner
of the repo
- repo
name of the repo
- number
Issue number
- body
Comment body
- headers
optional user headers to include in the request
- returns
a GHResponse with the created Comment
-
abstract
def
createIssue(owner: String, repo: String, title: String, body: String, milestone: Option[Int], labels: List[String], assignees: List[String], headers: Map[String, String] = Map()): F[GHResponse[Issue]]
Create an issue
Create an issue
- 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.
- headers
optional user headers to include in the request
-
abstract
def
createMilestone(owner: String, repo: String, title: String, state: Option[String], description: Option[String], due_on: Option[ZonedDateTime], headers: Map[String, String] = Map()): F[GHResponse[Milestone]]
Create a milestone
Create a milestone
- owner
repo owner
- repo
repo name
- title
The title of the milestone.
- state
The state of the milestone. Either open or closed. Default: open
- description
A description of the milestone.
- due_on
The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
- headers
optional user headers to include in the request
- returns
a GHResponse with the created Milestone
-
abstract
def
deleteComment(owner: String, repo: String, id: Int, headers: Map[String, String] = Map()): F[GHResponse[Unit]]
Delete a comment
Delete a comment
- owner
of the repo
- repo
name of the repo
- id
Comment id
- headers
optional user headers to include in the request
- returns
a unit GHResponse
-
abstract
def
deleteMilestone(owner: String, repo: String, milestone_number: Int, headers: Map[String, String] = Map()): F[GHResponse[Unit]]
Delete a milestone
Delete a milestone
- owner
repo owner
- repo
repo name
- milestone_number
number of milestone
- headers
optional user headers to include in the request
- returns
a Unit GHResponse
-
abstract
def
editComment(owner: String, repo: String, id: Int, body: String, headers: Map[String, String] = Map()): F[GHResponse[Comment]]
Edit a comment
Edit a comment
- owner
of the repo
- repo
name of the repo
- id
Comment id
- body
Comment body
- headers
optional user headers to include in the request
- returns
a GHResponse with the edited Comment
-
abstract
def
editIssue(owner: String, repo: String, issue: Int, state: String, title: String, body: String, milestone: Option[Int], labels: List[String], assignees: List[String], headers: Map[String, String] = Map()): F[GHResponse[Issue]]
Edit an issue
Edit an issue
- 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.
- headers
optional user headers to include in the request
-
abstract
def
getIssue(owner: String, repo: String, number: Int, headers: Map[String, String] = Map()): F[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_requestkey.- owner
of the repo
- repo
name of the repo
- number
Issue number
- headers
optional user headers to include in the request
- returns
a GHResponse with the issue list.
-
abstract
def
getMilestone(owner: String, repo: String, number: Int, headers: Map[String, String] = Map()): F[GHResponse[Milestone]]
Get a single milestone
Get a single milestone
- owner
repo owner
- repo
repo name
- number
Milestone number
- headers
optional user headers to include in the request
- returns
a GHResponse with a Milestone
-
abstract
def
listAvailableAssignees(owner: String, repo: String, pagination: Option[Pagination] = None, headers: Map[String, String] = Map()): F[GHResponse[List[User]]]
List available assignees for issues
List available assignees for issues
- owner
repo owner
- repo
repo name
- pagination
Limit and Offset for pagination
- headers
optional user headers to include in the request
- returns
a GHResponse with the list of available assignees for issues in specified repository
-
abstract
def
listComments(owner: String, repo: String, number: Int, pagination: Option[Pagination] = None, headers: Map[String, String] = Map()): F[GHResponse[List[Comment]]]
List comments to an Issue
List comments to an Issue
- owner
of the repo
- repo
name of the repo
- number
Issue number
- pagination
Limit and Offset for pagination
- headers
optional user headers to include in the request
- returns
a GHResponse with the comment list of the Issue.
-
abstract
def
listIssues(owner: String, repo: String, pagination: Option[Pagination] = None, headers: Map[String, String] = Map()): F[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_requestkey.- owner
of the repo
- repo
name of the repo
- pagination
Limit and Offset for pagination
- headers
optional user headers to include in the request
- returns
a GHResponse with the issue list.
-
abstract
def
listLabels(owner: String, repo: String, number: Int, pagination: Option[Pagination] = None, headers: Map[String, String] = Map()): F[GHResponse[List[Label]]]
List the labels assigned to an Issue
List the labels assigned to an Issue
- owner
of the repo
- repo
name of the repo
- number
Issue number
- pagination
Limit and Offset for pagination, optional.
- headers
optional user headers to include in the request
- returns
a GHResponse with the list of labels for the Issue.
-
abstract
def
listLabelsRepository(owner: String, repo: String, pagination: Option[Pagination] = None, headers: Map[String, String] = Map()): F[GHResponse[List[Label]]]
List the labels assigned to a Repository
List the labels assigned to a Repository
- owner
of the repo
- repo
name of the repo
- pagination
Limit and Offset for pagination, optional.
- headers
optional user headers to include in the request
- returns
a GHResponse with the list of labels for the Repository.
-
abstract
def
listMilestones(owner: String, repo: String, state: Option[String], sort: Option[String], direction: Option[String], pagination: Option[Pagination] = None, headers: Map[String, String] = Map()): F[GHResponse[List[Milestone]]]
List milestone in specified repository
List milestone in specified repository
- owner
repo owner
- repo
repo name
- state
filter milestones returned by their state. Can be either
open,closed,all. Default:open- sort
What to sort results by. Either due_on or completeness. Default: due_on
- direction
The direction of the sort. Either asc or desc. Default: asc
- pagination
Limit and Offset for pagination
- headers
optional user headers to include in the request
- returns
a GHResponse with the list of milestones in specified repository
-
abstract
def
removeLabel(owner: String, repo: String, number: Int, label: String, headers: Map[String, String] = Map()): F[GHResponse[List[Label]]]
Remove the specified label from an Issue
Remove the specified label from an Issue
- owner
of the repo
- repo
name of the repo
- number
Issue number
- label
the name of the label to remove from the issue
- headers
optional user headers to include in the request
- returns
a GHResponse with the list of labels removed from the Issue.
-
abstract
def
searchIssues(query: String, searchParams: List[SearchParam], headers: Map[String, String] = Map()): F[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_requestkey.- query
the query string for the search
- searchParams
list of search params
- headers
optional user headers to include in the request
- returns
a GHResponse with the result of the search.
-
abstract
def
updateMilestone(owner: String, repo: String, milestone_number: Int, title: String, state: Option[String], description: Option[String], due_on: Option[ZonedDateTime], headers: Map[String, String] = Map()): F[GHResponse[Milestone]]
Update a milestone
Update a milestone
- owner
repo owner
- repo
repo name
- milestone_number
number of milestone
- title
The title of the milestone.
- state
The state of the milestone. Either open or closed. Default: open
- description
A description of the milestone.
- due_on
The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
- headers
optional user headers to include in the request
- returns
a GHResponse with the updated Milestone
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()