public/helper/Get-TwitterLists_Subscribers.ps1
|
function Get-TwitterLists_Subscribers { <# .SYNOPSIS Create and manage lists .DESCRIPTION GET lists/subscribers subscribers/* Returns the subscribers of the specified list. Private list subscribers will only be shown if the authenticated user owns the specified list. .PARAMETER list_id The numerical id of the list. .PARAMETER slug You can identify a list by its slug instead of its numerical id. If you decide to do so, note that you'll also have to specify the list owner using the owner_id or owner_screen_name parameters. .PARAMETER owner_screen_name The screen name of the user who owns the list being requested by a slug . .PARAMETER owner_id The user ID of the user who owns the list being requested by a slug . .PARAMETER count Specifies the number of results to return per page (see cursor below). The default is 20, with a maximum of 5,000. .PARAMETER cursor Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned in the response body's next_cursor and previous_cursor attributes to page back and forth in the list. See Using cursors to navigate collections for more information. .PARAMETER include_entities When set to either true , t or 1 , each tweet will include a node called "entities". This node offers a variety of metadata about the tweet in a discreet structure, including: user_mentions, urls, and hashtags. While entities are opt-in on timelines at present, they will be made a default component of output in the future. See Tweet Entities for more details. .PARAMETER skip_status When set to either true , t or 1 statuses will not be included in the returned user objects. .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-subscribers #> [CmdletBinding()] Param( [string]$list_id, [string]$slug, [string]$owner_screen_name, [string]$owner_id, [string]$count, [string]$cursor, [string]$include_entities, [string]$skip_status ) Begin { [hashtable]$Parameters = $PSBoundParameters $CmdletBindingParameters | ForEach-Object { $Parameters.Remove($_) } [string]$Method = 'GET' [string]$Resource = '/lists/subscribers' [string]$ResourceUrl = 'https://api.twitter.com/1.1/lists/subscribers.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 } If (-Not $OAuthSettings) { $OAuthSettings = Get-TwitterOAuthSettings -Resource $Resource } Invoke-TwitterAPI -Method $Method -ResourceUrl $ResourceUrl -Parameters $Parameters -OAuthSettings $OAuthSettings } End { } } |