Skip to content

Test-TwitterListSubscription

SYNOPSIS

Tests whether the authenticating user subscribes to the specified list.

SYNTAX

ById (Default)

Test-TwitterListSubscription -Id <String> [-UserName <String>] [<CommonParameters>]

ByList

Test-TwitterListSubscription -List <List> [-UserName <String>] [<CommonParameters>]

DESCRIPTION

Tests whether the authenticating user subscribes to the specified list.

EXAMPLES

Example 1

PS > Test-TwitterListSubscription -Id 1236361374567026688
False

Checks if the authenticating user is subscribed to the specified list.

Example 2

PS > Get-TwitterList -Slug ps7now-blog-week -OwnerUserName WindosNZ | Test-TwitterListSubscription
True

Checks if the authenticating user is subscribed to the specified list.

PARAMETERS

-Id

The id of the list.

Type: String
Parameter Sets: ById
Aliases:

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

-List

A list object retrieved from Get-TwitterList.

Type: List
Parameter Sets: ByList
Aliases:

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

-UserName

The username to verify if they subscribe to the specified list.

Type: String
Parameter Sets: (All)
Aliases:

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

INPUTS

System.String

BluebirdPS.APIV1.List

OUTPUTS

System.Boolean

NOTES

Online Version

Get-TwitterListSubscription

Add-TwitterListSubscription

Remove-TwitterListSubscription

Get-TwitterList

Api Reference - GET lists/subscribers/show