Get GitHubGistComment

Get-GitHubGistComment

SYNOPSIS

Retrieves comments for a specific gist from GitHub.

SYNTAX

Get-GitHubGistComment [-Gist] <String> [-Comment <Int64>] [-MediaType <String>] [-AccessToken <String>]
 [<CommonParameters>]

DESCRIPTION

Retrieves comments for a specific gist from GitHub.

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

EXAMPLES

EXAMPLE 1

Get-GitHubGistComment -Gist 6cad326836d38bd3a7ae

Gets all comments on octocat's "hello_world.rb" gist.

EXAMPLE 2

Get-GitHubGistComment -Gist 6cad326836d38bd3a7ae -Comment 1507813

Gets comment 1507813 from octocat's "hello_world.rb" gist.

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

-Comment

The ID of the specific comment on the gist that you wish to retrieve.

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

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

-Gist

The ID of the specific gist that you wish to retrieve the comments for.

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

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

-MediaType

The format in which the API will return the body of the comment.

Raw - Return the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. Text - Return a text only representation of the markdown body. Response will include body_text. Html - Return HTML rendered from the body's markdown. Response will include body_html. Full - Return raw, text and HTML representations. Response will include body, body_text, and body_html.

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

Required: False
Position: Named
Default value: Full
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.Gist

GitHub.GistComment

GitHub.GistCommit

GitHub.GistFork

GitHub.GistSummary

OUTPUTS

GitHub.GistComment

NOTES

RELATED LINKS