Tentacat v1.6.0 Tentacat.Issues.Comments View Source
Link to this section 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
Link to this section Functions
create(client \\ %Client{}, owner, repo, issue_id, body)
View Source
create(
Tentacat.Client.t(),
binary(),
binary(),
binary() | integer(),
list() | map()
) :: Tentacat.response()
create( Tentacat.Client.t(), binary(), binary(), binary() | integer(), list() | 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
https://developer.github.com/v3/issues/comments/#create-a-comment
delete(client \\ %Client{}, owner, repo, issue_id, comment_id)
View Source
delete(
Tentacat.Client.t(),
binary(),
binary(),
binary() | integer(),
binary() | integer()
) :: Tentacat.response()
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
https://developer.github.com/v3/issues/comments/#delete-a-comment
filter(client \\ %Client{}, owner, repo, issue_id, filters)
View Source
filter(
Tentacat.Client.t(),
binary(),
binary(),
binary() | integer(),
Keyword.t() | map()
) :: Tentacat.response()
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
filter_all(client \\ %Client{}, owner, repo, filters)
View Source
filter_all(Tentacat.Client.t(), binary(), binary(), Keyword.t() | map()) ::
Tentacat.response()
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
find(client \\ %Client{}, owner, repo, comment_id)
View Source
find(Tentacat.Client.t(), binary(), binary(), binary() | integer()) ::
Tentacat.response()
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
https://developer.github.com/v3/issues/comments/#get-a-single-comment
list(client \\ %Client{}, owner, repo, issue_id)
View Source
list(Tentacat.Client.t(), binary(), binary(), binary() | integer()) ::
Tentacat.response()
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
list_all(client \\ %Client{}, owner, repo)
View Source
list_all(Tentacat.Client.t(), binary(), binary()) :: Tentacat.response()
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
update(client \\ %Client{}, owner, repo, comment_id, body)
View Source
update(
Tentacat.Client.t(),
binary(),
binary(),
binary() | integer(),
list() | map()
) :: Tentacat.response()
update( Tentacat.Client.t(), binary(), binary(), binary() | integer(), list() | 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
https://developer.github.com/v3/issues/comments/#edit-a-comment