View Source Tentacat.Issues.Comments (Tentacat v2.5.0)
Summary
Functions
Create a comment on an issue.
Delete a comment on an issue by id.
Filter comments on an issue.
Filter comments on an issue.
Get a single comment on an issue by its id.
List comments on an issue.
List all comments on issues for a repository.
Update a comment on an issue by id.
Functions
@spec create(Tentacat.Client.t(), binary(), binary(), binary() | integer(), map()) :: 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
More info at: https://developer.github.com/v3/issues/comments/#create-a-comment
@spec delete( Tentacat.Client.t(), binary(), binary(), binary() | integer(), binary() | integer() ) :: Tentacat.response()
Delete a comment on an issue by id.
Example
Tentacat.Issues.Comments.delete "elixir-lang", "elixir", 882148
More info at: https://developer.github.com/v3/issues/comments/#delete-a-comment
@spec filter( Tentacat.Client.t(), binary(), binary(), binary() | integer(), Keyword.t() | map() ) :: 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
@spec filter_all(Tentacat.Client.t(), binary(), binary(), Keyword.t() | map()) :: 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
@spec find(Tentacat.Client.t(), binary(), binary(), binary() | integer()) :: Tentacat.response()
Get a single comment on an issue by its id.
Example
Tentacat.Issues.Comments.find "elixir-lang", "elixir", 882148
More info at: https://developer.github.com/v3/issues/comments/#get-a-single-comment
@spec list(Tentacat.Client.t(), binary(), binary(), binary() | integer()) :: 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
@spec list_all(Tentacat.Client.t(), binary(), binary()) :: 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
@spec update(Tentacat.Client.t(), binary(), binary(), binary() | integer(), map()) :: 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
More info at: https://developer.github.com/v3/issues/comments/#edit-a-comment