Get GitHubUserContextualInformation - X-Guardian/PowerShellForGitHub GitHub Wiki
Retrieves contextual information about the specified user on GitHub.
Get-GitHubUserContextualInformation -UserName <String> [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm]
[<CommonParameters>]
Get-GitHubUserContextualInformation -UserName <String> -OrganizationId <Int64> [-AccessToken <String>]
[-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
Get-GitHubUserContextualInformation -UserName <String> -RepositoryId <Int64> [-AccessToken <String>]
[-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
Get-GitHubUserContextualInformation -UserName <String> -IssueId <Int64> [-AccessToken <String>] [-NoStatus]
[-WhatIf] [-Confirm] [<CommonParameters>]
Get-GitHubUserContextualInformation -UserName <String> -PullRequestId <Int64> [-AccessToken <String>]
[-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
Retrieves contextual information about the specified user on GitHub.
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
Get-GitHubUserContextualInformation -User octocat
Get-GitHubUserContextualInformation -User octocat -RepositoryId 1300192
$repo = Get-GitHubRepository -OwnerName microsoft -RepositoryName 'PowerShellForGitHub'
$repo | Get-GitHubUserContextualInformation -User octocat
Get-GitHubIssue -OwnerName microsoft -RepositoryName PowerShellForGitHub -Issue 70 |
Get-GitHubUserContextualInformation -User octocat
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
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
If this switch is specified, long-running commands will run on the main thread with no commandline status update. When not specified, those commands run in the background, enabling the command prompt to provide status information. If not supplied here, the DefaultNoStatus configuration property value will be used.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
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
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
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
{{ 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
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
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
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.