Skip to content

Test-TwitterListMembership

SYNOPSIS

Tests if a specified user is a member of the specified list.

SYNTAX

Id (Default)

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

ByList

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

DESCRIPTION

Tests if a specified user is a member of the specified list.

If the specified user is a member of the specified list, returns true, otherwise returns false.

EXAMPLES

Example 1

PS > Test-TwitterListMembership -Id 1015226053856546816 -UserName thetommymaynard
True

Checks if user thetommymaynard is a member of the specified list.

Example 2

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

Checks if the authenticating user is a member of the specified list.

PARAMETERS

-Id

The id of the list.

Type: String
Parameter Sets: Id
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 are a member of 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-TwitterListMembership

Api Reference - GET lists/members/show