View Source GitHub.Reactions (GitHub REST API Client v0.2.3)
Provides API endpoints related to reactions
Link to this section Summary
Functions
Create reaction for a commit comment
Create reaction for an issue
Create reaction for an issue comment
Create reaction for a pull request review comment
Create reaction for a release
Create reaction for a team discussion comment
Create reaction for a team discussion comment (Legacy)
Create reaction for a team discussion
Create reaction for a team discussion (Legacy)
Delete a commit comment reaction
Delete an issue reaction
Delete an issue comment reaction
Delete a pull request comment reaction
Delete a release reaction
Delete team discussion reaction
Delete team discussion comment reaction
List reactions for a commit comment
List reactions for an issue
List reactions for an issue comment
List reactions for a pull request review comment
List reactions for a release
List reactions for a team discussion comment
List reactions for a team discussion comment (Legacy)
List reactions for a team discussion
List reactions for a team discussion (Legacy)
Link to this section Functions
create_for_commit_comment(owner, repo, comment_id, body, opts \\ [])
View Source@spec create_for_commit_comment(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Reaction.t()} | {:error, GitHub.Error.t()}
Create reaction for a commit comment
Create a reaction to a commit comment. A response with an HTTP 200
status means that you already added the reaction type to this commit comment.
resources
Resources
@spec create_for_issue(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Reaction.t()} | {:error, GitHub.Error.t()}
Create reaction for an issue
Create a reaction to an issue. A response with an HTTP 200
status means that you already added the reaction type to this issue.
resources
Resources
create_for_issue_comment(owner, repo, comment_id, body, opts \\ [])
View Source@spec create_for_issue_comment(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Reaction.t()} | {:error, GitHub.Error.t()}
Create reaction for an issue comment
Create a reaction to an issue comment. A response with an HTTP 200
status means that you already added the reaction type to this issue comment.
resources
Resources
create_for_pull_request_review_comment(owner, repo, comment_id, body, opts \\ [])
View Source@spec create_for_pull_request_review_comment( String.t(), String.t(), integer(), map(), keyword() ) :: {:ok, GitHub.Reaction.t()} | {:error, GitHub.Error.t()}
Create reaction for a pull request review comment
Create a reaction to a pull request review comment. A response with an HTTP 200
status means that you already added the reaction type to this pull request review comment.
resources
Resources
@spec create_for_release(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.Reaction.t()} | {:error, GitHub.Error.t()}
Create reaction for a release
Create a reaction to a release. A response with a Status: 200 OK
means that you already added the reaction type to this release.
resources
Resources
create_for_team_discussion_comment_in_org(org, team_slug, discussion_number, comment_number, body, opts \\ [])
View Source@spec create_for_team_discussion_comment_in_org( String.t(), String.t(), integer(), integer(), map(), keyword() ) :: {:ok, GitHub.Reaction.t()} | {:error, GitHub.Error.t()}
Create reaction for a team discussion comment
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion
scope. A response with an HTTP 200
status means that you already added the reaction type to this team discussion comment.
Note: You can also specify a team by org_id
and team_id
using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions
.
resources
Resources
create_for_team_discussion_comment_legacy(team_id, discussion_number, comment_number, body, opts \\ [])
View Source@spec create_for_team_discussion_comment_legacy( integer(), integer(), integer(), map(), keyword() ) :: {:ok, GitHub.Reaction.t()} | {:error, GitHub.Error.t()}
Create reaction for a team discussion comment (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "Create reaction for a team discussion comment" endpoint.
Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion
scope. A response with an HTTP 200
status means that you already added the reaction type to this team discussion comment.
resources
Resources
create_for_team_discussion_in_org(org, team_slug, discussion_number, body, opts \\ [])
View Source@spec create_for_team_discussion_in_org( String.t(), String.t(), integer(), map(), keyword() ) :: {:ok, GitHub.Reaction.t()} | {:error, GitHub.Error.t()}
Create reaction for a team discussion
Create a reaction to a team discussion. OAuth access tokens require the write:discussion
scope. A response with an HTTP 200
status means that you already added the reaction type to this team discussion.
Note: You can also specify a team by org_id
and team_id
using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions
.
resources
Resources
create_for_team_discussion_legacy(team_id, discussion_number, body, opts \\ [])
View Source@spec create_for_team_discussion_legacy(integer(), integer(), map(), keyword()) :: {:ok, GitHub.Reaction.t()} | {:error, GitHub.Error.t()}
Create reaction for a team discussion (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new Create reaction for a team discussion
endpoint.
Create a reaction to a team discussion. OAuth access tokens require the write:discussion
scope. A response with an HTTP 200
status means that you already added the reaction type to this team discussion.
resources
Resources
delete_for_commit_comment(owner, repo, comment_id, reaction_id, opts \\ [])
View Source@spec delete_for_commit_comment( String.t(), String.t(), integer(), integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Delete a commit comment reaction
Note: You can also specify a repository by repository_id
using the route DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id
.
Delete a reaction to a commit comment.
resources
Resources
delete_for_issue(owner, repo, issue_number, reaction_id, opts \\ [])
View Source@spec delete_for_issue(String.t(), String.t(), integer(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete an issue reaction
Note: You can also specify a repository by repository_id
using the route DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id
.
Delete a reaction to an issue.
resources
Resources
delete_for_issue_comment(owner, repo, comment_id, reaction_id, opts \\ [])
View Source@spec delete_for_issue_comment( String.t(), String.t(), integer(), integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Delete an issue comment reaction
Note: You can also specify a repository by repository_id
using the route DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id
.
Delete a reaction to an issue comment.
resources
Resources
delete_for_pull_request_comment(owner, repo, comment_id, reaction_id, opts \\ [])
View Source@spec delete_for_pull_request_comment( String.t(), String.t(), integer(), integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Delete a pull request comment reaction
Note: You can also specify a repository by repository_id
using the route DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.
Delete a reaction to a pull request review comment.
resources
Resources
delete_for_release(owner, repo, release_id, reaction_id, opts \\ [])
View Source@spec delete_for_release(String.t(), String.t(), integer(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a release reaction
Note: You can also specify a repository by repository_id
using the route DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id
.
Delete a reaction to a release.
resources
Resources
delete_for_team_discussion(org, team_slug, discussion_number, reaction_id, opts \\ [])
View Source@spec delete_for_team_discussion( String.t(), String.t(), integer(), integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Delete team discussion reaction
Note: You can also specify a team or organization with team_id
and org_id
using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id
.
Delete a reaction to a team discussion. OAuth access tokens require the write:discussion
scope.
resources
Resources
delete_for_team_discussion_comment(org, team_slug, discussion_number, comment_number, reaction_id, opts \\ [])
View Source@spec delete_for_team_discussion_comment( String.t(), String.t(), integer(), integer(), integer(), keyword() ) :: :ok | {:error, GitHub.Error.t()}
Delete team discussion comment reaction
Note: You can also specify a team or organization with team_id
and org_id
using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id
.
Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion
scope.
resources
Resources
@spec list_for_commit_comment(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.Reaction.t()]} | {:error, GitHub.Error.t()}
List reactions for a commit comment
List the reactions to a commit comment.
options
Options
content
: Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.per_page
: The number of results per page (max 100).page
: Page number of the results to fetch.
resources
Resources
@spec list_for_issue(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.Reaction.t()]} | {:error, GitHub.Error.t()}
List reactions for an issue
List the reactions to an issue.
options
Options
content
: Returns a single reaction type. Omit this parameter to list all reactions to an issue.per_page
: The number of results per page (max 100).page
: Page number of the results to fetch.
resources
Resources
@spec list_for_issue_comment(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.Reaction.t()]} | {:error, GitHub.Error.t()}
List reactions for an issue comment
List the reactions to an issue comment.
options
Options
content
: Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.per_page
: The number of results per page (max 100).page
: Page number of the results to fetch.
resources
Resources
list_for_pull_request_review_comment(owner, repo, comment_id, opts \\ [])
View Source@spec list_for_pull_request_review_comment( String.t(), String.t(), integer(), keyword() ) :: {:ok, [GitHub.Reaction.t()]} | {:error, GitHub.Error.t()}
List reactions for a pull request review comment
List the reactions to a pull request review comment.
options
Options
content
: Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.per_page
: The number of results per page (max 100).page
: Page number of the results to fetch.
resources
Resources
@spec list_for_release(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.Reaction.t()]} | {:error, GitHub.Error.t()}
List reactions for a release
List the reactions to a release.
options
Options
content
: Returns a single reaction type. Omit this parameter to list all reactions to a release.per_page
: The number of results per page (max 100).page
: Page number of the results to fetch.
resources
Resources
list_for_team_discussion_comment_in_org(org, team_slug, discussion_number, comment_number, opts \\ [])
View Source@spec list_for_team_discussion_comment_in_org( String.t(), String.t(), integer(), integer(), keyword() ) :: {:ok, [GitHub.Reaction.t()]} | {:error, GitHub.Error.t()}
List reactions for a team discussion comment
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions
.
options
Options
content
: Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.per_page
: The number of results per page (max 100).page
: Page number of the results to fetch.
resources
Resources
list_for_team_discussion_comment_legacy(team_id, discussion_number, comment_number, opts \\ [])
View Source@spec list_for_team_discussion_comment_legacy( integer(), integer(), integer(), keyword() ) :: {:ok, [GitHub.Reaction.t()]} | {:error, GitHub.Error.t()}
List reactions for a team discussion comment (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion comment
endpoint.
List the reactions to a team discussion comment. OAuth access tokens require the read:discussion
scope.
options
Options
content
: Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.per_page
: The number of results per page (max 100).page
: Page number of the results to fetch.
resources
Resources
list_for_team_discussion_in_org(org, team_slug, discussion_number, opts \\ [])
View Source@spec list_for_team_discussion_in_org(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.Reaction.t()]} | {:error, GitHub.Error.t()}
List reactions for a team discussion
List the reactions to a team discussion. OAuth access tokens require the read:discussion
scope.
Note: You can also specify a team by org_id
and team_id
using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions
.
options
Options
content
: Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.per_page
: The number of results per page (max 100).page
: Page number of the results to fetch.
resources
Resources
list_for_team_discussion_legacy(team_id, discussion_number, opts \\ [])
View Source@spec list_for_team_discussion_legacy(integer(), integer(), keyword()) :: {:ok, [GitHub.Reaction.t()]} | {:error, GitHub.Error.t()}
List reactions for a team discussion (Legacy)
Deprecation Notice: This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new List reactions for a team discussion
endpoint.
List the reactions to a team discussion. OAuth access tokens require the read:discussion
scope.
options
Options
content
: Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.per_page
: The number of results per page (max 100).page
: Page number of the results to fetch.