View Source Tentacat.Pulls.Comments (Tentacat v2.5.0)

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.

Functions

Link to this function

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

View Source
@spec create(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

Link to this function

filter_all(client \\ %Client{}, owner, repo, filters)

View Source
@spec filter_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

Link to this function

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

View Source

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

Link to this function

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

View Source

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

Link to this function

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

View Source
@spec list_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

Link to this function

remove(client, owner, repo, comment_id)

View Source
@spec remove(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

Link to this function

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

View Source
@spec update(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