Test-GitHubUserFollowing

SYNOPSIS

Check if a given user or the authenticated user follows a person

SYNTAX

__AllParameterSets

Test-GitHubUserFollowing [-Follows] <string> [-Username] <string> [[-Context] <Object>]
 [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

Returns a 204 if the given user or the authenticated user follows another user. Returns a 404 if the user is not followed by a given user or the authenticated user.

EXAMPLES

EXAMPLE 1

Test-GitHubUserFollowing -Follows 'octocat'
Test-GitHubUserFollowing 'octocat'

Checks if the authenticated user follows the user 'octocat'.

EXAMPLE 2

Test-GitHubUserFollowing -Username 'octocat' -Follows 'ratstallion'

Checks if the user 'octocat' follows the user 'ratstallion'.

PARAMETERS

-Context

The context to run the command in. Used to get the details for the API call. Can be either a string or a GitHubContext object.

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 2
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Follows

The handle for the GitHub user account we want to check if is being followed.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Username

The handle for the GitHub user account.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

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

INPUTS

System.String

{{ Fill in the Description }}

OUTPUTS

System.Boolean

{{ Fill in the Description }}

NOTES

Check if a person is followed by the authenticated user Check if a user follows another user

RELATED LINKS