Remove-TwitterFriend
SYNOPSIS
Allows the authenticating user to unfollow another Twitter user.
SYNTAX
ById (Default)
Remove-TwitterFriend -Id <String> [-WhatIf] [-Confirm] [<CommonParameters>]
ByUser
Remove-TwitterFriend -User <User> [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Allows the authenticating user to unfollow another Twitter user.
EXAMPLES
Example 1
PS > Remove-TwitterFriend -Id 1330877955057344513
Confirm
Are you sure you want to perform this action?
Performing the operation "Unfollow user" on target "1330877955057344513".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
Following user 1330877955057344513: False.
Unfollow the specified user.
Example 2
PS > Get-TwitterFriend -UserName BluebirdPS | Remove-TwitterFriend
Confirm
Are you sure you want to perform this action?
Performing the operation "Unfollow user" on target "1330877955057344513".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y
Following user 1330877955057344513: False.
Unfollow the specified user.
PARAMETERS
-Id
Specifies the id of the user to unfollow.
Type: System.String
Parameter Sets: ById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-User
The user object, returned by Get-TwitterUser, to be unfollowed.
Type: BluebirdPS.APIV2.UserInfo.User
Parameter Sets: ByUser
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
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: False
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
System.String
BluebirdPS.APIV2.UserInfo.User
OUTPUTS
System.String
NOTES
RELATED LINKS
Api Reference - DELETE /2/users/:source_user_id/following/:target_user_id