public/helper/Get-TwitterLists_list.ps1
|
function Get-TwitterLists_List { <# .SYNOPSIS Create and manage lists .DESCRIPTION GET lists/list Returns all lists the authenticating or specified user subscribes to, including their own. The user is specified using the user_id or screen_name parameters. If no user is given, the authenticating user is used. A maximum of 100 results will be returned by this call. Subscribed lists are returned first, followed by owned lists. This means that if a user subscribes to 90 lists and owns 20 lists, this method returns 90 subscriptions and 10 owned lists. The reverse method returns owned lists first, so with reverse=true, 20 owned lists and 80 subscriptions would be returned. If your goal is to obtain every list a user owns or subscribes to, use GET lists / ownerships and/or GET lists / subscriptions instead. .PARAMETER user_id The ID of the user for whom to return results. Helpful for disambiguating when a valid user ID is also a valid screen name. Note: : Specifies the ID of the user to get lists from. Helpful for disambiguating when a valid user ID is also a valid screen name. .PARAMETER screen_name The screen name of the user for whom to return results. Helpful for disambiguating when a valid screen name is also a user ID. .PARAMETER reverse Set this to true if you would like owned lists to be returned first. See description above for information on how this parameter works. .NOTES This helper function was generated by the information provided here: https://developer.twitter.com/en/docs/accounts-and-users/create-manage-lists/api-reference/get-lists-list #> [CmdletBinding()] Param( [string]$user_id, [string]$screen_name, [string]$reverse ) Begin { [hashtable]$Parameters = $PSBoundParameters $CmdletBindingParameters | ForEach-Object { $Parameters.Remove($_) } [string]$Method = 'GET' [string]$Resource = '/lists/list' [string]$ResourceUrl = 'https://api.twitter.com/1.1/lists/list.json' } Process { # Find & Replace any ResourceUrl parameters. $UrlParameters = [regex]::Matches($ResourceUrl, '(?<!\w):\w+') ForEach ($UrlParameter in $UrlParameters) { $UrlParameterValue = $Parameters["$($UrlParameter.Value.TrimStart(":"))"] $ResourceUrl = $ResourceUrl -Replace $UrlParameter.Value, $UrlParameterValue } $OAuthSettings = Get-TwitterOAuthSettings -Resource $Resource Invoke-TwitterAPI -Method $Method -ResourceUrl $ResourceUrl -Parameters $Parameters -OAuthSettings $OAuthSettings } End { } } |