Tentacat v0.7.2 Tentacat.Issues.Comments
Summary
Functions
Create a comment on an issue
Delete a comment on an issue by id
Filter comments on an issue. Parameters are since
Filter comments on an issue. Parameters are sort
, direction
and since
Get a single comment on an issue by its id
List comments on an issue. Issue Comments are ordered by ascending ID
List all comments on issues for a repository. By default, Issue Comments are ordered by ascending ID
Update a comment on an issue by id
Functions
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
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
Specs
filter(binary, binary, binary | integer, Keyword.t | map, Tentacat.Client.t) :: Tentacat.response
Filter comments on an issue. Parameters are since
.
Example
Tentacat.Issues.Comments.filter "elixir-lang", "elixir", 3970, since: "2016-05-04T23:59:59Z"
More info at: https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
Specs
filter_all(binary, binary, Keyword.t | map, Tentacat.Client.t) :: Tentacat.response
Filter comments on an issue. Parameters are sort
, direction
and since
.
Example
Tentacat.Issues.Comments.filter_all "elixir-lang", "elixir", dir: "desc", sort: "updated"
More info at: https://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
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
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
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
Specs
update(binary, binary, 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