Tentacat v2.2.0 Tentacat.Pulls.Comments View Source
Link to this section Summary
Functions
Create a comment for a pull request
Filter pull requests comments in a repository. Parameters are sort
, dir
, and since
.
Get a single comment for a repository by comment id
List comments on a pull request
List pull requests comments in a repository
Delete a pull request's comment by it's Id.
Edit a comment for a pull request
Link to this section Functions
create(client, owner, repo, number, body)
View Sourcecreate(Tentacat.Client.t(), binary(), binary(), integer() | binary(), map()) :: Tentacat.response()
Create a comment for a pull request
Comment body example:
%{
"body" => "Nice change",
"commit_id" => "6dcb09b5b57875f334f61aebed695e2e4193db5e",
"path" => "file1.txt",
"position" => 4
}
Example
Tentacat.Pulls.Comments.create client, "elixir-lang", "elixir", 2974, comment_body
More info at: https://developer.github.com/v3/pulls/comments/#create-a-comment
filter_all(client \\ %Client{}, owner, repo, filters)
View Sourcefilter_all(Tentacat.Client.t(), binary(), binary(), Keyword.t() | map()) :: Tentacat.response()
Filter pull requests comments in a repository. Parameters are sort
, dir
, and since
.
Example
Tentacat.Pulls.Comments.filter_all "elixir-lang", "elixir", %{sort: "updated", dir: "desc"}
Tentacat.Pulls.Comments.filter_all client, "elixir-lang", "elixir", %{sort: "updated", dir: "desc"}
More info at: https://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository
find(client \\ %Client{}, owner, repo, comment_id)
View Sourcefind(Tentacat.Client.t(), binary(), binary(), binary() | integer()) :: Tentacat.response()
Get a single comment for a repository by comment id
Example
Tentacat.Pulls.Comments.find "elixir-lang", "elixir", "22377723"
Tentacat.Pulls.Comments.find client, "elixir-lang", "elixir", "22377723"
More info at: https://developer.github.com/v3/pulls/comments/#get-a-single-comment
list(client \\ %Client{}, owner, repo, number)
View Sourcelist(Tentacat.Client.t(), binary(), binary(), binary() | integer()) :: Tentacat.response()
List comments on a pull request
Example
Tentacat.Pulls.Comments.list "elixir-lang", "elixir", "2974"
Tentacat.Pulls.Comments.list client, "elixir-lang", "elixir", "2974"
More info at: https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request
list_all(client \\ %Client{}, owner, repo)
View Sourcelist_all(Tentacat.Client.t(), binary(), binary()) :: Tentacat.response()
List pull requests comments in a repository
Example
Tentacat.Pulls.Comments.list_all "elixir-lang", "elixir"
Tentacat.Pulls.Comments.list_all client, "elixir-lang", "elixir"
More info at: https://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository
remove(client, owner, repo, comment_id)
View Sourceremove(Tentacat.Client.t(), binary(), binary(), binary() | integer()) :: Tentacat.response()
Delete a pull request's comment by it's Id.
Example
Tentacat.Pulls.Comments.remove client, "elixir-lang", "elixir", "22377723"
More info at: https://developer.github.com/v3/pulls/comments/#delete-a-comment
update(client, owner, repo, comment_id, body)
View Sourceupdate(Tentacat.Client.t(), binary(), binary(), binary() | integer(), map()) :: Tentacat.response()
Edit a comment for a pull request
Example
Tentacat.Pulls.Comments.update client, "elixir-lang", "elixir", "22377723", comment_body
More info at: https://developer.github.com/v3/pulls/comments/#edit-a-comment