Get-TwitterFriendship

SYNOPSIS

Returns information about the friendships of the authenticating user.

SYNTAX

LookupScreenName (Default)

Get-TwitterFriendship -ScreenName <String[]> [<CommonParameters>]

LookupUserId

Get-TwitterFriendship -UserId <Int32[]> [<CommonParameters>]

ShowScreenName

Get-TwitterFriendship -SourceScreenName <String> -TargetScreenName <String> [<CommonParameters>]

ShowUserId

Get-TwitterFriendship -SourceUserId <Int32> -TargetUserId <Int32> [<CommonParameters>]

Incoming

Get-TwitterFriendship [-Incoming] [<CommonParameters>]

Pending

Get-TwitterFriendship [-Pending] [<CommonParameters>]

NoRetweets

Get-TwitterFriendship [-NoRetweets] [<CommonParameters>]

DESCRIPTION

Returns information about the friendships of the authenticating user.

The information returned depends on the parameters used.

EXAMPLES

Example 1

PS > Get-TwitterFriendship -Pending | ForEach-Object {Get-TwitterUser -UserId $_ | Select-Object -Property screen_name,verified,statuses_count,follow_request_sent,followers_count}

screen_name         : AppInsights
verified            : True
statuses_count      : 251
follow_request_sent : True
followers_count     : 805

Return a list of pending follow requests and then get information about the Twitter users that have been requested to be followed.

PARAMETERS

-Incoming

Returns an array of user ids for every user who has requested to follow the authenticating user.

Type: SwitchParameter
Parameter Sets: Incoming
Aliases:

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

-NoRetweets

Returns an array of user ids that the authenticating user does not want to receive retweets from.

Type: SwitchParameter
Parameter Sets: NoRetweets
Aliases:

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

-Pending

Returns an array of user ids for every protected user for whom the authenticating user has a pending follow request.

Type: SwitchParameter
Parameter Sets: Pending
Aliases:

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

-ScreenName

The screen name of the user for whom to return results.

Type: String[]
Parameter Sets: LookupScreenName
Aliases:

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

-UserId

The ID of the user for whom to return results.

Type: Int32[]
Parameter Sets: LookupUserId
Aliases:

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

-SourceScreenName

The screen name of the source user for whom to return results.

Type: String
Parameter Sets: ShowScreenName
Aliases:

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

-SourceUserId

The ID of the target user for whom to return results.

Type: Int32
Parameter Sets: ShowUserId
Aliases:

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

-TargetScreenName

The screen name of the target user for whom to return results.

Type: String
Parameter Sets: ShowScreenName
Aliases:

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

-TargetUserId

The ID of the target user for whom to return results.

Type: Int32
Parameter Sets: ShowUserId
Aliases:

Required: True
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.