Tentacat

v0.7.2

Tentacat v0.7.2 Tentacat.Issues.Comments

Summary

Functions

create(owner, repo, issue_id, body, client \\ %Tentacat.Client{})

Create a comment on an issue

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

Delete a comment on an issue by id

filter(owner, repo, issue_id, filters, client \\ %Tentacat.Client{})

Filter comments on an issue. Parameters are since

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

Filter comments on an issue. Parameters are sort, direction and since

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

Get a single comment on an issue by its id

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

List comments on an issue. Issue Comments are ordered by ascending ID

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

List all comments on issues for a repository. By default, Issue Comments are ordered by ascending ID

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

Update a comment on an issue by id

Functions

create(owner, repo, issue_id, body, client \\ %Tentacat.Client{})

Specs

create(binary, binary, binary | integer, list | map, Tentacat.Client.t) :: 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(owner, repo, issue_id, comment_id, client \\ %Tentacat.Client{})

Specs

delete(binary, binary, binary | integer, binary | integer, Tentacat.Client.t) :: 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(owner, repo, issue_id, filters, client \\ %Tentacat.Client{})

Specs

filter(binary, binary, binary | integer, Keyword.t | map, Tentacat.Client.t) :: 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(owner, repo, filters, client \\ %Tentacat.Client{})

Specs

filter_all(binary, binary, Keyword.t | map, Tentacat.Client.t) :: 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(owner, repo, comment_id, client \\ %Tentacat.Client{})

Specs

find(binary, binary, binary | integer, Tentacat.Client.t) :: 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(owner, repo, issue_id, client \\ %Tentacat.Client{})

Specs

list(binary, binary, binary | integer, Tentacat.Client.t) :: 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(owner, repo, client \\ %Tentacat.Client{})

Specs

list_all(binary, binary, Tentacat.Client.t) :: 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(owner, repo, comment_id, body, client \\ %Tentacat.Client{})

Specs

update(binary, binary, binary | integer, list | map, Tentacat.Client.t) :: 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