Issue

[Source]

A GitHub issue. Provides convenience methods to create comments and list existing comments on this issue. The pull_request field is present when the issue is actually a pull request.

class val Issue

Constructors

create

[Source]

new val create(
  creds: Credentials val,
  url': String val,
  respository_url': String val,
  labels_url': String val,
  comments_url': String val,
  events_url': String val,
  html_url': String val,
  number': I64 val,
  title': String val,
  user': User val,
  labels': Array[Label val] val,
  state': (String val | None val),
  body': (String val | None val),
  pull_request': (IssuePullRequest val | None val) = reference)
: Issue val^

Parameters

• creds: Credentials val
• url': String val
• respository_url': String val
• labels_url': String val
• comments_url': String val
• events_url': String val
• html_url': String val
• number': I64 val
• title': String val
• user': User val
• labels': Array[Label val] val
• state': (String val | None val)
• body': (String val | None val)
• pull_request': (IssuePullRequest val | None val) = reference

Returns

• Issue val^

---

Public fields

let number: I64 val

[Source]

---

let title: String val

[Source]

---

let user: User val

[Source]

---

let labels: Array[Label val] val

[Source]

---

let state: (String val | None val)

[Source]

---

let body: (String val | None val)

[Source]

---

let pull_request: (IssuePullRequest val | None val)

[Source]

---

let url: String val

[Source]

---

let respository_url: String val

[Source]

---

let labels_url: String val

[Source]

---

let comments_url: String val

[Source]

---

let events_url: String val

[Source]

---

let html_url: String val

[Source]

---

Public Functions

create_comment

[Source]

Creates a new comment on this issue.

fun box create_comment(
  comment: String val)
: Promise[(IssueComment val | RequestError val)] tag

Parameters

• comment: String val

Returns

• Promise[(IssueComment val | RequestError val)] tag

---

get_comments

[Source]

Fetches all comments on this issue.

fun box get_comments()
: Promise[(Array[IssueComment val] val | RequestError val)] tag

Returns

• Promise[(Array[IssueComment val] val | RequestError val)] tag

---