Remove GitHubReaction

Remove-GitHubReaction

SYNOPSIS

Removes a reaction on a given GitHub Issue or Pull Request.

SYNTAX

ElementsIssue (Default)

Remove-GitHubReaction -OwnerName <String> -RepositoryName <String> -Issue <Int64> -ReactionId <Int64> [-Force]
 [-AccessToken <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

ElementsPullRequest

Remove-GitHubReaction -OwnerName <String> -RepositoryName <String> -PullRequest <Int64> -ReactionId <Int64>
 [-Force] [-AccessToken <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

UriPullRequest

Remove-GitHubReaction -Uri <String> -PullRequest <Int64> -ReactionId <Int64> [-Force] [-AccessToken <String>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

UriIssue

Remove-GitHubReaction -Uri <String> -Issue <Int64> -ReactionId <Int64> [-Force] [-AccessToken <String>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Removes a reaction on a given GitHub Issue or Pull Request.

The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub

EXAMPLES

EXAMPLE 1

Remove-GitHubReaction -OwnerName PowerShell -RepositoryName PowerShell -Issue 12626 `
    -ReactionId 1234

Remove a reaction by Id on Issue 12626 from the PowerShell\PowerShell project interactively.

EXAMPLE 2

Remove-GitHubReaction -OwnerName PowerShell -RepositoryName PowerShell -Issue 12626 -ReactionId 1234 -Confirm:$false

Remove a reaction by Id on Issue 12626 from the PowerShell\PowerShell project non-interactively.

EXAMPLE 3

Get-GitHubReaction -OwnerName PowerShell -RepositoryName PowerShell -Issue 12626 -ReactionType rocket | Remove-GitHubReaction -Confirm:$false

Gets a reaction using Get-GitHubReaction and pipes it into Remove-GitHubReaction.

PARAMETERS

-AccessToken

If provided, this will be used as the AccessToken for authentication with the REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

If this switch is specified, you will not be prompted for confirmation of command execution.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Issue

The issue number.

Type: System.Int64
Parameter Sets: ElementsIssue, UriIssue
Aliases: IssueNumber

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-OwnerName

Owner of the repository. If not supplied here, the DefaultOwnerName configuration property value will be used.

Type: System.String
Parameter Sets: ElementsIssue, ElementsPullRequest
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PullRequest

The pull request number.

Type: System.Int64
Parameter Sets: ElementsPullRequest, UriPullRequest
Aliases: PullRequestNumber

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ReactionId

The Id of the reaction. You can get this from using Get-GitHubReaction.

Type: System.Int64
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-RepositoryName

Name of the repository. If not supplied here, the DefaultRepositoryName configuration property value will be used.

Type: System.String
Parameter Sets: ElementsIssue, ElementsPullRequest
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Uri

Uri for the repository. The OwnerName and RepositoryName will be extracted from here instead of needing to provide them individually.

Type: System.String
Parameter Sets: UriPullRequest, UriIssue
Aliases: RepositoryUrl

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

GitHub.Branch

GitHub.Content

GitHub.Event

GitHub.Issue

GitHub.IssueComment

GitHub.Label

GitHub.Milestone

GitHub.PullRequest

GitHub.Project

GitHub.ProjectCard

GitHub.ProjectColumn

GitHub.Reaction

GitHub.Release

GitHub.Repository

OUTPUTS

None

NOTES

Currently, issue comments, pull request comments and commit comments are not supported.

RELATED LINKS