delete_comment: Delete a comment from GitHub

In ChadGoymer/githapi: User-friendly access to the GitHub API for R

Description

This function deletes a comment from a gist, issue, pull request or commit, as long as you have appropriate permissions. Care should be taken as it will not be recoverable.

Usage

delete_comment(comment, gist, repo, type = "gist", ...)

Arguments

comment	(integer) The id of the comment.
gist	(string, optional) The ID of the gist.
repo	(string) The repository specified in the format: owner/repo.
type	(string, optional) Whether the comment is for a "gist", "issue", "pull_request" or "commit". Default: "gist".
...	Parameters passed to gh_request().

Details

For more details see the GitHub API documentation:

• https://docs.github.com/en/rest/reference/gists#delete-a-gist-comment

• https://docs.github.com/en/rest/reference/issues#delete-an-issue-comment

• https://docs.github.com/en/rest/reference/pulls#delete-a-review-comment-for-a-pull-request

• https://docs.github.com/en/rest/reference/repos#delete-a-commit-comment

Value

delete_comment() returns a TRUE if successfully deleted.

Examples

## Not run: 

  # Delete a gist comment
  delete_comment(
    comment = 622980929,
    gist    = "8e5be270de9a88168372293a813543f9"
  )

  # Delete a issue comment
  delete_comment(
    comment = 622980929,
    type    = "issue",
    repo    = "ChadGoymer/githapi"
  )

  # Delete a pull request comment
  delete_comment(
    comment = 418979473,
    type    = "pull_request",
    repo    = "ChadGoymer/githapi"
  )

  # Delete a commit comment
  delete_comment(
    comment = 38899533,
    type    = "commit",
    repo    = "ChadGoymer/githapi"
  )


## End(Not run)

ChadGoymer/githapi documentation built on Oct. 22, 2021, 10:56 a.m.