Get GitHubUserContextualInformation

Get-GitHubUserContextualInformation

SYNOPSIS

Retrieves contextual information about the specified user on GitHub.

SYNTAX

NoContext (Default)

Get-GitHubUserContextualInformation -UserName <String> [-AccessToken <String>] [<CommonParameters>]

Organization

Get-GitHubUserContextualInformation -UserName <String> -OrganizationId <Int64> [-AccessToken <String>]
 [<CommonParameters>]

Repository

Get-GitHubUserContextualInformation -UserName <String> -RepositoryId <Int64> [-AccessToken <String>]
 [<CommonParameters>]

Issue

Get-GitHubUserContextualInformation -UserName <String> -IssueId <Int64> [-AccessToken <String>]
 [<CommonParameters>]

PullRequest

Get-GitHubUserContextualInformation -UserName <String> -PullRequestId <Int64> [-AccessToken <String>]
 [<CommonParameters>]

DESCRIPTION

Retrieves contextual information about the specified user on GitHub.

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

EXAMPLES

EXAMPLE 1

Get-GitHubUserContextualInformation -User octocat

EXAMPLE 2

Get-GitHubUserContextualInformation -User octocat -RepositoryId 1300192

EXAMPLE 3

$repo = Get-GitHubRepository -OwnerName microsoft -RepositoryName 'PowerShellForGitHub'
$repo | Get-GitHubUserContextualInformation -User octocat

EXAMPLE 4

Get-GitHubIssue -OwnerName microsoft -RepositoryName PowerShellForGitHub -Issue 70 |
    Get-GitHubUserContextualInformation -User octocat

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

-IssueId

The ID for a Issue. When provided, this returns back the context for the user in relation to this Issue. NOTE: This is the id of the issue and not the issue number.

Type: System.Int64
Parameter Sets: Issue
Aliases:

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

-OrganizationId

The ID of an Organization. When provided, this returns back the context for the user in relation to this Organization.

Type: System.Int64
Parameter Sets: Organization
Aliases:

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

-PullRequestId

The ID for a PullRequest. When provided, this returns back the context for the user in relation to this Pull Request. NOTE: This is the id of the pull request and not the pull request number.

Type: System.Int64
Parameter Sets: PullRequest
Aliases:

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

-RepositoryId

The ID for a Repository. When provided, this returns back the context for the user in relation to this Repository.

Type: System.Int64
Parameter Sets: Repository
Aliases:

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

-UserName

{{ Fill UserName Description }}

Type: System.String
Parameter Sets: (All)
Aliases: User, Name

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
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.Issue

GitHub.Organization

GitHub.PullRequest

GitHub.Repository

GitHub.User

OUTPUTS

GitHub.UserContextualInformation

NOTES

RELATED LINKS