Tentacat v0.2.0 → Overview → Tentacat → Pulls → Comments

Tentacat.Pulls.Comments

Summary

create(owner, repo, number, body, client)	Create a comment for a pull request
find(owner, repo, comment_id, client \\ %Tentacat.Client{})	Get a single comment for a repository by comment id
list(owner, repo, number, client \\ %Tentacat.Client{})	List comments on a pull request
list_all(owner, repo, client \\ %Tentacat.Client{})	List pull requests comments in a repository
remove(owner, repo, comment_id, client)	Delete a pull request’s comment by it’s Id
update(owner, repo, comment_id, body, client)	Edit a comment for a pull request

create(owner, repo, number, body, client)

(function) # ↑

Specs:

create(binary, binary, integer | binary, list | %{}, Tentacat.Client.t) :: Tentacat.response

Create a comment for a pull request

Comment body example:

%{
  "body"      => "Nice change",
  "commit_id" => "6dcb09b5b57875f334f61aebed695e2e4193db5e",
  "path"      => "file1.txt",
  "position"  =>  4
}

Tentacat.Pulls.Comments.create "elixir-lang", "elixir", 2974, comment_body, client

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

(function) # ↑

Specs:

Get a single comment for a repository by comment id

Tentacat.Pulls.Comments.find "elixir-lang", "elixir", "22377723"
Tentacat.Pulls.Comments.list "elixir-lang", "elixir", "22377723", client

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

(function) # ↑

Specs:

List comments on a pull request

Tentacat.Pulls.Comments.list "elixir-lang", "elixir", "2974"
Tentacat.Pulls.Comments.list "elixir-lang", "elixir", "2974", client

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

(function) # ↑

Specs:

List pull requests comments in a repository

Tentacat.Pulls.Comments.list_all "elixir-lang", "elixir"
Tentacat.Pulls.Comments.list_all "elixir-lang", "elixir", client

remove(owner, repo, comment_id, client)

(function) # ↑

Specs:

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

Delete a pull request’s comment by it’s Id.

Tentacat.Pulls.Comments.remove "elixir-lang", "elixir", "22377723", client

update(owner, repo, comment_id, body, client)

(function) # ↑

Specs:

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

Edit a comment for a pull request

Tentacat.Pulls.Comments.update "elixir-lang", "elixir", "22377723", comment_body, client