Tentacat v0.3.0 → Overview → Tentacat → Issues → Comments

Tentacat.Issues.Comments

Summary
Functions

Summary

create(owner, repo, issue_id, body, client \\ %Tentacat.Client{})	Create a comment on an issue
delete(owner, repo, issue_id, comment_id, client \\ %Tentacat.Client{})	Delete a comment on an issue by id
find(owner, repo, comment_id, client \\ %Tentacat.Client{})	Get a single comment on an issue by its id
list(owner, repo, issue_id, client \\ %Tentacat.Client{})	List comments on an issue. Issue Comments are ordered by ascending ID
list_all(owner, repo, client \\ %Tentacat.Client{})	List all comments on issues for a repository. By default, Issue Comments are ordered by ascending ID
update(owner, repo, issue_id, comment_id, body, client \\ %Tentacat.Client{})	Update a comment on an issue by id

Functions

create(owner, repo, issue_id, body, client \\ %Tentacat.Client{})

(function) # ↑

Specs:

create(binary, binary, binary | integer, list | map, Tentacat.Client.t) :: Tentacat.response

Create a comment on an issue.

Comment body example:

%{
  "body"      => "Nice change"
}

Example

Tentacat.Issues.Comments.create "elixir-lang", "elixir", 3970, comment_body

https://developer.github.com/v3/issues/comments/#create-a-comment

delete(owner, repo, issue_id, comment_id, client \\ %Tentacat.Client{})

(function) # ↑

Specs:

delete(binary, binary, binary | integer, binary | integer, Tentacat.Client.t) :: Tentacat.response

Delete a comment on an issue by id.

Example

Tentacat.Issues.Comments.delete "elixir-lang", "elixir", 882148

https://developer.github.com/v3/issues/comments/#delete-a-comment

find(owner, repo, comment_id, client \\ %Tentacat.Client{})

(function) # ↑

Specs:

find(binary, binary, binary | integer, Tentacat.Client.t) :: Tentacat.response

Get a single comment on an issue by its id.

Example

Tentacat.Issues.Comments.find "elixir-lang", "elixir", 882148

https://developer.github.com/v3/issues/comments/#get-a-single-comment

list(owner, repo, issue_id, client \\ %Tentacat.Client{})

(function) # ↑

Specs:

list(binary, binary, binary | integer, Tentacat.Client.t) :: Tentacat.response

List comments on an issue. Issue Comments are ordered by ascending ID.

Example

Tentacat.Issues.Comments.list "elixir-lang", "elixir", 3970

More info at: https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue

list_all(owner, repo, client \\ %Tentacat.Client{})

(function) # ↑

Specs:

list_all(binary, binary, Tentacat.Client.t) :: Tentacat.response

List all comments on issues for a repository. By default, Issue Comments are ordered by ascending ID.

Example

Tentacat.Issues.Comments.list_all "elixir-lang", "elixir"

More info at: https://developer.github.com/v3/issues/comments/#list-comments-in-a-repository

update(owner, repo, issue_id, comment_id, body, client \\ %Tentacat.Client{})

(function) # ↑

Specs:

update(binary, binary, binary | integer, binary | integer, list | map, Tentacat.Client.t) :: Tentacat.response

Update a comment on an issue by id.

Comment body example:

%{
  "body"      => "Nice change"
}

Example

Tentacat.Issues.Comments.update "elixir-lang", "elixir", 882148, comment_body

https://developer.github.com/v3/issues/comments/#edit-a-comment