View Source GitHub.Reactions (GitHub REST API Client v0.0.6)

Provides API endpoints related to reactions

Link to this section Summary

Functions

List reactions for a pull request review comment

List reactions for a team discussion (Legacy)

Link to this section Functions

Link to this function

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

resources

Resources

Link to this function

create_for_issue(owner, repo, issue_number, body, opts \\ [])

View Source
@spec create_for_issue(String.t(), String.t(), integer(), map(), keyword()) ::
  {:ok, GitHub.Reaction.t()} | {:error, GitHub.Error.t()}

Create reaction for an issue

resources

Resources

Link to this function

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

resources

Resources

Link to this function

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

resources

Resources

Link to this function

create_for_release(owner, repo, release_id, body, opts \\ [])

View Source
@spec create_for_release(String.t(), String.t(), integer(), map(), keyword()) ::
  {:ok, GitHub.Reaction.t()} | {:error, GitHub.Error.t()}

Create reaction for a release

resources

Resources

Link to this function

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

resources

Resources

Link to this function

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)

resources

Resources

Link to this function

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

resources

Resources

Link to this function

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)

resources

Resources

Link to this function

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

resources

Resources

Link to this function

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

resources

Resources

Link to this function

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

resources

Resources

Link to this function

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

resources

Resources

Link to this function

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

resources

Resources

Link to this function

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

resources

Resources

Link to this function

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

resources

Resources

Link to this function

list_for_commit_comment(owner, repo, comment_id, opts \\ [])

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

options

Options

  • content (String.t()): Returns a single reaction type. Omit this parameter to list all reactions to a commit comment.
  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_for_issue(owner, repo, issue_number, opts \\ [])

View Source
@spec list_for_issue(String.t(), String.t(), integer(), keyword()) ::
  {:ok, [GitHub.Reaction.t()]} | {:error, GitHub.Error.t()}

List reactions for an issue

options

Options

  • content (String.t()): Returns a single reaction type. Omit this parameter to list all reactions to an issue.
  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_for_issue_comment(owner, repo, comment_id, opts \\ [])

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

options

Options

  • content (String.t()): Returns a single reaction type. Omit this parameter to list all reactions to an issue comment.
  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

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

options

Options

  • content (String.t()): Returns a single reaction type. Omit this parameter to list all reactions to a pull request review comment.
  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

list_for_release(owner, repo, release_id, opts \\ [])

View Source
@spec list_for_release(String.t(), String.t(), integer(), keyword()) ::
  {:ok, [GitHub.Reaction.t()]} | {:error, GitHub.Error.t()}

List reactions for a release

options

Options

  • content (String.t()): Returns a single reaction type. Omit this parameter to list all reactions to a release.
  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

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

options

Options

  • content (String.t()): Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

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)

options

Options

  • content (String.t()): Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.
  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

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

options

Options

  • content (String.t()): Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources

Link to this function

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)

options

Options

  • content (String.t()): Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.
  • per_page (integer): The number of results per page (max 100).
  • page (integer): Page number of the results to fetch.

resources

Resources