module Octokit::Client::Reactions

def commit_comment_reactions(repo, id, options = {})

Returns:
  • (Array) - Array of Hashes representing the reactions.

Other tags:
    See: https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment -

Parameters:
  • id (Integer) -- The id of the commit comment
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def commit_comment_reactions(repo, id, options = {})
  get "#{Repository.path repo}/comments/#{id}/reactions", options
end

def create_commit_comment_reaction(repo, id, reaction, options = {})

Returns:
  • () - Hash representing the reaction

Other tags:
    See: https://developer.github.com/v3/reactions/#reaction-types -
    See: https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment -

Parameters:
  • reaction (String) -- The Reaction
  • id (Integer) -- The id of the commit comment
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def create_commit_comment_reaction(repo, id, reaction, options = {})
  options = options.merge(content: reaction)
  post "#{Repository.path repo}/comments/#{id}/reactions", options
end

def create_issue_comment_reaction(repo, id, reaction, options = {})

Returns:
  • () - Hashes representing the reaction.

Other tags:
    See: https://developer.github.com/v3/reactions/#reaction-types -
    See: https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment -

Parameters:
  • reaction (String) -- The Reaction
  • id (Integer) -- The Issue comment id
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def create_issue_comment_reaction(repo, id, reaction, options = {})
  options = options.merge(content: reaction)
  post "#{Repository.path repo}/issues/comments/#{id}/reactions", options
end

def create_issue_reaction(repo, number, reaction, options = {})

Returns:
  • () - Hash representing the reaction.

Other tags:
    See: https://developer.github.com/v3/reactions/#reaction-types -
    See: https://developer.github.com/v3/reactions/#create-reaction-for-an-issue -

Parameters:
  • reaction (String) -- The Reaction
  • number (Integer) -- The Issue number
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def create_issue_reaction(repo, number, reaction, options = {})
  options = options.merge(content: reaction)
  post "#{Repository.path repo}/issues/#{number}/reactions", options
end

def create_pull_request_review_comment_reaction(repo, id, reaction, options = {})

Returns:
  • () - Hash representing the reaction.

Other tags:
    See: https://developer.github.com/v3/reactions/#reaction-types -
    See: https://developer.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment -

Parameters:
  • reaction (String) -- The Reaction
  • id (Integer) -- The Issue comment id
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def create_pull_request_review_comment_reaction(repo, id, reaction, options = {})
  options = options.merge(content: reaction)
  post "#{Repository.path repo}/pulls/comments/#{id}/reactions", options
end

def create_release_reaction(repo, release_id, reaction, options = {})

Returns:
  • () - Hash representing the reaction.

Other tags:
    See: https://developer.github.com/v3/reactions/#reaction-types -
    See: https://docs.github.com/en/free-pro-team@latest/rest/reactions/reactions?apiVersion=2022-11-28#create-reaction-for-a-release -

Parameters:
  • reaction (String) -- The Reaction
  • id (Integer) -- The Release id
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def create_release_reaction(repo, release_id, reaction, options = {})
  options = options.merge(content: reaction)
  post "#{Repository.path repo}/releases/#{release_id}/reactions", options
end

def delete_issue_comment_reaction(repo, comment_id, reaction_id, options = {})

Returns:
  • (Boolean) - Return true if reaction was deleted, false otherwise.

Other tags:
    See: https://docs.github.com/en/rest/reactions/reactions#delete-an-issue-comment-reaction -

Parameters:
  • reaction_id (Integer) -- The Reaction id
  • comment_id (Integer) -- The Issue comment id
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def delete_issue_comment_reaction(repo, comment_id, reaction_id, options = {})
  boolean_from_response :delete, "#{Repository.path repo}/issues/comments/#{comment_id}/reactions/#{reaction_id}", options
end

def delete_issue_reaction(repo, issue_id, reaction_id, options = {})

Returns:
  • (Boolean) - Return true if reaction was deleted, false otherwise.

Other tags:
    See: https://docs.github.com/en/rest/reactions/reactions#delete-an-issue-reaction -

Parameters:
  • reaction_id (Integer) -- The Reaction id
  • issue_id (Integer) -- The Issue comment id
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def delete_issue_reaction(repo, issue_id, reaction_id, options = {})
  boolean_from_response :delete, "#{Repository.path repo}/issues/#{issue_id}/reactions/#{reaction_id}", options
end

def delete_release_reaction(repo, release_id, reaction_id, options = {})

Returns:
  • (Boolean) - Return true if reaction was deleted, false otherwise.

Other tags:
    See: https://docs.github.com/en/free-pro-team@latest/rest/reactions/reactions?apiVersion=2022-11-28#delete-a-release-reaction -

Parameters:
  • reaction_id (Integer) -- The Reaction id
  • issue_id (Integer) -- The Release id
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def delete_release_reaction(repo, release_id, reaction_id, options = {})
  boolean_from_response :delete, "#{Repository.path repo}/releases/#{release_id}/reactions/#{reaction_id}", options
end

def issue_comment_reactions(repo, id, options = {})

Returns:
  • (Array) - Array of Hashes representing the reactions.

Other tags:
    See: https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment -

Parameters:
  • id (Integer) -- The Issue comment id
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def issue_comment_reactions(repo, id, options = {})
  get "#{Repository.path repo}/issues/comments/#{id}/reactions", options
end

def issue_reactions(repo, number, options = {})

Returns:
  • (Array) - Array of Hashes representing the reactions.

Other tags:
    See: https://developer.github.com/v3/reactions/#list-reactions-for-an-issue -

Parameters:
  • number (Integer) -- The Issue number
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def issue_reactions(repo, number, options = {})
  get "#{Repository.path repo}/issues/#{number}/reactions", options
end

def pull_request_review_comment_reactions(repo, id, options = {})

Returns:
  • (Array) - Array of Hashes representing the reactions.

Other tags:
    See: https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment -

Parameters:
  • id (Integer) -- The Issue comment id
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def pull_request_review_comment_reactions(repo, id, options = {})
  get "#{Repository.path repo}/pulls/comments/#{id}/reactions", options
end

def release_reactions(repo, release_id, options = {})

Returns:
  • (Array) - Array of Hashes representing the reactions.

Other tags:
    See: https://docs.github.com/en/free-pro-team@latest/rest/reactions/reactions?apiVersion=2022-11-28#list-reactions-for-a-release -

Parameters:
  • id (Integer) -- The Release id
  • repo (Integer, String, Hash, Repository) -- A GitHub repository 
def release_reactions(repo, release_id, options = {})
  get "#{Repository.path repo}/releases/#{release_id}/reactions", options
end