en-US/BluebirdPS-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-TwitterSavedSearch</command:name> <command:verb>Add</command:verb> <command:noun>TwitterSavedSearch</command:noun> <maml:description> <maml:para>Create a new saved search for the authenticated user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a new saved search for the authenticated user.</maml:para> <maml:para>Note: A user may only have 25 saved searches.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-TwitterSavedSearch</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>The query of the search the user would like to save.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>The query of the search the user would like to save.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV1.SavedSearch</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Add-TwitterSavedSearch -SearchString '(#pwsh_eats)' Id CreatedAt Name Query -- --------- ---- ----- 1399362817376014341 5/31/2021 8:51:09 AM (#pwsh_eats) (#pwsh_eats)</dev:code> <dev:remarks> <maml:para>Add a new saved search for the #pwsh_eats hashtag.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Account%20Settings%2C%20User%20Profile%2C%20and%20Saved%20Searches/Add-TwitterSavedSearch</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterSavedSearch</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Account%20Settings%2C%20User%20Profile%2C%20and%20Saved%20Searches/Get-TwitterSavedSearch</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TwitterSavedSearch</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Account%20Settings%2C%20User%20Profile%2C%20and%20Saved%20Searches/Remove-TwitterSavedSearch</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - Search Standard Operators</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/rules-and-filtering/overview/standard-operators</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - POST saved_searches/create</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-create</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterAccountSettings</command:name> <command:verb>Get</command:verb> <command:noun>TwitterAccountSettings</command:noun> <maml:description> <maml:para>Returns the settings for the authenticating user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the settings for the authenticating user.</maml:para> <maml:para>This includes current trend, geo and sleep time information.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterAccountSettings</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV1.AccountSettings</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterAccountSettings</dev:code> <dev:remarks> <maml:para>Returns the settings for the authenticating user.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Account%20Settings%2C%20User%20Profile%2C%20and%20Saved%20Searches/Get-TwitterAccountSettings</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET account/settings</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-account-settings</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterSavedSearch</command:name> <command:verb>Get</command:verb> <command:noun>TwitterSavedSearch</command:noun> <maml:description> <maml:para>Returns one or all of the authenticating user's saved searches.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns one or all of the authenticating user's saved searches.</maml:para> <maml:para>A user can have up to 25 saved searches.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterSavedSearch</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the saved search.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the saved search.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV1.SavedSearch</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV1.SavedSearch[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterSavedSearch Id CreatedAt Name Query -- --------- ---- ----- 1316223626610343936 10/13/2020 10:45:41 PM (from:JeffHicks) (#PSTweetChat) (from:JeffHicks) (#PSTweetChat) 1325982551094210566 11/9/2020 8:04:10 PM (#pwsh_eats) (#pwsh_eats) 1332794582241828864 11/28/2020 3:12:45 PM (#pstweetchat) since:2020-12-04 (#pstweetchat) since:2020-12-04 1382838043116249093 4/15/2021 6:27:36 PM (#PSHSummit) (since:2021-04-10) (#PSHSummit) (since:2021-04-10) 1392896190300229640 5/13/2021 12:35:05 PM #PSFollowFriday #PSFollowFriday</dev:code> <dev:remarks> <maml:para>Returns all of the authenticating user's saved searches.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterSavedSearch -Id 1316223626610343936 Id CreatedAt Name Query -- --------- ---- ----- 1316223626610343936 10/13/2020 10:45:41 PM (from:JeffHicks) (#PSTweetChat) (from:JeffHicks) (#PSTweetChat)</dev:code> <dev:remarks> <maml:para>Returns the authenticating user's specified saved search.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Account%20Settings%2C%20User%20Profile%2C%20and%20Saved%20Searches/Get-TwitterSavedSearch</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TwitterSavedSearch</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Account%20Settings%2C%20User%20Profile%2C%20and%20Saved%20Searches/Add-TwitterSavedSearch</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TwitterSavedSearch</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Account%20Settings%2C%20User%20Profile%2C%20and%20Saved%20Searches/Remove-TwitterSavedSearch</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET saved_searches/list</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET saved_searches/show/:id</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-show-id</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterUserProfileBanner</command:name> <command:verb>Get</command:verb> <command:noun>TwitterUserProfileBanner</command:noun> <maml:description> <maml:para>Returns a map of the available size variations of the specified user's profile banner.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a map of the available size variations of the specified user's profile banner.</maml:para> <maml:para>The profile banner data available at each size variant's URL is in PNG format.</maml:para> <maml:para>NOTE: This command currently returns the raw API response.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterUserProfileBanner</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The user name of the Twitter user for which you want to retrieve profile banner details.</maml:para> <maml:para>If you do not specify a UserName, it will return the profile banner details for the authenticating user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>The user name of the Twitter user for which you want to retrieve profile banner details.</maml:para> <maml:para>If you do not specify a UserName, it will return the profile banner details for the authenticating user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterUserProfileBanner | ForEach-Object sizes ipad : @{h=313; w=626; url=https://pbs.twimg.com/profile_banners/292670084/1600359337/ipad} ipad_retina : @{h=626; w=1252; url=https://pbs.twimg.com/profile_banners/292670084/1600359337/ipad_retina} web : @{h=260; w=520; url=https://pbs.twimg.com/profile_banners/292670084/1600359337/web} web_retina : @{h=520; w=1040; url=https://pbs.twimg.com/profile_banners/292670084/1600359337/web_retina} mobile : @{h=160; w=320; url=https://pbs.twimg.com/profile_banners/292670084/1600359337/mobile} mobile_retina : @{h=320; w=640; url=https://pbs.twimg.com/profile_banners/292670084/1600359337/mobile_retina} 300x100 : @{h=100; w=300; url=https://pbs.twimg.com/profile_banners/292670084/1600359337/300x100} 600x200 : @{h=200; w=600; url=https://pbs.twimg.com/profile_banners/292670084/1600359337/600x200} 1500x500 : @{h=500; w=1500; url=https://pbs.twimg.com/profile_banners/292670084/1600359337/1500x500} 1080x360 : @{h=360; w=1080; url=https://pbs.twimg.com/profile_banners/292670084/1600359337/1080x360}</dev:code> <dev:remarks> <maml:para>Returns a map of the available size variations of the specified user's profile banner.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Account%20Settings%2C%20User%20Profile%2C%20and%20Saved%20Searches/Get-TwitterUserProfileBanner</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET users/profile_banner</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-users-profile_banner</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-TwitterSavedSearch</command:name> <command:verb>Remove</command:verb> <command:noun>TwitterSavedSearch</command:noun> <maml:description> <maml:para>Deletes the specified saved search belonging to the authenticating user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes the specified saved search belonging to the authenticating user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-TwitterSavedSearch</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the saved search.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-TwitterSavedSearch</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SavedSearch</maml:name> <maml:description> <maml:para>A SavedSearch object returned from Get-TwitterSavedSearch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV1.SavedSearch</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV1.SavedSearch</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the saved search.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SavedSearch</maml:name> <maml:description> <maml:para>A SavedSearch object returned from Get-TwitterSavedSearch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV1.SavedSearch</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV1.SavedSearch</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Remove-TwitterSavedSearch -Id 1225849015092367362 Confirm Are you sure you want to perform this action? Performing the operation "Removing Saved Search" on target "Search : (#PoShEvents) (from:thedavecarroll), Created: Fri Feb 07 18:29:15 +0000 2020". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y</dev:code> <dev:remarks> <maml:para>Deletes the specified saved search belonging to the authenticating user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterSavedSearch -Id 1325982551094210566 | Remove-TwitterSavedSearch Confirm Are you sure you want to perform this action? Performing the operation "Removing Saved Search" on target "Search: (#pwsh_eats), Created: 11/9/2020 8:04:10 PM". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y</dev:code> <dev:remarks> <maml:para>Gets the specified saved search then deletes it, if belonging to the authenticating user.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Account%20Settings%2C%20User%20Profile%2C%20and%20Saved%20Searches/Remove-TwitterSavedSearch</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterSavedSearch</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Account%20Settings%2C%20User%20Profile%2C%20and%20Saved%20Searches/Get-TwitterSavedSearch</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TwitterSavedSearch</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Account%20Settings%2C%20User%20Profile%2C%20and%20Saved%20Searches/Add-TwitterSavedSearch</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - POST saved_searches/destroy/:id</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-destroy-id</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-TwitterAuthentication</command:name> <command:verb>Export</command:verb> <command:noun>TwitterAuthentication</command:noun> <maml:description> <maml:para>Export the current user's authentication credentials to an encrypted file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Export the current user's authentication credentials to an encrypted file.</maml:para> <maml:para>The encrypted credentials file will be stored in the folder $env:HOME/.BluebirdPS.</maml:para> <maml:para>The credentials are the API Key, API Key Secret, Access Token, Access Token Secret, and, the bearer token for OAuth 2.0.</maml:para> <maml:para>This command will update the BluebirdPS configuration value AuthLastExportDate in the current session and Export-BluebirdPSConfiguration to save the configuration values.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-TwitterAuthentication</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Export-TwitterAuthentication</dev:code> <dev:remarks> <maml:para>Exports the sessions current credentials to an encrypted file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Export-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-TwitterAuthentication</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Import-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TwitterAuthentication</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Set-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-TwitterAuthentication</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Test-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - Authentication Overview</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/authentication/overview</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Import-TwitterAuthentication</command:name> <command:verb>Import</command:verb> <command:noun>TwitterAuthentication</command:noun> <maml:description> <maml:para>Import the current user's authentication credentials from specific environment variables or an encrypted credentials file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Import the current user's authentication credentials from specific environment variables or an encrypted credentials file.</maml:para> <maml:para>The authentication data will be imported from specific environment variables in preference to data in the encrypted credentials file.</maml:para> <maml:para>The following environment variables must be used to set the BluebirdPS authentication credentials.</maml:para> <maml:para>BLUEBIRDPS_API_KEY, BLUEBIRDPS_API_SECRET, BLUEBIRDPS_ACCESS_TOKEN, BLUEBIRDPS_ACCESS_TOKEN_SECRET, BLUEBIRDPS_BEARER_TOKEN</maml:para> <maml:para>If the required environment variables are not set, this command will attempt to import authentication data from the encrypted credentials file.</maml:para> <maml:para>The encrypted credentials file will be stored in the folder $env:HOME/.BluebirdPS.</maml:para> <maml:para>The credentials are the API Key, API Key Secret, Access Token, Access Token Secret, and, if present, the bearer token for OAuth 2.0.</maml:para> <maml:para>This essentially refreshes the session variable with the credentials from the encrypted file.</maml:para> <maml:para>This command is called when the module is imported.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-TwitterAuthentication</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Import-TwitterAuthentication</dev:code> <dev:remarks> <maml:para>Import the current user's authentication credentials from specific environment variables or an encrypted credentials file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Import-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-TwitterAuthentication</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Export-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TwitterAuthentication</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Set-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-TwitterAuthentication</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Test-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - Authentication Overview</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/authentication/overview</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-TwitterAuthentication</command:name> <command:verb>Set</command:verb> <command:noun>TwitterAuthentication</command:noun> <maml:description> <maml:para>Set the session credential variable and export verified credentials to an encrypted file.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set the session credential variable and export verified credentials to an encrypted file.</maml:para> <maml:para>The credentials are the API Key, API Key Secret, Access Token, Access Token Secret, and, if present, the bearer token for OAuth 2.0.</maml:para> <maml:para>The provided credentials are validated using Test-TwitterAuthentication and, if valid, are used to request the bearer token via Set-TwitterBearerToken. This command also updates the BluebirdPS Configuration with the authenticating user's Id and UserName. Lastly, it exports the updated session credential variable using Export-TwitterAuthentication.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-TwitterAuthentication</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>The API key, also sometimes called the consumer key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ApiSecret</maml:name> <maml:description> <maml:para>The API secret, also sometimes called the consumer secret.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>The access token for the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>AccessTokenSecret</maml:name> <maml:description> <maml:para>The access token secret for the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>ApiKey</maml:name> <maml:description> <maml:para>The API key, also sometimes called the consumer key.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ApiSecret</maml:name> <maml:description> <maml:para>The API secret, also sometimes called the consumer secret.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>The access token for the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>AccessTokenSecret</maml:name> <maml:description> <maml:para>The access token secret for the user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Security.SecureString</command:parameterValue> <dev:type> <maml:name>System.Security.SecureString</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Set-TwitterAuthentication API Key: ************************* API Secret: ************************************************** Access Token: ************************************************** Access Token Secret: *********************************************</dev:code> <dev:remarks> <maml:para>Set the credentials and save to an encrypted file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Set-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-TwitterAuthentication</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Test-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-TwitterAuthentication</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Import-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-TwitterAuthentication</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Export-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - Authentication Overview</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/authentication/overview</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-TwitterBearerToken</command:name> <command:verb>Set</command:verb> <command:noun>TwitterBearerToken</command:noun> <maml:description> <maml:para>The Set-TwitterBearerToken command receives and sets the user's OAuth 2.0 bearer token credential.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The Set-TwitterBearerToken command receives and sets the user's OAuth 2.0 bearer token credential.</maml:para> <maml:para>The command sends the user's API key and API key secret to the Twitter and receives the bearer token which is saved in the session variable.</maml:para> <maml:para>Additionally, it exports the updated session credential variable using Export-TwitterAuthentication. The encrypted credentials file will be stored in the folder $env:HOME/.BluebirdPS.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-TwitterBearerToken</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Set-TwitterBearerToken</dev:code> <dev:remarks> <maml:para>Set the user's bearer token and save the session credentials in the folder $env:HOME/.BluebirdPS.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Set-TwitterBearerToken</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-TwitterAuthentication</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Import-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-TwitterAuthentication</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Export-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-TwitterAuthentication</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Test-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - Authentication Overview</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/authentication/overview</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-TwitterAuthentication</command:name> <command:verb>Show</command:verb> <command:noun>TwitterAuthentication</command:noun> <maml:description> <maml:para>Display the current values for ApiKey, ApiSecret, AccessToken, AccessTokenSecret, and BearerToken.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Display the current values for ApiKey, ApiSecret, AccessToken, AccessTokenSecret, and BearerToken.</maml:para> <maml:para>This allows you to verify the values entered.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Show-TwitterAuthentication</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.TwitterAuthentication</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Show-TwitterAuthentication Confirm Are you sure you want to perform this action? Performing the operation "Show" on target "Twitter Authentication". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y ApiKey : T...B ApiSecret : Y...3 AccessToken : 2...4-A...z AccessTokenSecret : H...d BearerToken : A...n</dev:code> <dev:remarks> <maml:para>Display the current values for ApiKey, ApiSecret, AccessToken, AccessTokenSecret, and BearerToken.</maml:para> <maml:para>Note: The output is truncated. Your values will be unique with a greater length.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Show-TwitterAuthentication/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Show-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TwitterAuthentication</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Set-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-TwitterAuthentication</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Import-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-TwitterAuthentication</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Export-TwitterAuthentication</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-TwitterAuthentication</command:name> <command:verb>Test</command:verb> <command:noun>TwitterAuthentication</command:noun> <maml:description> <maml:para>The command Test-TwitterAuthentication is used to validate the user's credentials.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>The command Test-TwitterAuthentication is used to validate the user's credentials.</maml:para> <maml:para>It will test the user's OAuth 1.0a credentials, or, by using the BearerToken switch, will test the user's OAuth 2 bearer token.</maml:para> <maml:para>This command will update the BluebirdPS configuration property AuthValidationDate with the current date and then Export-BluebirdPSConfiguration.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-TwitterAuthentication</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BearerToken</maml:name> <maml:description> <maml:para>Instructs the command to test the user's OAuth 2.0 bearer token.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BearerToken</maml:name> <maml:description> <maml:para>Instructs the command to test the user's OAuth 2.0 bearer token.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Test-TwitterAuthentication</dev:code> <dev:remarks> <maml:para>Returns true if the user's OAuth 1.0a credentials are valid, otherwise it will return false.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Test-TwitterAuthentication -BearerToken</dev:code> <dev:remarks> <maml:para>Returns true if the user's OAuth 2.0 bearer token is valid, otherwise it will return false.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Authentication/Test-TwitterAuthentication</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/users/me</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-me</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterDM</command:name> <command:verb>Get</command:verb> <command:noun>TwitterDM</command:noun> <maml:description> <maml:para>Returns one or more direct messages.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns one or more direct messages.</maml:para> <maml:para>If the Id is omitted, all DMs from the last 30 days will be returned in reverse chronological order.</maml:para> <maml:para>NOTE: The direct_messages/events/list endpoint has a low rate limit (15) and most likely you will reach this when not specifying a direct message id.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterDM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>MessageCount</maml:name> <maml:description> <maml:para>The number of messages to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the direct message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the direct message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>MessageCount</maml:name> <maml:description> <maml:para>The number of messages to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV1.DirectMessage</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV1.DirectMessage[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterDM</dev:code> <dev:remarks> <maml:para>Returns a list of all DMs from the last 30 days.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterDM -Id 1396421634874019846 Id : 1396421634874019846 SenderId : 292670084 RecipientId : 1330877955057344513 CreatedAt : 5/23/2021 6:03:56 AM Message : Testing back https://t.co/oItJzXPiW4 Media : Id: 1396421586308173827, Type: Photo, DisplayUrl: pic.twitter.com/oItJzXPiW4 SourceAppId : 3033300</dev:code> <dev:remarks> <maml:para>Returns the direct message specified.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Direct%20Message/Get-TwitterDM</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-TwitterDM</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Direct%20Message/Publish-TwitterDM</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unpublish-TwitterDM</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Direct%20Message/Unpublish-TwitterDM</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET direct_messages/events/list</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/list-events</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET direct_messages/events/show</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/get-event</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Publish-TwitterDM</command:name> <command:verb>Publish</command:verb> <command:noun>TwitterDM</command:noun> <maml:description> <maml:para>Publishes a new direct message to a specified user from the authenticating user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Publishes a new direct message to a specified user from the authenticating user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Publish-TwitterDM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>The text of your Direct Message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>MediaId</maml:name> <maml:description> <maml:para>The MediaId returned from the Send-TwitterMedia command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the direct message recipient by Twitter user id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Publish-TwitterDM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>The text of your Direct Message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the direct message recipient by Twitter user id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the full path to the media file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Specifies the type and use for the uploaded media.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">DMImage</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DMVideo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DMGif</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AltImageText</maml:name> <maml:description> <maml:para>Provide additional information about the images or GIFs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Publish-TwitterDM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>The text of your Direct Message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the direct message recipient by Twitter user object, returned by Get-TwitterUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the full path to the media file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Specifies the type and use for the uploaded media.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">DMImage</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DMVideo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DMGif</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AltImageText</maml:name> <maml:description> <maml:para>Provide additional information about the images or GIFs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Publish-TwitterDM</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>The text of your Direct Message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>MediaId</maml:name> <maml:description> <maml:para>The MediaId returned from the Send-TwitterMedia command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the direct message recipient by Twitter user object, returned by Get-TwitterUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">User</command:parameterValue> <dev:type> <maml:name>User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Message</maml:name> <maml:description> <maml:para>The text of your Direct Message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the direct message recipient by Twitter user id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>Specifies the direct message recipient by Twitter user object, returned by Get-TwitterUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>MediaId</maml:name> <maml:description> <maml:para>The MediaId returned from the Send-TwitterMedia command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the full path to the media file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Specifies the type and use for the uploaded media.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AltImageText</maml:name> <maml:description> <maml:para>Provide additional information about the images or GIFs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV1.DirectMessage</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Publish-TwitterDM -UserId 123456789 -Message "Did you hear about the release of #PowerShell 7.1?"</dev:code> <dev:remarks> <maml:para>Send the string message to the specified user as a direct message.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User BluebirdPS | Publish-TwitterDM -Message 'Are you excited about the upcoming release of BluebirdPS?' -Path $PathToFile -Category DMImage -AltImageText 'Good to have alt-img-text for screen readers' Id : 1396582297319747588 SenderId : 292670084 RecipientId : 1330877955057344513 CreatedAt : 5/23/2021 4:42:21 PM Message : Are you excited about the upcoming release of BluebirdPS? https://t.co/zA8bPmHskI Media : Id: 1396582290713686016, Type: Photo, DisplayUrl: pic.twitter.com/zA8bPmHskI SourceAppId :</dev:code> <dev:remarks> <maml:para>Send the string message to the specified user as a direct message.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Direct%20Message/Publish-TwitterDM</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterDM</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Direct%20Message/Get-TwitterDM</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Unpublish-TwitterDM</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Direct%20Message/Unpublish-TwitterDM</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET direct_messages/events/list</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/new-event</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unpublish-TwitterDM</command:name> <command:verb>Unpublish</command:verb> <command:noun>TwitterDM</command:noun> <maml:description> <maml:para>Deletes the direct message specified by the DirectMessageId parameter.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Deletes the direct message specified by the DirectMessageId parameter.</maml:para> <maml:para>The authenticating user must be the recipient of the specified direct message. Direct Messages are only removed from the interface of the user context provided. Other members of the conversation can still access the Direct Messages.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unpublish-TwitterDM</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the direct message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Unpublish-TwitterDM</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TwitterDM</maml:name> <maml:description> <maml:para>A DirectMessage object retrieved from Get-TwitterDM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV1.DirectMessage</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV1.DirectMessage</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the direct message.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>TwitterDM</maml:name> <maml:description> <maml:para>A DirectMessage object retrieved from Get-TwitterDM.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV1.DirectMessage</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV1.DirectMessage</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV1.DirectMessage</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Unpublish-TwitterDM -DirectMessageId 9876543210123</dev:code> <dev:remarks> <maml:para>Deletes the direct message specified by the DirectMessageId parameter.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Direct%20Message/Unpublish-TwitterDM</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterDM</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Direct%20Message/Get-TwitterDM</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-TwitterDM</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Direct%20Message/Publish-TwitterDM</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - DELETE direct_messages/events/destroy</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/direct-messages/sending-and-receiving/api-reference/delete-message-event</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>ConvertFrom-EpochTime</command:name> <command:verb>ConvertFrom</command:verb> <command:noun>EpochTime</command:noun> <maml:description> <maml:para>Convert from UNIX epoch time.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Convert from UNIX epoch time.</maml:para> <maml:para>This command will determine if the provided UNIX time is seconds or milliseconds.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertFrom-EpochTime</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>UnixTime</maml:name> <maml:description> <maml:para>The UNIX epoch time, either seconds or milliseconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>UnixTime</maml:name> <maml:description> <maml:para>The UNIX epoch time, either seconds or milliseconds.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.DateTime</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > ConvertFrom-EpochTime -UnixTime 1621809982 Sunday, May 23, 2021 5:46:22 PM</dev:code> <dev:remarks> <maml:para>Convert from epoch time.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > ConvertFrom-EpochTime -UnixTime 1621723222000 Saturday, May 22, 2021 5:40:22 PM</dev:code> <dev:remarks> <maml:para>Convert from epoch time.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/ConvertFrom-EpochTime</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertFrom-TwitterV1Date</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/ConvertFrom-TwitterV1Date</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>ConvertFrom-TwitterV1Date</command:name> <command:verb>ConvertFrom</command:verb> <command:noun>TwitterV1Date</command:noun> <maml:description> <maml:para>Convert a date retrieved from an API v1.1 endpoint to [DateTime].</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Convert a date retrieved from an API v1.1 endpoint to [DateTime].</maml:para> <maml:para>Converts a UTC date in the format '%a %b %d %H:%M:%S +0000 %Y' to [DateTime] format.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>ConvertFrom-TwitterV1Date</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Date</maml:name> <maml:description> <maml:para>A Twitter API v1.1 date string, in the format of '%a %b %d %H:%M:%S +0000 %Y'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Date</maml:name> <maml:description> <maml:para>A Twitter API v1.1 date string, in the format of '%a %b %d %H:%M:%S +0000 %Y'.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > 'Sat May 04 15:30:39 +0000 2019' | ConvertFrom-TwitterV1Date Saturday, May 4, 2019 10:30:39 AM</dev:code> <dev:remarks> <maml:para>Convert a Twitter V1 date from the pipeline.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/ConvertFrom-TwitterV1Date</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>ConvertFrom-EpochTime</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/ConvertFrom-EpochTime</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Export-BluebirdPSConfiguration</command:name> <command:verb>Export</command:verb> <command:noun>BluebirdPSConfiguration</command:noun> <maml:description> <maml:para>Export the current BluebirdPS configuration to disk.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Export the current BluebirdPS configuration to disk.</maml:para> <maml:para>The configuration file will be stored a JSON file in the folder $env:HOME/.BluebirdPS.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Export-BluebirdPSConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Export-BluebirdPSConfiguration</dev:code> <dev:remarks> <maml:para>Export the current BluebirdPS configuration to disk.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Export-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-BluebirdPSConfiguration</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Import-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-BluebirdPSConfiguration</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Get-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-BluebirdPSConfiguration</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Set-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Find-TwitterMastodonLinks</command:name> <command:verb>Find</command:verb> <command:noun>TwitterMastodonLinks</command:noun> <maml:description> <maml:para>This command will search through a list of Twitter User objects and Tweet objects for any Mastodon account references.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command will search through a list of Twitter User objects and Tweet objects for any Mastodon account references.</maml:para> <maml:para>For Users, matches will be discovered in any part of the Name, Description, or included Urls. For Tweets, matches will be discovered in the Tweet Text or included Urls.</maml:para> <maml:para>The output of this command can be saved to a CSV that can be used to import discovered Mastodon accounts into your instances following list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Find-TwitterMastodonLinks</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>TwitterObject</maml:name> <maml:description> <maml:para>A list of Twitter Users or Tweets.</maml:para> <maml:para>For Tweets, whatever command you use to get the list of Tweets, using -IncludeExpansions will include the Tweet author User object which will be used to correlate the Tweet to a specific User.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.TwitterObject[]</command:parameterValue> <dev:type> <maml:name>BluebirdPS.TwitterObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="IgnoreUrl"> <maml:name>IgnoreDomain</maml:name> <maml:description> <maml:para>Some Urls are similar to Mastodon account references. You can use this parameter to include a list of domains to ignore.</maml:para> <maml:para>This parameter is often used to ignore domains that use a similarly structured URI as a Mastodon URL. If the following domains are not ignored, you will receive errors when you import them into your Mastodon account.</maml:para> <maml:para>'youtube.com','medium.com','withkoji.com','twitter.com'</maml:para> <maml:para>Additionally, you may want to ignore valid Mastodon instances that are not part of the Fediverse, such as counter.social, or those that have been defederated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>TwitterObject</maml:name> <maml:description> <maml:para>A list of Twitter Users or Tweets.</maml:para> <maml:para>For Tweets, whatever command you use to get the list of Tweets, using -IncludeExpansions will include the Tweet author User object which will be used to correlate the Tweet to a specific User.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.TwitterObject[]</command:parameterValue> <dev:type> <maml:name>BluebirdPS.TwitterObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="IgnoreUrl"> <maml:name>IgnoreDomain</maml:name> <maml:description> <maml:para>Some Urls are similar to Mastodon account references. You can use this parameter to include a list of domains to ignore.</maml:para> <maml:para>This parameter is often used to ignore domains that use a similarly structured URI as a Mastodon URL. If the following domains are not ignored, you will receive errors when you import them into your Mastodon account.</maml:para> <maml:para>'youtube.com','medium.com','withkoji.com','twitter.com'</maml:para> <maml:para>Additionally, you may want to ignore valid Mastodon instances that are not part of the Fediverse, such as counter.social, or those that have been defederated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BluebirdPS.TwitterObject[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.TwitterMastodonReference[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser | Find-TwitterMastodonLinks TwitterUserName : thedavecarroll TwitterUser : Dave Carroll TwitterUrl : https://twitter.com/thedavecarroll TwitterElement : UrlEntity MastodonUser : @thedavecarroll MastodonInstance : fosstodon.org MastodonAccountAddress : @thedavecarroll@fosstodon.org MastodonUrl : https://fosstodon.org/@thedavecarroll IsValidDomain : True</dev:code> <dev:remarks> <maml:para>Retrieve the authenticated user and search for Mastodon account references.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterFriends | Find-TwitterMastodonLinks -IgnoreDomain @('youtube.com','medium.com','withkoji.com','twitter.com','counter.social') | Select-Object @{l='Account address';e={$_.MastodonAccountAddress}},@{l='Show boosts';e={$true}} | Export-Csv -NoTypeInformation -Path .\MastodonImport.csv</dev:code> <dev:remarks> <maml:para>Retrieves the following list of the authenticated user, searches for Mastodon account references, formats the output to what is required for Mastodon import, and saves the output to a CSV file.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Find-TwitterMastodonLinks</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-BluebirdPSAssemblyDetails</command:name> <command:verb>Get</command:verb> <command:noun>BluebirdPSAssemblyDetails</command:noun> <maml:description> <maml:para>Provides information on the enums and classes contained in the BluebirdPS.dll.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Provides information on the enums and classes contained in the BluebirdPS.dll.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-BluebirdPSAssemblyDetails</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Reflection.TypeInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-BluebirdPSAssemblyDetails | Format-Table -Property Namespace,Name,BaseType,IsEnum Namespace Name MemberType IsEnum --------- ---- ---------- ------ BluebirdPS AccessLevel TypeInfo True BluebirdPS Authentication TypeInfo False BluebirdPS Configuration TypeInfo False BluebirdPS EndpointInfo TypeInfo False BluebirdPS ExpansionTypes TypeInfo True BluebirdPS Helpers TypeInfo False BluebirdPS HttpMethod TypeInfo True BluebirdPS OAuthParameter TypeInfo False BluebirdPS OAuthVersion TypeInfo True BluebirdPS OutputType TypeInfo True BluebirdPS RateLimitAction TypeInfo True BluebirdPS ResponseData TypeInfo False BluebirdPS ResponseInfo TypeInfo False BluebirdPS TwitterAuthentication TypeInfo False BluebirdPS TwitterObject TypeInfo False BluebirdPS TwitterRequest TypeInfo False BluebirdPS.APIV1 AccountSettings TypeInfo False BluebirdPS.APIV2 ExpansionFields TypeInfo False BluebirdPS.APIV2 ObjectFields TypeInfo False BluebirdPS.APIV2.ListInfo List TypeInfo False BluebirdPS.APIV2.TweetInfo Tweet TypeInfo False BluebirdPS.APIV2.UserInfo User TypeInfo False BluebirdPS.Exceptions UnspecifiedException TypeInfo False BluebirdPS.Validation ValidateObjectNotNullOrEmptyAttribute TypeInfo False</dev:code> <dev:remarks> <maml:para>Display the requested properties for the assembly.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Get-BluebirdPSAssemblyDetails/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Get-BluebirdPSAssemblyDetails</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-BluebirdPSConfiguration</command:name> <command:verb>Get</command:verb> <command:noun>BluebirdPSConfiguration</command:noun> <maml:description> <maml:para>Display the BluebirdPS configuration.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Display the BluebirdPS configuration that has been imported into the current session.</maml:para> <maml:para>There are some Twitter endpoints that requires the authenticating user's id, and potentially, the user name. When the authentication credentials are set, the response includes these two values. They are stored in the configuration session variable and are used when needed.</maml:para> <maml:para>The AuthValidationDate and AuthLastExportDate values should help the user manage credential refreshes.</maml:para> <maml:para>The RateLimitAction and RateLimitThreshold values instruct how and when to act against the Twitter API rate limits.</maml:para> <maml:para>The ConfigurationPath and CredentialsPath values are used to export configuration and authentication.</maml:para> <maml:para>The OutputType value specifies what type of data to return to the user. The default OutputType is 'CustomClasses' (custom C# classes), but 'PSCustomObject' (as returned by Invoke-RestMethod) or 'JSON' can be specified.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-BluebirdPSConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.Configuration</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-BluebirdPSConfiguration AuthUserId : 292670084 AuthUserName : thedavecarroll AuthValidationDate : 6/26/2021 5:33:03 PM AuthLastExportDate : 5/31/2021 2:40:48 PM RateLimitAction : Warning RateLimitThreshold : 5 ConfigurationPath : C:\Users\Dave\.BluebirdPS\Configuration.json CredentialsPath : C:\Users\Dave\.BluebirdPS\twittercred.sav OutputType : CustomClasses</dev:code> <dev:remarks> <maml:para>Display the current BluebirdPS configuration.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Get-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-BluebirdPSConfiguration</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Export-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-BluebirdPSConfiguration</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Import-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-BluebirdPSConfiguration</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Get-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-BluebirdPSConfiguration</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Set-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-BluebirdPSHistory</command:name> <command:verb>Get</command:verb> <command:noun>BluebirdPSHistory</command:noun> <maml:description> <maml:para>Gets the current session history of commands and corresponding API responses with headers.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets the current session history of commands and corresponding API responses with headers.</maml:para> <maml:para>Every command issued against the Twitter API is recorded in a session variable, including the results.</maml:para> <maml:para>NOTE: On module import, if credentials have been saved, the Import-TwitterAuthentication makes 2 calls against the API. These will be the first 2 entries in the history.</maml:para> <maml:para>Each entry in the BluebirdPS history record includes the following fields:</maml:para> <maml:para>GENERAL:</maml:para> <maml:para>- Command: the name of the command</maml:para> <maml:para>- ApiVersion: derived from the URI</maml:para> <maml:para>- InvocationInfo: the PowerShell InvocationInfo for the specific Twitter API call</maml:para> <maml:para></maml:para> <maml:para>REQUEST:</maml:para> <maml:para>- HttpMethod</maml:para> <maml:para>- Uri: the full URI sent to Twitter including the query segment</maml:para> <maml:para>- Body</maml:para> <maml:para>- Form</maml:para> <maml:para></maml:para> <maml:para>HEADER RESPONSE:</maml:para> <maml:para>- Server: responding Twitter server</maml:para> <maml:para>- ResponseTime: time in milliseconds for the response</maml:para> <maml:para>- RateLimit: the number of calls that can be made to the endpoint within a specified time frame</maml:para> <maml:para>- RateLimitRemaining: the number of remaining calls to the endpoint</maml:para> <maml:para>- RateLimitReset: the local time when the rate limit remaining counter will be reset and new calls may be placed</maml:para> <maml:para>- The raw header response</maml:para> <maml:para></maml:para> <maml:para>API RESPONSE:</maml:para> <maml:para>- Status: the http status of the call indicating success or specific failure</maml:para> <maml:para>- The raw API response</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-BluebirdPSHistory</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>First</maml:name> <maml:description> <maml:para>Specifies the number of objects to select from the beginning of an array of input objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Last</maml:name> <maml:description> <maml:para>Specifies the number of objects to select from the end of an array of input objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>Skips (does not select) the specified number of items.</maml:para> <maml:para>By default, the Skip parameter counts from the beginning of the array or list of objects, but if the command uses the Last parameter, it counts from the end of the list or array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>SkipLast</maml:name> <maml:description> <maml:para>Skips (does not select) the specified number of items from the end of the list or array.</maml:para> <maml:para>Works in the same way as using Skip together with Last parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Errors</maml:name> <maml:description> <maml:para>Returns the command name, status, and any errors that were returned in the API response.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Errors</maml:name> <maml:description> <maml:para>Returns the command name, status, and any errors that were returned in the API response.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>First</maml:name> <maml:description> <maml:para>Specifies the number of objects to select from the beginning of an array of input objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Last</maml:name> <maml:description> <maml:para>Specifies the number of objects to select from the end of an array of input objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Skip</maml:name> <maml:description> <maml:para>Skips (does not select) the specified number of items.</maml:para> <maml:para>By default, the Skip parameter counts from the beginning of the array or list of objects, but if the command uses the Last parameter, it counts from the end of the list or array.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>SkipLast</maml:name> <maml:description> <maml:para>Skips (does not select) the specified number of items from the end of the list or array.</maml:para> <maml:para>Works in the same way as using Skip together with Last parameter.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.ResponseData[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Selected.BluebirdPS.ResponseData[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User BluebirdPS PS > Get-BluebirdPSHistory -Last 1 Command : Get-TwitterUser InvocationInfo : System.Management.Automation.InvocationInfo HttpMethod : GET Uri : https://api.twitter.com/2/users/by/username/BluebirdPS?user.fields=id%2Cname%2Cusername%2Ccreated_at%2Cdescription%2Centities%2Clocation%2Cpinned_tweet_id%2Cprofile_image_ur l%2Cprotected%2Cpublic_metrics%2Curl%2Cverified%2Cwithheld Endpoint : https://api.twitter.com/2/users/by/username/BluebirdPS QueryString : ?user.fields=id%2Cname%2Cusername%2Ccreated_at%2Cdescription%2Centities%2Clocation%2Cpinned_tweet_id%2Cprofile_image_url%2Cprotected%2Cpublic_metrics%2Curl%2Cverified%2Cwith held Body : Form : Status : OK Server : tsa_b ResponseTime : 46 RateLimit : 900 RateLimitRemaining : 898 RateLimitReset : 5/24/2021 9:26:11 AM HeaderResponse : {X-Frame-Options, Cache-Control, x-rate-limit-reset, X-Content-Type-Options…} ApiVersion : 2 ApiResponse : @{data=}</dev:code> <dev:remarks> <maml:para>Get the last entry in BluebirdPS history variable.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User asdfasdfasdfasefase PS > Get-BluebirdPSHistory -Last 1 -Errors | Format-List Command : Get-TwitterUser Status : BadRequest Errors : The `username` query parameter value [asdfasdfasdfasefase] does not match ^[A-Za-z0-9_]{1,15}$</dev:code> <dev:remarks> <maml:para>Get any errors for the last entry in BluebirdPS history variable.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS > Get-Tweet -Id 1396829590190952451 -NonPublicMetrics PS > Get-BluebirdPSHistory -Last 1 -Errors | Format-List Command : Get-Tweet Status : OK Errors : {Sorry, you are not authorized to access 'non_public_metrics.impression_count' on the Tweet with id : [1396829590190952451]., Sorry, you are not authorized to access 'non_public_metrics.url_link_clicks' on the Tweet with id : [1396829590190952451]., Sorry, you are not authorized to access 'non_public_metrics.user_profile_clicks' on the Tweet with id : [1396829590190952451].}</dev:code> <dev:remarks> <maml:para>Get any errors for the last entry in BluebirdPS history variable. There may be more than one error returned from the API, as shown in this example.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Get-BluebirdPSHistory</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-BluebirdPSVersion</command:name> <command:verb>Get</command:verb> <command:noun>BluebirdPSVersion</command:noun> <maml:description> <maml:para>Display the version of BluebirdPS imported into the current session.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Display the version of BluebirdPS imported into the current session.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-BluebirdPSVersion</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-BluebirdPSVersion 0.8.0</dev:code> <dev:remarks> <maml:para>Displays the version of BluebirdPS imported into the current session.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Get-BluebirdPSVersion/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Get-BluebirdPSVersion</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterApiEndpoint</command:name> <command:verb>Get</command:verb> <command:noun>TwitterApiEndpoint</command:noun> <maml:description> <maml:para>Get a list of the module's commands or an array of commands, with the associated Twitter API endpoints (as used in the command) and documentation links.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get a list of the module's commands or an array of commands, with the associated Twitter API endpoints and documentation links.</maml:para> <maml:para>Some commands may act against more than one endpoint, depending on the parameters used.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterApiEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CommandName</maml:name> <maml:description> <maml:para>Specifies the name of the BluebirdPS command.</maml:para> <maml:para>Tab completion is enabled for this parameter for public functions.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Endpoint</maml:name> <maml:description> <maml:para>The endpoint or part of the endpoint string.</maml:para> <maml:para>Specifying the endpoint will allow the user to discover commands that are included in BluebirdPS.</maml:para> <maml:para>The user may still be able to access endpoints, which are currently not supported by the module, by using the Invoke-TwitterRequest command. See the contextual help about_BluebirdPS_TwitterRequest for more details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>CommandName</maml:name> <maml:description> <maml:para>Specifies the name of the BluebirdPS command.</maml:para> <maml:para>Tab completion is enabled for this parameter for public functions.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Endpoint</maml:name> <maml:description> <maml:para>The endpoint or part of the endpoint string.</maml:para> <maml:para>Specifying the endpoint will allow the user to discover commands that are included in BluebirdPS.</maml:para> <maml:para>The user may still be able to access endpoints, which are currently not supported by the module, by using the Invoke-TwitterRequest command. See the contextual help about_BluebirdPS_TwitterRequest for more details.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.EndpointInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterApiEndpoint -CommandName Get-TwitterList | Format-List CommandName : Get-TwitterList Visibility : Public ApiEndpoint : {GET lists/list, GET lists/show} ApiDocumentation : {https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-list, https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-show}</dev:code> <dev:remarks> <maml:para>Display details for the command Get-TwitterList.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterApiEndpoint -Endpoint saved | Format-List CommandName : Add-TwitterSavedSearch Visibility : Public ApiEndpoint : POST saved_searches/create ApiDocumentation : https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-create CommandName : Get-TwitterSavedSearch Visibility : Public ApiEndpoint : {GET saved_searches/list, GET saved_searches/show/:id} ApiDocumentation : {https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list, https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/get-saved_searches-list} CommandName : Remove-TwitterSavedSearch Visibility : Public ApiEndpoint : POST saved_searches/destroy/:id ApiDocumentation : https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/manage-account-settings/api-reference/post-saved_searches-destroy-id</dev:code> <dev:remarks> <maml:para>Display all commands whose endpoint contains the word 'saved'.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Get-TwitterApiEndpoint</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Invoke-TwitterRequest</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Supporting%20Commands/Invoke-TwitterRequest</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Import-BluebirdPSConfiguration</command:name> <command:verb>Import</command:verb> <command:noun>BluebirdPSConfiguration</command:noun> <maml:description> <maml:para>Import the user's configuration values from disk.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Import the user's configuration values from disk.</maml:para> <maml:para>This will override the current session's configuration variable.</maml:para> <maml:para>This command is called when the module is imported.</maml:para> <maml:para>Beginning with v0.8.2, the value for RateLimitAction can be set with the environment variable BLUEBIRDPS_RATE_LIMIT_ACTION. If the environment variable exists and the value is one of the allowed types, the Configuration value will be overridden for the session.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-BluebirdPSConfiguration</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Import-BluebirdPSConfiguration</dev:code> <dev:remarks> <maml:para>Import the user's configuration values from disk.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Import-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Export-BluebirdPSConfiguration</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Export-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-BluebirdPSConfiguration</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Get-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-BluebirdPSConfiguration</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Set-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-BluebirdPSConfiguration</command:name> <command:verb>Set</command:verb> <command:noun>BluebirdPSConfiguration</command:noun> <maml:description> <maml:para>Set one or more BluebirdPS configuration values.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set one or more BluebirdPS configuration values.</maml:para> <maml:para>Importing the module will create a module scoped variable which contains several configuration values. This command sets updates the variable in the current session, and optionally exports the configuration to disk.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-BluebirdPSConfiguration</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>RateLimitAction</maml:name> <maml:description> <maml:para>Specify what action should be performed when the RateLimitThreshold is reached for any given endpoint.</maml:para> <maml:para>This defaults to Verbose.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Verbose</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Warning</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Error</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">BluebirdPS.RateLimitAction</command:parameterValue> <dev:type> <maml:name>BluebirdPS.RateLimitAction</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RateLimitThreshold</maml:name> <maml:description> <maml:para>Specify the threshold at which the RateLimitAction is taken.</maml:para> <maml:para>The RateLimitThreshold does not effect any rate limit for any Twitter endpoint.</maml:para> <maml:para>This defaults to 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Export</maml:name> <maml:description> <maml:para>Export the configuration using Export-BluebirdPSConfiguration.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specify the output type of all commands that connect to the Twitter API.</maml:para> <maml:para>CustomClasses - This is the default selection which output response as classes defined in the BluebirdPS assembly. JSON - The raw response as returned by the Twitter API. PSCustomObject - Invoke-TwitterRequest uses Invoke-RestMethod which converts JSON into a PSCustomObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.OutputType</command:parameterValue> <dev:type> <maml:name>BluebirdPS.OutputType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Export</maml:name> <maml:description> <maml:para>Export the configuration using Export-BluebirdPSConfiguration.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>RateLimitAction</maml:name> <maml:description> <maml:para>Specify what action should be performed when the RateLimitThreshold is reached for any given endpoint.</maml:para> <maml:para>This defaults to Verbose.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.RateLimitAction</command:parameterValue> <dev:type> <maml:name>BluebirdPS.RateLimitAction</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>RateLimitThreshold</maml:name> <maml:description> <maml:para>Specify the threshold at which the RateLimitAction is taken.</maml:para> <maml:para>The RateLimitThreshold does not effect any rate limit for any Twitter endpoint.</maml:para> <maml:para>This defaults to 5.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OutputType</maml:name> <maml:description> <maml:para>Specify the output type of all commands that connect to the Twitter API.</maml:para> <maml:para>CustomClasses - This is the default selection which output response as classes defined in the BluebirdPS assembly. JSON - The raw response as returned by the Twitter API. PSCustomObject - Invoke-TwitterRequest uses Invoke-RestMethod which converts JSON into a PSCustomObject.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.OutputType</command:parameterValue> <dev:type> <maml:name>BluebirdPS.OutputType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Set-BluebirdPSConfiguration -RateLimitAction 'Warning' -RateLimitThreshold 10 -Export</dev:code> <dev:remarks> <maml:para>Set the configuration value specifying that a message will be written to the Warning stream when the remaining calls to the endpoint is 10 or less. Save the configuration to disk to be used for future sessions.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Set-BluebirdPSConfiguration -OutputType JSON</dev:code> <dev:remarks> <maml:para>Set the configuration value specifying that no output will be parsed into rich objects.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Set-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Export-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Import-BluebirdPSConfiguration</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Import-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-BluebirdPSConfiguration</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Get-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-BluebirdPSConfiguration</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Helper%20Commands/Set-BluebirdPSConfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - V2 Fields</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/fields</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - V2 Expansions</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/expansions</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-TwitterList</command:name> <command:verb>Add</command:verb> <command:noun>TwitterList</command:noun> <maml:description> <maml:para>Creates a new list for the authenticated user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new list for the authenticated user.</maml:para> <maml:para>Note that you can create up to 1000 lists per account.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-TwitterList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name for the list. A list's name must start with a letter and can consist only of 25 or fewer letters, numbers, "-", or "_" characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description to give the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Private</maml:name> <maml:description> <maml:para>Create the list as private. By default, lists are created as public.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The name for the list. A list's name must start with a letter and can consist only of 25 or fewer letters, numbers, "-", or "_" characters.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The description to give the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Private</maml:name> <maml:description> <maml:para>Create the list as private. By default, lists are created as public.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV1.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV1.List[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Add-TwitterList -Name Sample-List -Description 'A sample list' -Mode Private Id : 1397040831777984512 CreatedAt : 1/19/1970 12:31:55 PM Slug : sample-list-10878 Name : Sample-List FullName : @thedavecarroll/sample-list-10878 Description : A sample list Uri : https://twitter.com/thedavecarroll/lists/sample-list-10878 Mode : Private MemberCount : 0 SubscriberCount : 0 UserId : 292670084 UserName : thedavecarroll Following : False</dev:code> <dev:remarks> <maml:para>Create a private list named Sample-List with the specified description.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Add-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Remove-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Set-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - POST /2/lists</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/post-lists</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-TwitterListMember</command:name> <command:verb>Add</command:verb> <command:noun>TwitterListMember</command:noun> <maml:description> <maml:para>Add one or more users to a list.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add one or more users to a list.</maml:para> <maml:para>The authenticated user must own the list to be able to add members to it.</maml:para> <maml:para>Lists can't have more than 5,000 members.</maml:para> <maml:para>Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-TwitterListMember</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>One or more user objects, returned by Get-TwitterUser, to follow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User[]</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-TwitterListMember</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>One or more user objects, returned by Get-TwitterUser, to follow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User[]</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>One or more user objects, returned by Get-TwitterUser, to follow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User[]</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV1.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>### BluebirdPS.APIV1.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $Users = Get-TwitterUser -User thedavecarroll,BluebirdPS PS > $List = Get-TwitterList -Id 1587300786052243459 PS > $Users | Add-TwitterListMember -List $List User Dave Carroll added to list Id: 1587300786052243459, Name: TestAdditionRemoval User BluebirdPS added to list Id: 1587300786052243459, Name: TestAdditionRemoval</dev:code> <dev:remarks> <maml:para>Get the users thedavecarroll and BluebirdPS, then add them to the specified list.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Add-TwitterListMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterListMember</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterListMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TwitterListMember</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Remove-TwitterListMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - POST /2/lists/:id/members</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/list-members/api-reference/post-lists-id-members</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-TwitterListSubscription</command:name> <command:verb>Add</command:verb> <command:noun>TwitterListSubscription</command:noun> <maml:description> <maml:para>Subscribes the authenticating user to the specified list.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Subscribes the authenticating user to the specified list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-TwitterListSubscription</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-TwitterListSubscription</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV1.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Add-TwitterListSubscription -Id 1236361374567026688</dev:code> <dev:remarks> <maml:para>Subscribe to the list with the specified id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User windosnz | Get-TwitterList -SearchName blog | Add-TwitterListSubscription</dev:code> <dev:remarks> <maml:para>Get the user windosnz, then get all public lists he owns that have 'blog' in the name, then subscribe to the list.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Add-TwitterListSubscription</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterListSubscription</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterListSubscription</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TwitterListSubscription</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Remove-TwitterListSubscription</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-TwitterListSubscription</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Test-TwitterListSubscription</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - POST /2/users/:id/followed_lists</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/list-follows/api-reference/post-users-id-followed-lists</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterList</command:name> <command:verb>Get</command:verb> <command:noun>TwitterList</command:noun> <maml:description> <maml:para>Returns a specific list or all lists the authenticating or specified user owns.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a specific list or all lists the authenticating or specified user owns.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterList</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>A Twitter user object, returned by Get-TwitterUser, for which to retrieve the lists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>Specifies the search string to match against the list Name property.</maml:para> <maml:para>Note: All lists are returned, then filtered by the SearchName value. This capability is not inherently part of the Twitter API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the list owner User object.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TwitterList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The numerical id of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>Specifies the search string to match against the list Name property.</maml:para> <maml:para>Note: All lists are returned, then filtered by the SearchName value. This capability is not inherently part of the Twitter API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the list owner User object.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>A Twitter user object, returned by Get-TwitterUser, for which to retrieve the lists.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The numerical id of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchName</maml:name> <maml:description> <maml:para>Specifies the search string to match against the list Name property.</maml:para> <maml:para>Note: All lists are returned, then filtered by the SearchName value. This capability is not inherently part of the Twitter API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the list owner User object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV1.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV1.List[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterList</dev:code> <dev:remarks> <maml:para>Returns the lists the authenticating user owns.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User PowerShell_Team | Get-TwitterList</dev:code> <dev:remarks> <maml:para>Returns the lists the specified user owns.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS > Get-TwitterList -Id 749356646665629696</dev:code> <dev:remarks> <maml:para>Returns the specified list.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/lists/:id</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/list-lookup/api-reference/get-lists-id</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/users/:id/owned_lists</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/list-lookup/api-reference/get-users-id-owned_lists</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterListMember</command:name> <command:verb>Get</command:verb> <command:noun>TwitterListMember</command:noun> <maml:description> <maml:para>Returns the user objects for members of the specified list.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the user objects for members of the specified list.</maml:para> <maml:para>Private list members will only be shown if the authenticated user owns the specified list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterListMember</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the list members pinned tweet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TwitterListMember</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the list members pinned tweet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the list members pinned tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV1.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterListMember -Id 749356646665629696</dev:code> <dev:remarks> <maml:para>Returns the members of the specified list.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterList -SearchName PSFollowFriday-ListOwners | Get-TwitterListMember | Format-Table -Property UserName,Name</dev:code> <dev:remarks> <maml:para>Returns the members of the specified list.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterListMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TwitterListMember</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Add-TwitterListMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TwitterListMember</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Remove-TwitterListMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/lists/:id/members</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/list-members/api-reference/get-lists-id-members</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterListMembership</command:name> <command:verb>Get</command:verb> <command:noun>TwitterListMembership</command:noun> <maml:description> <maml:para>Displays the public lists, or any lists owned by the authenticating user, of which the specified user is a member.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Displays the public lists, or any lists owned by the authenticating user, of which the specified user is a member.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterListMembership</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>A user object, returned by Get-TwitterUser, for which to return lists of which they are a member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the list owner.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>A user object, returned by Get-TwitterUser, for which to return lists of which they are a member.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the list owner.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV1.List[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterListMembership</dev:code> <dev:remarks> <maml:para>Display public lists whose membership includes the authenticating user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User windosnz | Get-TwitterListMembership</dev:code> <dev:remarks> <maml:para>Display public lists whose membership includes the user WindosNZ.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterListMembership</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/users/:id/list_memberships</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/list-members/api-reference/get-users-id-list_memberships</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterListSubscriber</command:name> <command:verb>Get</command:verb> <command:noun>TwitterListSubscriber</command:noun> <maml:description> <maml:para>Returns a collection of subscriber user objects of the specified list.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a collection of subscriber user objects of the specified list.</maml:para> <maml:para>Private list subscribers will only be shown if the authenticated user owns the specified list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterListSubscriber</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the list subscribers pinned tweet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the list subscribers pinned tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterList -SearchName PSFollowFriday-ListOwners | Get-TwitterListSubscriber</dev:code> <dev:remarks> <maml:para>Returns the users that subscribe to the list specified.</maml:para> <maml:para>Returns the users that are subscribe to the list specified.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterListSubscriber</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/lists/:id/followers</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/list-follows/api-reference/get-lists-id-followers</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterListSubscription</command:name> <command:verb>Get</command:verb> <command:noun>TwitterListSubscription</command:noun> <maml:description> <maml:para>Returns a collection of lists to which the specified user is subscribed.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a collection of lists to which the specified user is subscribed.</maml:para> <maml:para>Does not include the user's own lists.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterListSubscription</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>A Twitter user object, returned by Get-TwitterUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the subscribed list owners.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>A Twitter user object, returned by Get-TwitterUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the subscribed list owners.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV1.List[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterListSubscription</dev:code> <dev:remarks> <maml:para>Returns a collection of lists to which the authenticating user is subscribed.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User BluebirdPS | Get-TwitterListSubscription Id : 749356646665629696 CreatedAt : 7/2/2016 4:38:41 PM Slug : powershell-team Name : PowerShell Team FullName : @PowerShell_Team/powershell-team Description : Members of the PowerShell Team at Microsoft Uri : https://twitter.com/PowerShell_Team/lists/powershell-team Mode : Public MemberCount : 23 SubscriberCount : 287 UserId : 702907554368630784 UserName : PowerShell_Team Following : True</dev:code> <dev:remarks> <maml:para>Returns a collection of lists to which the specified user is subscribed.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterListSubscription</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TwitterListSubscription</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Add-TwitterListSubscription</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TwitterListSubscription</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Remove-TwitterListSubscription</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-TwitterListSubscription</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Test-TwitterListSubscription</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/users/:id/followed_lists</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/list-follows/api-reference/get-users-id-followed_lists</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterListTweets</command:name> <command:verb>Get</command:verb> <command:noun>TwitterListTweets</command:noun> <maml:description> <maml:para>Returns a timeline of Tweets authored by members of the specified list.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a timeline of Tweets authored by members of the specified list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterListTweets</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Returns the Tweet author user object and any attachments.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NonPublicMetrics</maml:name> <maml:description> <maml:para>Include non-public engagement metrics for the Tweet at the time of the request.</maml:para> <maml:para>NonPublic metrics include ImpressionCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganicMetrics</maml:name> <maml:description> <maml:para>Include engagement metrics, tracked in an organic context, for the Tweet at the time of the request.</maml:para> <maml:para>OrganicMetrics include ImpressionCount, LikeCount, ReplyCount, RetweetCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PromotedMetrics</maml:name> <maml:description> <maml:para>Include engagement metrics, tracked in a promoted context, for the Tweet at the time of the request.</maml:para> <maml:para>PromotedMetrics include ImpressionCount, LikeCount, ReplyCount, RetweetCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Returns the Tweet author user object and any attachments.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NonPublicMetrics</maml:name> <maml:description> <maml:para>Include non-public engagement metrics for the Tweet at the time of the request.</maml:para> <maml:para>NonPublic metrics include ImpressionCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganicMetrics</maml:name> <maml:description> <maml:para>Include engagement metrics, tracked in an organic context, for the Tweet at the time of the request.</maml:para> <maml:para>OrganicMetrics include ImpressionCount, LikeCount, ReplyCount, RetweetCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PromotedMetrics</maml:name> <maml:description> <maml:para>Include engagement metrics, tracked in a promoted context, for the Tweet at the time of the request.</maml:para> <maml:para>PromotedMetrics include ImpressionCount, LikeCount, ReplyCount, RetweetCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV1.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterList -SearchName Retro | Get-TwitterListTweets -NoPagination -MaxResultsPerPage 10 -IncludeExpansions</dev:code> <dev:remarks> <maml:para>Return the 10 latest Tweets from members of the specified list, including author user objects and any attachments.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterList -Id 749356646665629696 | Get-TwitterListTweets -NoPagination -MaxResultsPerPage 10</dev:code> <dev:remarks> <maml:para>Return the Tweets from members of the specified list.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterListTweets</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterListMember</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterListMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/lists/:id/tweets</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/list-tweets/api-reference/get-lists-id-tweets</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterPinnedList</command:name> <command:verb>Get</command:verb> <command:noun>TwitterPinnedList</command:noun> <maml:description> <maml:para>Returns the Lists pinned by the authenticating user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the Lists pinned by the authenticating user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterPinnedList</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterPinnedList</dev:code> <dev:remarks> <maml:para>Returns the Lists pinned by the authenticating user.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterPinnedList/</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterPinnedList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TwitterPinnedList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Set-TwitterPinnedList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/users/:id/pinned_lists</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/pinned-lists/api-reference/get-users-id-pinned_lists</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-TwitterList</command:name> <command:verb>Remove</command:verb> <command:noun>TwitterList</command:noun> <maml:description> <maml:para>Removes the specified list.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes the specified list.</maml:para> <maml:para>The authenticated user must own the list to be able to remove it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-TwitterList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-TwitterList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV1.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------------- Example ---------------------------</maml:title> <dev:code>PS > Remove-TwitterList -Id 1396433456926703621 Confirm Are you sure you want to perform this action? Performing the operation "Removing List" on target "Name: Daves_Test-List, Members: 0, Subscribers: 0, Created: 5/23/2021 6:50:55 AM, Description: ". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y</dev:code> <dev:remarks> <maml:para>Remove the specified list.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterList -Id 1396433456926703621 | Remove-TwitterList Confirm Are you sure you want to perform this action? Performing the operation "Removing List" on target "Name: Daves_Test-List, Members: 0, Subscribers: 0, Created: 5/23/2021 6:50:55 AM, Description: ". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y</dev:code> <dev:remarks> <maml:para>Remove the specified list.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Remove-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Add-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Set-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - DELETE /2/lists/:id</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/delete-lists-id</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-TwitterListMember</command:name> <command:verb>Remove</command:verb> <command:noun>TwitterListMember</command:noun> <maml:description> <maml:para>Removes one or more users from a list.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes one or more users from a list.</maml:para> <maml:para>The authenticated user must own the list to be able to remove members from it.</maml:para> <maml:para>Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-TwitterListMember</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>One or more Twitter user objects to remove from the list, up to a maximum of 100 per request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-TwitterListMember</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>One or more Twitter user objects to remove from the list, up to a maximum of 100 per request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>One or more Twitter user objects to remove from the list, up to a maximum of 100 per request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV1.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV1.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $MyUser = Get-TwitterUser -User BluebirdPS PS > Get-TwitterList -Id 1587300786052243459 | Remove-TwitterListMember -User $MyUser Id : 1397040831777984512 CreatedAt : 5/24/2021 11:04:24 PM Slug : sample-list-10878 Name : Updated-List-Name FullName : @thedavecarroll/sample-list-10878 Description : New description for this list. Uri : https://twitter.com/thedavecarroll/lists/sample-list-10878 Mode : Private MemberCount : 3 SubscriberCount : 0 UserId : 292670084 UserName : thedavecarroll Following : True User BluebirdPS is not a member of list Id: 1587300786052243459, Name: Sample-List, Members: 0</dev:code> <dev:remarks> <maml:para>Remove the specified user from the specified list.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Remove-TwitterListMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterListMember</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterListMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TwitterListMember</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Add-TwitterListMember</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - DELETE /2/lists/:id/members/:user_id</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/list-members/api-reference/delete-lists-id-members-user_id</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-TwitterListSubscription</command:name> <command:verb>Remove</command:verb> <command:noun>TwitterListSubscription</command:noun> <maml:description> <maml:para>Unsubscribes the authenticating user from the specified list.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Unsubscribes the authenticating user from the specified list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-TwitterListSubscription</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-TwitterListSubscription</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV1.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterList -Id 1236361374567026688 | Remove-TwitterListSubscription</dev:code> <dev:remarks> <maml:para>Get the Twitter list specified by the Id, then unsubscribe from it.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Remove-TwitterListSubscription</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TwitterListSubscription</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Add-TwitterListSubscription</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterListSubscription</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterListSubscription</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-TwitterListSubscription</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Test-TwitterListSubscription</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - DELETE /2/users/:id/followed_lists/:list_id</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/list-follows/api-reference/delete-users-id-followed-lists-list_id</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-TwitterList</command:name> <command:verb>Set</command:verb> <command:noun>TwitterList</command:noun> <maml:description> <maml:para>Updates the specified list.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Updates the specified list.</maml:para> <maml:para>The authenticated user must own the list to be able to update it.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-TwitterList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The new name for the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The new description for the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Private</maml:name> <maml:description> <maml:para>Specifies whether the list will be private.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-TwitterList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The new name for the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The new description for the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Private</maml:name> <maml:description> <maml:para>Specifies whether the list will be private.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Name</maml:name> <maml:description> <maml:para>The new name for the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Description</maml:name> <maml:description> <maml:para>The new description for the list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Private</maml:name> <maml:description> <maml:para>Specifies whether the list will be private.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Boolean</command:parameterValue> <dev:type> <maml:name>System.Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterList -Id 1587297863276679169 | Set-TwitterList -Name 'List Example' -Description 'This is a Set-TwitterList example' Id : 1587297863276679169 Name : Sample List CreatedAt : 11/1/2022 4:17:55 AM FollowerCount : 0 MemberCount : 0 Description : test description Private : True OwnerId : 292670084 Confirm Are you sure you want to perform this action? Performing the operation "Update list" on target "Id: 1587297863276679169, Name: Sample List, Members: 0, Followers: 0, Created: 11/1/2022 4:17:55 AM, Description: test description". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y Id : 1587297863276679169 Name : List Example CreatedAt : 11/1/2022 4:17:55 AM FollowerCount : 0 MemberCount : 0 Description : This is a Set-TwitterList example Private : True OwnerId : 292670084</dev:code> <dev:remarks> <maml:para>Update the Name and Description for the list.</maml:para> <maml:para>Note: The list slug does not change when you rename the list, therefore neither does the list URL.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Set-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Add-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Remove-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - PUT /2/lists/:id</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/manage-lists/api-reference/put-lists-id</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-TwitterPinnedList</command:name> <command:verb>Set</command:verb> <command:noun>TwitterPinnedList</command:noun> <maml:description> <maml:para>Allows the authenticating user to pin or unpin a List.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Allows the authenticating user to pin or unpin a List.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-TwitterPinnedList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PinList</maml:name> <maml:description> <maml:para>Allows the authenticating user to pin a list.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-TwitterPinnedList</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UnpinList</maml:name> <maml:description> <maml:para>Allows the authenticating user to unpin a list.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PinList</maml:name> <maml:description> <maml:para>Allows the authenticating user to pin a list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UnpinList</maml:name> <maml:description> <maml:para>Allows the authenticating user to unpin a list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterList -Id 1400680326754615296 | Set-TwitterPinnedList List Id: 1400680326754615296, Name: PSFollowFriday-ListOwners is pinned</dev:code> <dev:remarks> <maml:para>Pin the list PSFollowFriday-ListOwners.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterPinnedList | Select-Object -Last 1 | Set-TwitterPinnedList -UnpinList List Id: 1400680326754615296, Name: PSFollowFriday-ListOwners is not pinned</dev:code> <dev:remarks> <maml:para>Unpin the last pinned list.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Set-TwitterPinnedList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterPinnedLis</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterPinnedList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterList</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - POST /2/users/:id/pinned_lists</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/pinned-lists/api-reference/post-users-id-pinned-lists</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - DELETE /2/users/:id/pinned_lists/:list_id</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/lists/pinned-lists/api-reference/delete-users-id-pinned-lists-list_id</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-TwitterListMembership</command:name> <command:verb>Test</command:verb> <command:noun>TwitterListMembership</command:noun> <maml:description> <maml:para>Tests if a specified user is a member of the specified list.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Tests if a specified user is a member of the specified list.</maml:para> <maml:para>If the specified user is a member of the specified list, returns true, otherwise returns false.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-TwitterListMembership</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The Twitter user object to verify if they are a member of the specified list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The Twitter user object to verify if they are a member of the specified list.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $List = Get-TwitterList -Id 92000812 PS > $List PS > $List | Test-TwitterListMembership Id : 92000812 Name : ps1 CreatedAt : 6/27/2013 7:42:03 PM FollowerCount : 360 MemberCount : 57 Description : Powershell bloggers, trainers, authors - additions, recommendations welcome. Private : False OwnerId : 16177793 True</dev:code> <dev:remarks> <maml:para>Checks if the authenticating user is a member of the specified list.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $List | Test-TwitterListMembership -User (Get-TwitterUser -User joeyaiello) True</dev:code> <dev:remarks> <maml:para>Checks if joeyaiello is a member of the specified list.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Test-TwitterListMembership</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterListMembership</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterListMembership</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Test-TwitterListSubscription</command:name> <command:verb>Test</command:verb> <command:noun>TwitterListSubscription</command:noun> <maml:description> <maml:para>Tests whether the authenticating or specified user subscribes to the specified public list.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Tests whether the authenticating or specified user subscribes to the specified public list.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Test-TwitterListSubscription</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>A Twitter user object returned by Get-TwitterUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>List</maml:name> <maml:description> <maml:para>A list object retrieved from Get-TwitterList.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.ListInfo.List</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>A Twitter user object returned by Get-TwitterUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV2.ListInfo.List</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $List = Get-TwitterList -Id 92000812 PS > $List PS > $List | Test-TwitterListSubscription Id : 92000812 Name : ps1 CreatedAt : 6/27/2013 7:42:03 PM FollowerCount : 360 MemberCount : 57 Description : Powershell bloggers, trainers, authors - additions, recommendations welcome. Private : False OwnerId : 16177793 True</dev:code> <dev:remarks> <maml:para>Checks if the authenticating user is subscribed to the specified list.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $User = Get-TwitterUser -User mikefrobbins PS > $List | Test-TwitterListSubscription -User $User False</dev:code> <dev:remarks> <maml:para>Checks if the specified user is subscribed to the specified public list.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Test-TwitterListSubscription</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterListSubscription</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterListSubscription</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TwitterListSubscription</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Add-TwitterListSubscription</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TwitterListSubscription</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Remove-TwitterListSubscription</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterList</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Lists/Get-TwitterList</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Send-TwitterMedia</command:name> <command:verb>Send</command:verb> <command:noun>TwitterMedia</command:noun> <maml:description> <maml:para>Upload media to Twitter to use in a Tweet or direct message.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Upload media to Twitter to use in a Tweet or direct message.</maml:para> <maml:para>You can only upload an image, video, or gif.</maml:para> <maml:para>NOTE: This command currently returns the raw API response.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Send-TwitterMedia</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the full path to the media file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Specifies the type and use for the uploaded media.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">TweetImage</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TweetVideo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TweetGif</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DMImage</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DMVideo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DMGif</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AltImageText</maml:name> <maml:description> <maml:para>Provide additional information about the images or GIFs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the full path to the media file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Specifies the type and use for the uploaded media.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AltImageText</maml:name> <maml:description> <maml:para>Provide additional information about the images or GIFs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Send-TwitterMedia -Path .\PSFollowFriday_20210514.png -Category TweetImage -AltImageText 'Creating a PSFollowFriday via PowerShell module BluebirdPS.' -Verbose VERBOSE: Reading file D:\GitHub\PSFollowFriday_20210514.png VERBOSE: Beginning INIT phase - media size 17004, category tweet_image, type image/png VERBOSE: Upload for media id 1396858342329524224 successfully initiated VERBOSE: Beginning APPEND phase VERBOSE: Beginning FINALIZE phase VERBOSE: Adding AltImageText to media 1396858342329524224 VERBOSE: Alt image text successfully added to media VERBOSE: Media upload complete media_id : 1396858342329524224 media_id_string : 1396858342329524224 media_key : 3_1396858342329524224 size : 16974 expires_after_secs : 86400 image : @{image_type=image/png; w=873; h=185}</dev:code> <dev:remarks> <maml:para>Upload the specified media file and set the ALT text for the media.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Media/Send-TwitterMedia</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - POST media/upload (INIT)</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-init</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - POST media/upload (APPEND)</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-append</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - POST media/upload (FINALIZE)</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/api-reference/post-media-upload-finalize</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - Upload Media</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/uploading-media/media-best-practices</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - Chunked Media Upload</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/uploading-media/chunked-media-upload</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Search-Tweet</command:name> <command:verb>Search</command:verb> <command:noun>Tweet</command:noun> <maml:description> <maml:para>Returns a collection of relevant Tweets from the last 7 days matching a specified query.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a collection of relevant Tweets from the last 7 days matching a specified query.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Search-Tweet</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>The search string consisting of text and Twitter search operators.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include additional data objects, such as the Tweet author's user, mentioned users, media, poll, and more.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NonPublicMetrics</maml:name> <maml:description> <maml:para>Include this parameter to display the non-public metrics for returned data.</maml:para> <maml:para>Note: Only the authenticating user can request for non-public metrics.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganicMetrics</maml:name> <maml:description> <maml:para>Include this parameter to display the grouping of public and non-public metrics attributed to an organic context (posted and viewed in a regular manner).</maml:para> <maml:para>Note: Only the authenticating user can request for organic metrics.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PromotedMetrics</maml:name> <maml:description> <maml:para>Include this parameter to display the grouping of public and non-public metrics attributed to a promoted context (posted or viewed as part of an Ads campaign).</maml:para> <maml:para>Note: Only the authenticating user can request for promoted metrics.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>The search string consisting of text and Twitter search operators.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include additional data objects, such as the Tweet author's user, mentioned users, media, poll, and more.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NonPublicMetrics</maml:name> <maml:description> <maml:para>Include this parameter to display the non-public metrics for returned data.</maml:para> <maml:para>Note: Only the authenticating user can request for non-public metrics.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganicMetrics</maml:name> <maml:description> <maml:para>Include this parameter to display the grouping of public and non-public metrics attributed to an organic context (posted and viewed in a regular manner).</maml:para> <maml:para>Note: Only the authenticating user can request for organic metrics.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PromotedMetrics</maml:name> <maml:description> <maml:para>Include this parameter to display the grouping of public and non-public metrics attributed to a promoted context (posted or viewed as part of an Ads campaign).</maml:para> <maml:para>Note: Only the authenticating user can request for promoted metrics.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Please note that Twitter's search service and, by extension, the Search API is not meant to be an exhaustive source of Tweets. Not all Tweets will be indexed or made available via the search interface.</maml:para> <maml:para>To learn how to use Twitter Search effectively, please see the Standard search operators page for a list of available filter operators.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Search-Tweet -SearchString '(from:thedavecarroll) (#BluebirdPS)' Id : 1395753890352701446 Text : @mikefrobbins @karlprosser @sunnyc7 @PSHOrg @JeffHicks @PowerTip @Josh_Atwell @ravikanth @ScriptWarrior @SAPIENTech @MaxTrinidad The #PSFollowFriday Tweet brought to you by #BluebirdPS. https://t.co/9ZRyGjusRq Attachments : MediaInfo AuthorId : 292670084 ContextAnnotations : ConversationId : 1395747574317998080 CreatedAt : 5/21/2021 2:50:33 PM Entities : {#PSFollowFriday, #BluebirdPS, @mikefrobbins, @karlprosser…} Geo : InReplyToUserId : 292670084 Language : en NonPublicMetrics : OrganicMetrics : PossiblySensitive : False PromotedMetrics : PublicMetrics : RetweetCount: 0, ReplyCount: 0, LikeCount: 1, QuoteCount: 0 ReferencedTweets : {1395747574317998080} ReplySettings : Everyone Source : BluebirdPS Withheld :</dev:code> <dev:remarks> <maml:para>Returns a collection of relevant Tweets matching a specified query.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Searches/Search-Tweet</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - Search Standard Operators</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/rules-and-filtering/overview/standard-operators</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/tweets/search/recent</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-recent</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterPermissions</command:name> <command:verb>Get</command:verb> <command:noun>TwitterPermissions</command:noun> <maml:description> <maml:para>Returns the permissions for the authenticating user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the permissions for the authenticating user.</maml:para> <maml:para>If you are only able to view data, Get-* commands, or cannot retrieve direct messages, use this to verify your permissions.</maml:para> <maml:para>Use the Twitter Developer Portal to update your permissions.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterPermissions</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterPermissions Read/Write/DirectMessages</dev:code> <dev:remarks> <maml:para>Returns the permissions for the authenticating user.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Supporting%20Commands/Get-TwitterPermissions</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Twitter Developer Portal</maml:linkText> <maml:uri>https://developer.twitter.com/en/portal/dashboard</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterRateLimitStatus</command:name> <command:verb>Get</command:verb> <command:noun>TwitterRateLimitStatus</command:noun> <maml:description> <maml:para>Returns the current rate limits for methods belonging to the specified resource families.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns the current rate limits for methods belonging to the specified resource families.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterRateLimitStatus</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Resources</maml:name> <maml:description> <maml:para>A comma-separated list of resource families you want to know the current rate limit disposition for.</maml:para> <maml:para>For best performance, only specify the resource families pertinent to your application.</maml:para> <maml:para>See API Rate Limiting for more information.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">lists</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">application</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">mutes</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">live_video_stream</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">friendships</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">guide</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">auth</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">blocks</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">geo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">users</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">teams</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">followers</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">collections</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">statuses</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">custom_profiles</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">webhooks</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">contacts</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">labs</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">i</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">tweet_prompts</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">moments</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">limiter_scalding_report_creation</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">fleets</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">help</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">feedback</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">business_experience</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">graphql&POST</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">friends</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">sandbox</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">drafts</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">direct_messages</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">media</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">traffic</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">account_activity</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">account</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">safety</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">favorites</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">device</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">tweets</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">saved_searches</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">oauth</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">search</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">trends</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">live_pipeline</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">graphql</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Resources</maml:name> <maml:description> <maml:para>A comma-separated list of resource families you want to know the current rate limit disposition for.</maml:para> <maml:para>For best performance, only specify the resource families pertinent to your application.</maml:para> <maml:para>See API Rate Limiting for more information.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterRateLimitStatus</dev:code> <dev:remarks> <maml:para>Returns the current rate limits for all resources.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $SavedSearches = Get-TwitterRateLimitStatus -Resources saved_searches PS > $SavedSearches.resources.saved_searches | Format-List /saved_searches/destroy/:id : @{limit=15; remaining=15; reset=1621904304} /saved_searches/show/:id : @{limit=15; remaining=15; reset=1621904304} /saved_searches/list : @{limit=15; remaining=15; reset=1621904304}</dev:code> <dev:remarks> <maml:para>Returns the current rate limits for the friends resource.</maml:para> <maml:para>The output was converted to JSON for easier readability.</maml:para> <maml:para>NOTE: This command currently returns the raw API response.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Supporting%20Commands/Get-TwitterRateLimitStatus</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET application/rate_limit_status</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/developer-utilities/rate-limit-status/api-reference/get-application-rate_limit_status</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-TwitterRequest</command:name> <command:verb>Invoke</command:verb> <command:noun>TwitterRequest</command:noun> <maml:description> <maml:para>Sends a request to the Twitter API and returns rich objects or the raw API output.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sends a request to the Twitter API and returns rich objects or the raw API output.</maml:para> <maml:para>If BluebirdPS does not have a corresponding command to call a specific endpoint, this command can be used to send a request to the endpoint.</maml:para> <maml:para>The API response is parsed based on the endpoint version, returning rich objects, or raw API output if no suitable object type exists.</maml:para> <maml:para>This command handles API v2 pagination and v1.1 cursoring. Specifically, it will recurse when the raw API output includes meta.next_token or next_cursor.</maml:para> <maml:para>Beginning with v0.8.2, this command supports the waiting and resuming of API calls when the rate limit has been reached. With the BluebirdPS Configuration value for RateLimitAction set to `Resume`, the command will wait until the rate limit is reset and resume the current request. It will only resume up to an hour (60 minutes) after the initial rate limit breach. For most endpoints, this will allow another 4 API calls.</maml:para> <maml:para>See the contextual help about_BluebirdPS_TwitterRequest for details on using [BluebirdPS.TwitterRequest] class.</maml:para> <maml:para>NOTE: This command does not handle any Twitter API streams and has only been tested against Standard v1.1 and v2 endpoints.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-TwitterRequest</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>RequestParameters</maml:name> <maml:description> <maml:para>A TwitterRequest object instance providing the HTTP method, endpoint, query, OAuth version, and more.</maml:para> <maml:para>See about_TwitterRequest for details on using [BluebirdPS.TwitterRequest] class.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.TwitterRequest</command:parameterValue> <dev:type> <maml:name>BluebirdPS.TwitterRequest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>RequestParameters</maml:name> <maml:description> <maml:para>A TwitterRequest object instance providing the HTTP method, endpoint, query, OAuth version, and more.</maml:para> <maml:para>See about_TwitterRequest for details on using [BluebirdPS.TwitterRequest] class.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.TwitterRequest</command:parameterValue> <dev:type> <maml:name>BluebirdPS.TwitterRequest</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BluebirdPS.TwitterRequest</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSCustomObject</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > $Request = [BluebirdPS.TwitterRequest]@{ ExpansionType = 'User' Endpoint = 'https://api.twitter.com/2/users/by/username/bluebirdps' } PS > Invoke-TwitterRequest -RequestParameters $Request Id : 1330877955057344513 Name : BluebirdPS UserName : BluebirdPS CreatedAt : 11/23/2020 2:17:32 PM Description : #BluebirdPS is a Twitter automation client for #PowerShell 7. https://t.co/QcqHJ4gnHC https://t.co/UAip1CqJBb Entities : {https://bluebirdps.dev/, http://bit.ly/BluebirdPSDoc, http://bit.ly/BluebirdPSDiscussion} Location : Nashville, TN PinnedTweetId : ProfileImageUrl : https://abs.twimg.com/sticky/default_profile_images/default_profile_normal.png Protected : False PublicMetrics : FollowersCount: 1, FollowingCount: 4, ListedCount: 0, TweetCount: 0 Url : https://t.co/4Nk6DJgHFT Verified : False Withheld :</dev:code> <dev:remarks> <maml:para>Get the user BluebirdPS using the specified endpoint using all field expansions for users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $Request = [BluebirdPS.TwitterRequest]@{ Endpoint = 'https://api.twitter.com/2/users/by/username/bluebirdps' } PS > Invoke-TwitterRequest -RequestParameters $Request Id : 1330877955057344513 Name : UserName : BluebirdPS CreatedAt : Description : Entities : Location : PinnedTweetId : ProfileImageUrl : Protected : False PublicMetrics : Url : Verified : False Withheld :</dev:code> <dev:remarks> <maml:para>Get the user BluebirdPS using the specified endpoint without using any field expansions.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS > Set-BluebirdPSConfiguration -OutputType JSON PS > $Request = [BluebirdPS.TwitterRequest]@{ ExpansionType = 'User' Endpoint = 'https://api.twitter.com/2/users/by/username/bluebirdps' } PS > Invoke-TwitterRequest -RequestParameters $Request { "data": { "username": "BluebirdPS", "profile_image_url": "https://abs.twimg.com/sticky/default_profile_images/default_profile_normal.png", "name": "BluebirdPS", "id": "1330877955057344513", "url": "https://t.co/4Nk6DJgHFT", "location": "Nashville, TN", "verified": false, "entities": { "url": "@{urls=System.Object[]}", "description": "@{urls=System.Object[]; hashtags=System.Object[]}" }, "created_at": "2020-11-23T14:17:32Z", "public_metrics": { "followers_count": 1, "following_count": 4, "tweet_count": 0, "listed_count": 0 }, "protected": false, "description": "#BluebirdPS is a Twitter automation client for #PowerShell 7. https://t.co/QcqHJ4gnHC https://t.co/UAip1CqJBb" } }</dev:code> <dev:remarks> <maml:para>Set the BluebirdPS configuration value for OutputType to JSON, then get the user BluebirdPS using the specified endpoint with field expansions. Returns the raw API output.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Supporting%20Commands/Invoke-TwitterRequest</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-Tweet</command:name> <command:verb>Get</command:verb> <command:noun>Tweet</command:noun> <maml:description> <maml:para>Returns one or more Tweets.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns one or more Tweets, or a Tweet conversation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-Tweet</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>One or more Tweet id's to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include additional data objects, such as the Tweet author's user, mentioned users, media, poll, and more.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NonPublicMetrics</maml:name> <maml:description> <maml:para>Include non-public engagement metrics for the Tweet at the time of the request.</maml:para> <maml:para>NonPublic metrics include ImpressionCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganicMetrics</maml:name> <maml:description> <maml:para>Include engagement metrics, tracked in an organic context, for the Tweet at the time of the request.</maml:para> <maml:para>OrganicMetrics include ImpressionCount, LikeCount, ReplyCount, RetweetCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PromotedMetrics</maml:name> <maml:description> <maml:para>Include engagement metrics, tracked in a promoted context, for the Tweet at the time of the request.</maml:para> <maml:para>PromotedMetrics include ImpressionCount, LikeCount, ReplyCount, RetweetCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>One or more Tweet id's to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include additional data objects, such as the Tweet author's user, mentioned users, media, poll, and more.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NonPublicMetrics</maml:name> <maml:description> <maml:para>Include non-public engagement metrics for the Tweet at the time of the request.</maml:para> <maml:para>NonPublic metrics include ImpressionCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganicMetrics</maml:name> <maml:description> <maml:para>Include engagement metrics, tracked in an organic context, for the Tweet at the time of the request.</maml:para> <maml:para>OrganicMetrics include ImpressionCount, LikeCount, ReplyCount, RetweetCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PromotedMetrics</maml:name> <maml:description> <maml:para>Include engagement metrics, tracked in a promoted context, for the Tweet at the time of the request.</maml:para> <maml:para>PromotedMetrics include ImpressionCount, LikeCount, ReplyCount, RetweetCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-Tweet -Id 1306447142052155394 Id : 1306447142052155394 Text : In the #PSConfBook, Vol 3, you'll find 22 chapters containing great information on using #PowerShell for systems management, in #DevOps practices, and some tips and tricks. Slide to the right to increase your support of @DevOpsOrg #OnRampScholarships. https://t.co/c5JlxW9K9b Attachments : AuthorId : 292670084 ContextAnnotations : ConversationId : 1306447142052155394 CreatedAt : 9/17/2020 4:17:25 AM Entities : {#PSConfBook, #PowerShell, #DevOps, #OnRampScholarships…} Geo : InReplyToUserId : Language : en NonPublicMetrics : OrganicMetrics : PossiblySensitive : False PromotedMetrics : PublicMetrics : RetweetCount: 9, ReplyCount: 0, LikeCount: 11, QuoteCount: 2 ReferencedTweets : ReplySettings : Everyone Source : Twitter for iPhone Withheld :</dev:code> <dev:remarks> <maml:para>Returns the Tweet specified by the Id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-Tweet -Id 1306447142052155394 -IncludeExpansions Id : 1306447142052155394 Text : In the #PSConfBook, Vol 3, you'll find 22 chapters containing great information on using #PowerShell for systems management, in #DevOps practices, and some tips and tricks. Slide to the right to increase your support of @DevOpsOrg #OnRampScholarships. https://t.co/c5JlxW9K9b Attachments : AuthorId : 292670084 ContextAnnotations : ConversationId : 1306447142052155394 CreatedAt : 9/17/2020 4:17:25 AM Entities : {#PSConfBook, #PowerShell, #DevOps, #OnRampScholarships…} Geo : InReplyToUserId : Language : en NonPublicMetrics : OrganicMetrics : PossiblySensitive : False PromotedMetrics : PublicMetrics : RetweetCount: 9, ReplyCount: 0, LikeCount: 11, QuoteCount: 2 ReferencedTweets : ReplySettings : Everyone Source : Twitter for iPhone Withheld : Id : 292670084 Name : Dave Carroll UserName : thedavecarroll CreatedAt : 5/4/2011 1:22:46 AM Description : Married to an amazing woman. #PowerShell #Blogger #RushTheBand #RetroComputing #Puns #Doggos #Tech #StarTrek #INTJ https://t.co/fLbRHoxt39 Entities : {https://powershell.anovelidea.org/, https://pronoun.is/he} Location : Nashville, TN PinnedTweetId : 1385709814890864648 ProfileImageUrl : https://pbs.twimg.com/profile_images/1332944757186760704/s4AjaIMg_normal.jpg Protected : False PublicMetrics : FollowersCount: 945, FollowingCount: 1653, ListedCount: 27, TweetCount: 6470 Url : https://t.co/G5ojwP677I Verified : False Withheld : Id : 4705903393 Name : DevOps Collective UserName : DevOpsOrg CreatedAt : 1/3/2016 11:29:09 PM Description : Education and more for the Ops side of the DevOps world Entities : {http://devopscollective.org/} Location : PinnedTweetId : ProfileImageUrl : https://pbs.twimg.com/profile_images/1148661591661039623/6pIYwPt0_normal.jpg Protected : False PublicMetrics : FollowersCount: 692, FollowingCount: 19, ListedCount: 5, TweetCount: 137 Url : https://t.co/Mn3cXPzLUU Verified : False Withheld :</dev:code> <dev:remarks> <maml:para>Returns the Tweet specified by the Id and include any expansions.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Get-Tweet</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/tweets/:id</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/tweets/lookup/api-reference/get-tweets-id</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/tweets</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/tweets/lookup/api-reference/get-tweets</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/tweets/search/recent</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-recent</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TweetConversation</command:name> <command:verb>Get</command:verb> <command:noun>TweetConversation</command:noun> <maml:description> <maml:para>This command returns the original Tweet and any Tweets that were part of the conversation/thread.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>This command returns the original Tweet and any Tweets that were part of the conversation/thread.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TweetConversation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the Tweet to retrieve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include additional data objects, such as the Tweet author's user, mentioned users, media, poll, and more.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NonPublicMetrics</maml:name> <maml:description> <maml:para>Include this parameter to display the non-public metrics for returned data.</maml:para> <maml:para>Note: Only the authenticating user can request for non-public metrics.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganicMetrics</maml:name> <maml:description> <maml:para>Include this parameter to display the grouping of public and non-public metrics attributed to an organic context (posted and viewed in a regular manner).</maml:para> <maml:para>Note: Only the authenticating user can request for organic metrics.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PromotedMetrics</maml:name> <maml:description> <maml:para>Include this parameter to display the grouping of public and non-public metrics attributed to a promoted context (posted or viewed as part of an Ads campaign).</maml:para> <maml:para>Note: Only the authenticating user can request for promoted metrics.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TweetConversation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Tweet</maml:name> <maml:description> <maml:para>A Tweet object returned by a command directly or as part of the included objects of a User object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.TweetInfo.Tweet</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include additional data objects, such as the Tweet author's user, mentioned users, media, poll, and more.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NonPublicMetrics</maml:name> <maml:description> <maml:para>Include this parameter to display the non-public metrics for returned data.</maml:para> <maml:para>Note: Only the authenticating user can request for non-public metrics.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganicMetrics</maml:name> <maml:description> <maml:para>Include this parameter to display the grouping of public and non-public metrics attributed to an organic context (posted and viewed in a regular manner).</maml:para> <maml:para>Note: Only the authenticating user can request for organic metrics.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PromotedMetrics</maml:name> <maml:description> <maml:para>Include this parameter to display the grouping of public and non-public metrics attributed to a promoted context (posted or viewed as part of an Ads campaign).</maml:para> <maml:para>Note: Only the authenticating user can request for promoted metrics.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The ID of the Tweet to retrieve</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Tweet</maml:name> <maml:description> <maml:para>A Tweet object returned by a command directly or as part of the included objects of a User object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.TweetInfo.Tweet</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include additional data objects, such as the Tweet author's user, mentioned users, media, poll, and more.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NonPublicMetrics</maml:name> <maml:description> <maml:para>Include this parameter to display the non-public metrics for returned data.</maml:para> <maml:para>Note: Only the authenticating user can request for non-public metrics.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganicMetrics</maml:name> <maml:description> <maml:para>Include this parameter to display the grouping of public and non-public metrics attributed to an organic context (posted and viewed in a regular manner).</maml:para> <maml:para>Note: Only the authenticating user can request for organic metrics.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PromotedMetrics</maml:name> <maml:description> <maml:para>Include this parameter to display the grouping of public and non-public metrics attributed to a promoted context (posted or viewed as part of an Ads campaign).</maml:para> <maml:para>Note: Only the authenticating user can request for promoted metrics.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.MediaInfo.Media</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.Objects.Poll</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TweetConversation -Id 1587370017565429760 | Format-Table -Property Id,CreatedAt,AuthorId -AutoSize Id CreatedAt AuthorId -- --------- -------- 1587370017565429760 11/1/2022 9:04:38 AM 2993481 1587561286606397441 11/1/2022 9:44:40 PM 19965407 1587515965377347584 11/1/2022 6:44:35 PM 792360012 1587468671970066439 11/1/2022 3:36:39 PM 3467737234 1587445159029100546 11/1/2022 2:03:13 PM 97056057 1587439140052037632 11/1/2022 1:39:18 PM 2993481 1587438471718862848 11/1/2022 1:36:39 PM 2993481 1587434432432115713 11/1/2022 1:20:36 PM 97056057 1587432541769842689 11/1/2022 1:13:05 PM 827673195746570241 1587430131748028417 11/1/2022 1:03:31 PM 126812846 1587408225166659584 11/1/2022 11:36:28 AM 15106967 1587404144087912448 11/1/2022 11:20:15 AM 2993481 1587382983417335809 11/1/2022 9:56:10 AM 25658337 1587370205050806272 11/1/2022 9:05:23 AM 2993481</dev:code> <dev:remarks> <maml:para>Return the tweets within the provided conversation.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Get-TweetConversation</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/tweets/search/recent</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/tweets/search/api-reference/get-tweets-search-recent</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - Conversation ID</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/conversation-id</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TweetCount</command:name> <command:verb>Get</command:verb> <command:noun>TweetCount</command:noun> <maml:description> <maml:para>Returns a time series of count of Tweets from the last seven days that match a search query.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a time series of count of Tweets from the last seven days that match a search query.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TweetCount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>The search string consisting of text and Twitter search operators.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Granularity</maml:name> <maml:description> <maml:para>Specifies the granularity that you want the time series count data to be grouped by.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Minute</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Hour</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Day</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>The oldest or earliest timestamp from which the Tweet counts will be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>The newest or most recent timestamp from which the Tweet counts will be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SinceId</maml:name> <maml:description> <maml:para>Returns results with a Tweet Id greater than (that is, more recent than) the specified SinceId.</maml:para> <maml:para>The Id is exclusive and responses will not include it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>UntilId</maml:name> <maml:description> <maml:para>Returns results with a Tweet ID less less than (that is, older than) the specified UntilId.</maml:para> <maml:para>The Id is exclusive and responses will not include it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CountOnly</maml:name> <maml:description> <maml:para>Returns only the count of Tweets for the search query.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TweetCount</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>The search string consisting of text and Twitter search operators.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Granularity</maml:name> <maml:description> <maml:para>Specifies the granularity that you want the time series count data to be grouped by.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Minute</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Hour</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Day</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>The oldest or earliest timestamp from which the Tweet counts will be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>The newest or most recent timestamp from which the Tweet counts will be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SinceId</maml:name> <maml:description> <maml:para>Returns results with a Tweet Id greater than (that is, more recent than) the specified SinceId.</maml:para> <maml:para>The Id is exclusive and responses will not include it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>UntilId</maml:name> <maml:description> <maml:para>Returns results with a Tweet ID less less than (that is, older than) the specified UntilId.</maml:para> <maml:para>The Id is exclusive and responses will not include it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Summary</maml:name> <maml:description> <maml:para>Returns a summary of the search query.</maml:para> <maml:para>This summary includes the search string, granularity used in the call, the start and end times that bound the search results, and the total Tweet count.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>The search string consisting of text and Twitter search operators.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Granularity</maml:name> <maml:description> <maml:para>Specifies the granularity that you want the time series count data to be grouped by.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>The oldest or earliest timestamp from which the Tweet counts will be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>The newest or most recent timestamp from which the Tweet counts will be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>SinceId</maml:name> <maml:description> <maml:para>Returns results with a Tweet Id greater than (that is, more recent than) the specified SinceId.</maml:para> <maml:para>The Id is exclusive and responses will not include it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>UntilId</maml:name> <maml:description> <maml:para>Returns results with a Tweet ID less less than (that is, older than) the specified UntilId.</maml:para> <maml:para>The Id is exclusive and responses will not include it.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>CountOnly</maml:name> <maml:description> <maml:para>Returns only the count of Tweets for the search query.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Summary</maml:name> <maml:description> <maml:para>Returns a summary of the search query.</maml:para> <maml:para>This summary includes the search string, granularity used in the call, the start and end times that bound the search results, and the total Tweet count.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TweetCount -SearchString '#PowerShell' Start End Count ----- --- ----- 6/18/2021 7:25:13 PM 6/18/2021 8:00:00 PM 2 6/18/2021 8:00:00 PM 6/18/2021 9:00:00 PM 9 6/18/2021 9:00:00 PM 6/18/2021 10:00:00 PM 4 <truncated> 6/25/2021 5:00:00 PM 6/25/2021 6:00:00 PM 5 6/25/2021 6:00:00 PM 6/25/2021 7:00:00 PM 6 6/25/2021 7:00:00 PM 6/25/2021 7:25:13 PM 1</dev:code> <dev:remarks> <maml:para>Returns an hourly count of the Tweets matching the search string for the last 7 days.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TweetCount -SearchString '#PowerShell' -Granularity Day -StartTime (Get-Date).AddDays(-3) Start End Count ----- --- ----- 6/22/2021 7:27:10 PM 6/23/2021 7:00:00 PM 187 6/23/2021 7:00:00 PM 6/24/2021 7:00:00 PM 193 6/24/2021 7:00:00 PM 6/25/2021 7:00:00 PM 235 6/25/2021 7:00:00 PM 6/25/2021 7:27:00 PM 1</dev:code> <dev:remarks> <maml:para>Returns a daily count of the Tweets matching the search string for the last 4 days.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS > Get-TweetCount -SearchString '#PowerShell' -Summary SearchString : #PowerShell Granularity : Hour StartTime : 6/18/2021 7:27:54 PM EndTime : 6/25/2021 7:27:54 PM TotalCount : 1357</dev:code> <dev:remarks> <maml:para>Returns a summary for Tweets matching the search string for the last 7 days.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS > Get-TweetCount -SearchString '#PowerShell' -CountOnly 1357</dev:code> <dev:remarks> <maml:para>Returns only the total Tweets matching the search string for the last 7 days.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Get-TweetCount</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Tweet</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Get-Tweet</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/tweets/counts/recent</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/tweets/counts/api-reference/get-tweets-counts-recent</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TweetLikes</command:name> <command:verb>Get</command:verb> <command:noun>TweetLikes</command:noun> <maml:description> <maml:para>Return a Tweet's liking users.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Return a Tweet's liking users.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TweetLikes</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the pinned Tweet for a liking user.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TweetLikes</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the pinned Tweet for a liking user.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Tweet</maml:name> <maml:description> <maml:para>A Tweet object returned by a command directly or as part of the included objects of a User object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.TweetInfo.Tweet</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the pinned Tweet for a liking user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Tweet</maml:name> <maml:description> <maml:para>A Tweet object returned by a command directly or as part of the included objects of a User object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.TweetInfo.Tweet</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TweetLikes -Id 1398279333823791104</dev:code> <dev:remarks> <maml:para>Returns the Tweets liking users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TweetLikes -Id 1398279333823791104 -IncludeExpansions</dev:code> <dev:remarks> <maml:para>Returns the Tweets liking users and their pinned Tweets.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Get-TweetLikes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/tweets/:id/liking_users</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/get-tweets-id-liking_users</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TweetPoll</command:name> <command:verb>Get</command:verb> <command:noun>TweetPoll</command:noun> <maml:description> <maml:para>Display the Poll associated with a Tweet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Display the Poll associated with a Tweet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TweetPoll</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of Tweet object which has a poll.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TweetPoll</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Tweet</maml:name> <maml:description> <maml:para>A Tweet object which has a poll.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.TweetInfo.Tweet</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of Tweet object which has a poll.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Tweet</maml:name> <maml:description> <maml:para>A Tweet object which has a poll.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.TweetInfo.Tweet</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.Objects.Poll</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TweetPoll -Id 1394308323839815687 Id : 1394308323424485378 Options : {1) Id:12, 2) ObjectTypeId w/alias Id:3} Duration : 1440 EndDateTime : 5/18/2021 3:06:23 PM VotingStatus : Closed</dev:code> <dev:remarks> <maml:para>Display the Poll associated with a Tweet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-Tweet -Id 1394308323839815687 | Get-TweetPoll</dev:code> <dev:remarks> <maml:para>Display the Poll associated with a Tweet. The results are the same from example 1.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Get-TweetPoll</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Tweet</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Get-Tweet</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterTimeline</command:name> <command:verb>Get</command:verb> <command:noun>TwitterTimeline</command:noun> <maml:description> <maml:para>Returns Tweets composed by the specified user or that mention the specified user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns Tweets composed by the specified user or that mention the specified user.</maml:para> <maml:para>You can retrieve the most recent Tweets with maximum of 3200 composed by the user or 800 mentioning the user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterTimeline</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to retrieve the Tweet timeline or mention timeline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Exclude</maml:name> <maml:description> <maml:para>Exclude Retweets, Replies, or both from the results.</maml:para> <maml:para>NOTE: If you exclude Replies, only the most recent 800 Tweets are returned.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Retweets</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Replies</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include additional data objects, such as the Tweet author's user, mentioned users, media, poll, and more.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NonPublicMetrics</maml:name> <maml:description> <maml:para>Include non-public engagement metrics for the Tweet at the time of the request.</maml:para> <maml:para>NonPublicMetrics include ImpressionCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganicMetrics</maml:name> <maml:description> <maml:para>Include engagement metrics, tracked in an organic context, for the Tweet at the time of the request.</maml:para> <maml:para>OrganicMetrics include ImpressionCount, LikeCount, ReplyCount, RetweetCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PromotedMetrics</maml:name> <maml:description> <maml:para>Include engagement metrics, tracked in a promoted context, for the Tweet at the time of the request.</maml:para> <maml:para>PromotedMetrics include ImpressionCount, LikeCount, ReplyCount, RetweetCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>The oldest or earliest timestamp from which the Tweets will be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>The newest or most recent timestamp from which the Tweets will be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SinceId</maml:name> <maml:description> <maml:para>Returns results with a Tweet Id greater than (that is, more recent than) the specified SinceId.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UntilId</maml:name> <maml:description> <maml:para>Returns results with a Tweet ID less less than (that is, older than) the specified UntilId.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TwitterTimeline</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to retrieve the Tweet timeline or mention timeline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include additional data objects, such as the Tweet author's user, mentioned users, media, poll, and more.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Mentions</maml:name> <maml:description> <maml:para>Specifies to retrieve Tweets that mention the specified user.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NonPublicMetrics</maml:name> <maml:description> <maml:para>Include non-public engagement metrics for the Tweet at the time of the request.</maml:para> <maml:para>NonPublicMetrics include ImpressionCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganicMetrics</maml:name> <maml:description> <maml:para>Include engagement metrics, tracked in an organic context, for the Tweet at the time of the request.</maml:para> <maml:para>OrganicMetrics include ImpressionCount, LikeCount, ReplyCount, RetweetCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PromotedMetrics</maml:name> <maml:description> <maml:para>Include engagement metrics, tracked in a promoted context, for the Tweet at the time of the request.</maml:para> <maml:para>PromotedMetrics include ImpressionCount, LikeCount, ReplyCount, RetweetCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>The oldest or earliest timestamp from which the Tweets will be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>The newest or most recent timestamp from which the Tweets will be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SinceId</maml:name> <maml:description> <maml:para>Returns results with a Tweet Id greater than (that is, more recent than) the specified SinceId.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UntilId</maml:name> <maml:description> <maml:para>Returns results with a Tweet ID less less than (that is, older than) the specified UntilId.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to retrieve the Tweet timeline or mention timeline.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Exclude</maml:name> <maml:description> <maml:para>Exclude Retweets, Replies, or both from the results.</maml:para> <maml:para>NOTE: If you exclude Replies, only the most recent 800 Tweets are returned.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include additional data objects, such as the Tweet author's user, mentioned users, media, poll, and more.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Mentions</maml:name> <maml:description> <maml:para>Specifies to retrieve Tweets that mention the specified user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NonPublicMetrics</maml:name> <maml:description> <maml:para>Include non-public engagement metrics for the Tweet at the time of the request.</maml:para> <maml:para>NonPublicMetrics include ImpressionCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>OrganicMetrics</maml:name> <maml:description> <maml:para>Include engagement metrics, tracked in an organic context, for the Tweet at the time of the request.</maml:para> <maml:para>OrganicMetrics include ImpressionCount, LikeCount, ReplyCount, RetweetCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PromotedMetrics</maml:name> <maml:description> <maml:para>Include engagement metrics, tracked in a promoted context, for the Tweet at the time of the request.</maml:para> <maml:para>PromotedMetrics include ImpressionCount, LikeCount, ReplyCount, RetweetCount, UrlLinkClicks, and UserProfileClicks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>StartTime</maml:name> <maml:description> <maml:para>The oldest or earliest timestamp from which the Tweets will be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>EndTime</maml:name> <maml:description> <maml:para>The newest or most recent timestamp from which the Tweets will be provided.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.DateTime</command:parameterValue> <dev:type> <maml:name>System.DateTime</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SinceId</maml:name> <maml:description> <maml:para>Returns results with a Tweet Id greater than (that is, more recent than) the specified SinceId.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>UntilId</maml:name> <maml:description> <maml:para>Returns results with a Tweet ID less less than (that is, older than) the specified UntilId.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser | Get-TwitterTimeline</dev:code> <dev:remarks> <maml:para>Return the Tweet timeline for the authenticating user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User TwitterDev | Get-TwitterTimeline -Mentions</dev:code> <dev:remarks> <maml:para>Return the Tweet timeline for the specified user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User TwitterDev | Get-TwitterTimeline -StartTime (Get-Date '01/01/2020') -EndTime (Get-Date '12/31/2020') -Exclude Retweets,Replies</dev:code> <dev:remarks> <maml:para>Return the Tweet timeline for the specified user for Tweets composed during the year 2020 and excluding any retweets and replies.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User TwitterApi | Get-TwitterTimeline -SinceId 1394657341472088066</dev:code> <dev:remarks> <maml:para>Return the Tweet timeline for the specified user for Tweets composed after the specified Tweet Id.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Get-TwitterTimeline</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterUser</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/users/:id/tweets</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-tweets</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/users/:id/mentions</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/tweets/timelines/api-reference/get-users-id-mentions</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Publish-Tweet</command:name> <command:verb>Publish</command:verb> <command:noun>Tweet</command:noun> <maml:description> <maml:para>Publishes a Tweet for the authenticating user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Publishes a Tweet for the authenticating user.</maml:para> <maml:para>Duplicate Tweets are not allowed, that is to say, a user cannot post the same Tweet twice in a row.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Publish-Tweet</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>TweetText</maml:name> <maml:description> <maml:para>The text of the Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ReplyToTweet</maml:name> <maml:description> <maml:para>The id of an existing Tweet to which the authenticating user wants to reply.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>MediaId</maml:name> <maml:description> <maml:para>The MediaId returned from the Send-TwitterMedia command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>QuoteTweet</maml:name> <maml:description> <maml:para>Sets the tweet that is being quoted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Publish-Tweet</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>TweetText</maml:name> <maml:description> <maml:para>The text of the Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ReplyToTweet</maml:name> <maml:description> <maml:para>The id of an existing Tweet to which the authenticating user wants to reply.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the full path to the media file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Specifies the type and use for the uploaded media.</maml:para> </maml:description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">TweetImage</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TweetVideo</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">TweetGif</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AltImageText</maml:name> <maml:description> <maml:para>Provide additional information about the images or GIFs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>QuoteTweet</maml:name> <maml:description> <maml:para>Sets the tweet that is being quoted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>TweetText</maml:name> <maml:description> <maml:para>The text of the Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>MediaId</maml:name> <maml:description> <maml:para>The MediaId returned from the Send-TwitterMedia command.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>ReplyToTweet</maml:name> <maml:description> <maml:para>The id of an existing Tweet to which the authenticating user wants to reply.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Path</maml:name> <maml:description> <maml:para>Specify the full path to the media file.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Category</maml:name> <maml:description> <maml:para>Specifies the type and use for the uploaded media.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>AltImageText</maml:name> <maml:description> <maml:para>Provide additional information about the images or GIFs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>QuoteTweet</maml:name> <maml:description> <maml:para>Sets the tweet that is being quoted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Publish-Tweet -TweetText 'Getting an example for documentation for the Publish-Tweet command of the #BluebirdPS #PowerShell 7 module for Twitter.'</dev:code> <dev:remarks> <maml:para>Publishes the provided text for the authenticating user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Publish-Tweet -TweetText "It took a long time to get this update out. I hope you will find much more useful when working with the Twitter API. #BluebirdPS #PSTweetChat" -ReplyToTweet 1400861303053467650 Id : 1400862088432599045 Text : @JeffHicks It took a long time to get this update out. I hope you will find much more useful when working with the Twitter API. #BluebirdPS #PSTweetChat Attachments : AuthorId : 292670084 ContextAnnotations : ConversationId : 1400861303053467650 CreatedAt : 6/4/2021 5:08:43 PM Entities : {Product: Twitter API, #BluebirdPS, #PSTweetChat, @JeffHicks} Geo : InReplyToUserId : 14478644 Language : en NonPublicMetrics : OrganicMetrics : PossiblySensitive : False PromotedMetrics : PublicMetrics : RetweetCount: 0, ReplyCount: 0, LikeCount: 0, QuoteCount: 0 ReferencedTweets : {1400861303053467650} ReplySettings : Everyone Source : BluebirdPS Withheld :</dev:code> <dev:remarks> <maml:para>Publishes the provided text as a reply to the specified Tweet sfor the authenticating user.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Publish-Tweet</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Tweet</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Get-Tweet</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>API Documentation - POST /2/tweets</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/tweets/manage-tweets/api-reference/post-tweets</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-Retweet</command:name> <command:verb>Set</command:verb> <command:noun>Retweet</command:noun> <maml:description> <maml:para>Retweet or unretweet an existing Tweet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retweet or unretweet an existing Tweet.</maml:para> <maml:para>Returns the original Tweet with Retweet details embedded.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-Retweet</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Retweet</maml:name> <maml:description> <maml:para>Instructs the command to retweet the specified Tweet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-Retweet</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Unretweet</maml:name> <maml:description> <maml:para>Instructs the command to unretweet the specified Tweet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Retweet</maml:name> <maml:description> <maml:para>Instructs the command to retweet the specified Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Unretweet</maml:name> <maml:description> <maml:para>Instructs the command to unretweet the specified Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Set-Retweet -Id 1330354141055643648</dev:code> <dev:remarks> <maml:para>Retweets the specified Tweet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Set-Retweet -Id 1330354141055643648 -Unretweet</dev:code> <dev:remarks> <maml:para>Unretweets the specified Tweet.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Set-Retweet</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Tweet</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Get-Tweet</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>API Documentation - POST /2/users/:id/retweets</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/post-users-id-retweets</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>API Documentation - DELETE /2/users/:id/retweets/:source_tweet_id</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/tweets/retweets/api-reference/delete-users-id-retweets-tweet_id</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-TweetLike</command:name> <command:verb>Set</command:verb> <command:noun>TweetLike</command:noun> <maml:description> <maml:para>Likes or un-likes the specified Tweet as the authenticating user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Likes or un-likes the specified Tweet as the authenticating user.</maml:para> <maml:para>The immediately returned Tweet object may not indicate the resultant status of the Tweet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-TweetLike</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Like</maml:name> <maml:description> <maml:para>Like the specified Tweet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-TweetLike</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Unlike</maml:name> <maml:description> <maml:para>Un-like the specified Tweet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-TweetLike</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Tweet</maml:name> <maml:description> <maml:para>A Tweet object returned by a command directly or as part of the included objects of a User object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.TweetInfo.Tweet</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Unlike</maml:name> <maml:description> <maml:para>Un-like the specified Tweet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-TweetLike</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Tweet</maml:name> <maml:description> <maml:para>A Tweet object returned by a command directly or as part of the included objects of a User object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.TweetInfo.Tweet</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Like</maml:name> <maml:description> <maml:para>Like the specified Tweet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Tweet</maml:name> <maml:description> <maml:para>A Tweet object returned by a command directly or as part of the included objects of a User object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.TweetInfo.Tweet</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Like</maml:name> <maml:description> <maml:para>Like the specified Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Unlike</maml:name> <maml:description> <maml:para>Un-like the specified Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Set-TweetLike -Id 1330354141055643648</dev:code> <dev:remarks> <maml:para>Like the specified Tweet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Set-TweetLike -Id 1330354141055643648 -Unlike</dev:code> <dev:remarks> <maml:para>Un-like the specified Tweet.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Set-TweetLike</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TweetLike</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Get-TweetLike</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>API Documentation - POST /2/users/:id/likes</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/post-users-id-likes</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>API Documentation - DELETE /2/users/:id/likes/:tweet_id</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/tweets/likes/api-reference/delete-users-id-likes-tweet_id</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-TweetReply</command:name> <command:verb>Set</command:verb> <command:noun>TweetReply</command:noun> <maml:description> <maml:para>Hides or unhides a reply to a Tweet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Hides or unhides (shows) a reply to a Tweet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-TweetReply</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of Tweet to hide or show. The Tweet must belong to a conversation initiated by the authenticating user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Hide</maml:name> <maml:description> <maml:para>Hides the Tweet reply.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-TweetReply</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of Tweet to hide or show. The Tweet must belong to a conversation initiated by the authenticating user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Show</maml:name> <maml:description> <maml:para>Shows the Tweet reply.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of Tweet to hide or show. The Tweet must belong to a conversation initiated by the authenticating user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Hide</maml:name> <maml:description> <maml:para>Hides the Tweet reply.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Show</maml:name> <maml:description> <maml:para>Shows the Tweet reply.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Set-TweetReply -Id 1395747670065623050</dev:code> <dev:remarks> <maml:para>Hides the reply.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Set-TweetReply -Id 1395747670065623050 -Show</dev:code> <dev:remarks> <maml:para>Shows the reply.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Set-TweetReply</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Documentation - PUT /2/tweets/:id/hidden</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/tweets/hide-replies/api-reference/put-tweets-id-hidden</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unpublish-Tweet</command:name> <command:verb>Unpublish</command:verb> <command:noun>Tweet</command:noun> <maml:description> <maml:para>Delete the specified Tweet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete the specified Tweet.</maml:para> <maml:para>The authenticating user must be the author of the specified Tweet.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Unpublish-Tweet</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Unpublish-Tweet</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Tweet</maml:name> <maml:description> <maml:para>The Tweet object to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.TweetInfo.Tweet</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>The id of the Tweet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Tweet</maml:name> <maml:description> <maml:para>The Tweet object to delete.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.TweetInfo.Tweet</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV2.TweetInfo.Tweet</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Unpublish-Tweet -Id 1399711831015428097 Confirm Are you sure you want to perform this action? Performing the operation "Deleting Tweet" on target "Id: 1399711831015428097". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y</dev:code> <dev:remarks> <maml:para>Delete the specified Tweet.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-Tweet -Id 1399712801862598661 | Unpublish-Tweet Confirm Are you sure you want to perform this action? Performing the operation "Deleting Tweet" on target "Id: 1399712801862598661, CreatedAt: 6/1/2021 1:01:52 PM". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y</dev:code> <dev:remarks> <maml:para>Delete the specified Tweet.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Unpublish-Tweet</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-Tweet</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Get-Tweet</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Publish-Tweet</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Tweets/Publish-Tweet</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>API Documentation - DELETE /2/tweets/:id</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/tweets/manage-tweets/api-reference/delete-tweets-id</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Add-TwitterFriend</command:name> <command:verb>Add</command:verb> <command:noun>TwitterFriend</command:noun> <maml:description> <maml:para>Allows the authenticating user to follow another Twitter user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Allows the authenticating user to follow another Twitter user.</maml:para> <maml:para>If the target user does not have public Tweets, this endpoint will send a follow request.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-TwitterFriend</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the id of the user to follow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Add-TwitterFriend</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to follow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the id of the user to follow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to follow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Add-TwitterFriend -Id 1330877955057344513 Following user 1330877955057344513: True.</dev:code> <dev:remarks> <maml:para>Follow the user with the specified id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterFriend -UserName BluebirdPS | Add-TwitterFriend Following user 1330877955057344513: True.</dev:code> <dev:remarks> <maml:para>Follow the user returned by Get-TwitterUser.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Add-TwitterFriend</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TwitterFriend</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Remove-TwitterFriend</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterFriends</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterFriends</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterUser</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - POST /2/users/:id/following</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/post-users-source_user_id-following</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterBlockedUser</command:name> <command:verb>Get</command:verb> <command:noun>TwitterBlockedUser</command:noun> <maml:description> <maml:para>Returns a collection of user objects that the authenticating user is blocking.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a collection of user objects that the authenticating user is blocking.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterBlockedUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the pinned Tweet for the returned user(s).</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the pinned Tweet for the returned user(s).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterBlockedUser</dev:code> <dev:remarks> <maml:para>Returns an array of user ids that the authenticating user is blocking.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterBlockedUser -IncludeExpansions</dev:code> <dev:remarks> <maml:para>Returns a collection of user objects that the authenticating user is blocking without the last status for each.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterBlockedUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TwitterBlockedUser</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Set-TwitterBlockedUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/users/:id/blocking</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/users/blocks/api-reference/get-users-blocking</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterFollowers</command:name> <command:verb>Get</command:verb> <command:noun>TwitterFollowers</command:noun> <maml:description> <maml:para>Returns a collection of Twitter users that follows the specified user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a collection of Twitter users that follows the specified user.</maml:para> <maml:para>If no user is specified, returns the followers of the authenticating user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterFollowers</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the id of the user to return their followers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the pinned Tweet for the returned user(s).</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TwitterFollowers</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to return a list of users following them.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the pinned Tweet for the returned user(s).</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the id of the user to return their followers.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to return a list of users following them.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the pinned Tweet for the returned user(s).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterFollowers</dev:code> <dev:remarks> <maml:para>Returns the followers of the authenticating user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterFollowers -Id 1330877955057344513</dev:code> <dev:remarks> <maml:para>Returns the followers of the user specified by their id.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User BluebirdPS | Get-TwitterFollowers</dev:code> <dev:remarks> <maml:para>Unfollows the user returned by Get-TwitterUser.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterFollowers</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterUser</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/users/:id/followers</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-followers</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterFriends</command:name> <command:verb>Get</command:verb> <command:noun>TwitterFriends</command:noun> <maml:description> <maml:para>Returns a collection of Twitter users that e specified user follows.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a collection of Twitter users that e specified user follows.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterFriends</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Return a list of users followed by the user, as specified by the id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the pinned Tweet for the returned user(s).</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TwitterFriends</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>Return a list of users followed by the user, as specified by the user object returned by Get-TwitterUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the pinned Tweet for the returned user(s).</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Return a list of users followed by the user, as specified by the id.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>Return a list of users followed by the user, as specified by the user object returned by Get-TwitterUser.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the pinned Tweet for the returned user(s).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterFriends</dev:code> <dev:remarks> <maml:para>Returns the users followed by the authenticating user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterFriends -Id 1330877955057344513</dev:code> <dev:remarks> <maml:para>Returns the users followed by the specified user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User BluebirdPS | Get-TwitterFriends</dev:code> <dev:remarks> <maml:para>Returns the users followed by the user returned by Get-TwitterUser.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterFriends</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TwitterFriend</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Add-TwitterFriend</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Remove-TwitterFriend</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Remove-TwitterFriend</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterUser</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/users/:id/following</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-following</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterFriendship</command:name> <command:verb>Get</command:verb> <command:noun>TwitterFriendship</command:noun> <maml:description> <maml:para>Returns information about the friendships of the authenticating user or a source user and target user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns information about the friendships of the authenticating user or a source user and target user.</maml:para> <maml:para>Suspended users are filtered out after connections are queried.</maml:para> <maml:para>The information returned depends on the parameters used.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterFriendship</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>One or more user names to return the connection details.</maml:para> <maml:para>Connections can be: Following, FollowingRequested, FollowedBy, Blocking, Muting, or None.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TwitterFriendship</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceUserName</maml:name> <maml:description> <maml:para>Specifies the source user to return detailed information about the relationship with the target user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetUserName</maml:name> <maml:description> <maml:para>Specifies the target user to return detailed information about the relationship with the source user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TwitterFriendship</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Incoming</maml:name> <maml:description> <maml:para>Returns an array of user ids for every user who has requested to follow the authenticating user, if their Tweets are private.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TwitterFriendship</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Pending</maml:name> <maml:description> <maml:para>Returns an array of user ids for every protected user for whom the authenticating user has a pending follow request.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-TwitterFriendship</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoRetweets</maml:name> <maml:description> <maml:para>Returns an array of user ids that the authenticating user does not want to receive retweets from.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>UserName</maml:name> <maml:description> <maml:para>One or more user names to return the connection details.</maml:para> <maml:para>Connections can be: Following, FollowingRequested, FollowedBy, Blocking, Muting, or None.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SourceUserName</maml:name> <maml:description> <maml:para>Specifies the source user to return detailed information about the relationship with the target user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>TargetUserName</maml:name> <maml:description> <maml:para>Specifies the target user to return detailed information about the relationship with the source user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Incoming</maml:name> <maml:description> <maml:para>Returns an array of user ids for every user who has requested to follow the authenticating user, if their Tweets are private.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Pending</maml:name> <maml:description> <maml:para>Returns an array of user ids for every protected user for whom the authenticating user has a pending follow request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoRetweets</maml:name> <maml:description> <maml:para>Returns an array of user ids that the authenticating user does not want to receive retweets from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV1.FriendshipConnections</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV1.Relationship</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterFriendship -UserName BluebirdPS,newsbreakApp,AutoOverload,SportsCenter,AppInsights UserName Id Connections -------- -- ----------- BluebirdPS 1330877955057344513 {Following, FollowedBy} newsbreakApp 4127951894 {Blocking} AutoOverload 2896222807 {Muting} SportsCenter 26257166 {None} AppInsights 4036841419 {FollowingRequested}</dev:code> <dev:remarks> <maml:para>Providing one or more user names to return connection information between the authenticating user and the specified user(s).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > $Friendship = Get-TwitterFriendship -SourceUserName thedavecarroll -TargetUserName BillGates PS > $Friendship PS > $Friendship.Source PS > $Friendship.Target # Output for $Friendship Source Target ------ ------ thedavecarroll : Following, NotificationsEnabled, WantRetweets BillGates : FollowedBy # Output for $Friendship.Source Id : 292670084 UserName : thedavecarroll Following : True FollowedBy : False LiveFollowing : False FollowingReceived : False FollowingRequested : False NotificationsEnabled : True CanDM : False Blocking : False BlockedBy : False Muting : False WantRetweets : True AllReplies : False MarkedSpam : False # Output for $Friendship.Target Id : 50393960 UserName : BillGates Following : False FollowedBy : True FollowingReceived : False FollowingRequested : False</dev:code> <dev:remarks> <maml:para>Returns detailed information about the relationship between two users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS > Get-TwitterFriendship -Incoming | Get-TwitterUser</dev:code> <dev:remarks> <maml:para>Return a list user ids of incoming follow requests and then get information about the Twitter users that have requested to follow the authenticating user.</maml:para> <maml:para>If the authenticating user's Tweets are not protected, the command with the Incoming switch will return 0 results.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <dev:code>PS > Get-TwitterFriendship -Pending</dev:code> <dev:remarks> <maml:para>Return a list user ids of outgoing follow requests.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <dev:code>PS > Get-TwitterFriendship -NoRetweets</dev:code> <dev:remarks> <maml:para>Return a list user ids that the authenticating user does not want to see Retweets from.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterFriendship</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET friendships/lookup</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-lookup</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET friendships/show</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-show</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET friendships/outgoing</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-outgoing</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET friendships/incoming</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET friendships/no_retweets/ids</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/follow-search-get-users/api-reference/get-friendships-no_retweets-ids</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterMutedUser</command:name> <command:verb>Get</command:verb> <command:noun>TwitterMutedUser</command:noun> <maml:description> <maml:para>Returns a collection of user objects or array of user ids that the authenticating user has muted.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a collection of user objects or array of user ids that the authenticating user has muted.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterMutedUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include additional data objects, such as the Tweet author's user, mentioned users, media, poll, and more.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include additional data objects, such as the Tweet author's user, mentioned users, media, poll, and more.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>MaxResultsPerPage</maml:name> <maml:description> <maml:para>The maximum number of results to be return by each page of the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> <maml:para>You can force the command only return a single page with the NoPagination switch.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int32</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoPagination</maml:name> <maml:description> <maml:para>Only return the first page of data for the request.</maml:para> <maml:para>Note: By default, this command will request all available pages of data with each page request counting against the rate limit threshold.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterMutedUser</dev:code> <dev:remarks> <maml:para>Returns a list of user ids the authenticating user has muted.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterMutedUser | Get-TwitterUser</dev:code> <dev:remarks> <maml:para>Use the list of user ids the authenticating user has muted as input for Get-TwitterUser.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterMutedUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Set-TwitterMutedUser</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Set-TwitterMutedUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterUser</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>API Documentation - GET /2/users/:id/muting</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/get-users-muting</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-TwitterUser</command:name> <command:verb>Get</command:verb> <command:noun>TwitterUser</command:noun> <maml:description> <maml:para>Returns a variety of information about the specified user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Returns a variety of information about the specified user.</maml:para> <maml:para>If no input is provided, returns the authenticating user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-TwitterUser</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>One or more identifiers for a Twitter user. You can provide UserName, Id, or a combination of both as this command will send the appropriate request to the Twitter API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the pinned Tweet for the returned user(s).</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>One or more identifiers for a Twitter user. You can provide UserName, Id, or a combination of both as this command will send the appropriate request to the Twitter API.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeExpansions</maml:name> <maml:description> <maml:para>Include the pinned Tweet for the returned user(s).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User[]</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser Id : 292670084 Name : Dave Carroll UserName : thedavecarroll CreatedAt : 5/4/2011 1:22:46 AM Description : #PowerShell #Blogger #RushTheBand #TTRPG #RetroComputing #Puns #Doggos #Tech #StarTrek #INTJ #9w1 https://t.co/fLbRHoxt39 Entities : {https://thedavecarroll.com/, https://pronoun.is/he} Location : Nashville, TN PinnedTweetId : 1564616680000688137 ProfileImageUrl : https://pbs.twimg.com/profile_images/1509519500219146242/LV6Du2YA_normal.jpg Protected : False PublicMetrics : FollowersCount: 1138, FollowingCount: 1792, ListedCount: 36, TweetCount: 8457 Url : https://t.co/CulYKwYNG4 Verified : False Withheld :</dev:code> <dev:remarks> <maml:para>Return the authenticating user's information.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User 1330877955057344513,thedavecarroll,TwitterDev</dev:code> <dev:remarks> <maml:para>Return the user information for the 3 specified users.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS > 3234616374,1330877955057344513,'thedavecarroll' | Get-TwitterUser</dev:code> <dev:remarks> <maml:para>Return the user information for the specified user.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/users/me</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-me</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/users/by</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/users/by/username/:username</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by-username-username</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/users</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - GET /2/users/:id</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-id</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-TwitterFriend</command:name> <command:verb>Remove</command:verb> <command:noun>TwitterFriend</command:noun> <maml:description> <maml:para>Allows the authenticating user to unfollow another Twitter user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Allows the authenticating user to unfollow another Twitter user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-TwitterFriend</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the id of the user to unfollow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-TwitterFriend</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to be unfollowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Specifies the id of the user to unfollow.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to be unfollowed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>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.</dev:code> <dev:remarks> <maml:para>Unfollow the specified user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>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.</dev:code> <dev:remarks> <maml:para>Unfollow the specified user.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Remove-TwitterFriend</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Add-TwitterFriend</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Add-TwitterFriend</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterFriends</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterFriends</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterUser</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - DELETE /2/users/:source_user_id/following/:target_user_id</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/delete-users-source_id-following</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-TwitterBlockedUser</command:name> <command:verb>Set</command:verb> <command:noun>TwitterBlockedUser</command:noun> <maml:description> <maml:para>Allows the authenticating user to block or unblock another user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Allows the authenticating user to block or unblock another user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-TwitterBlockedUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to be blocked or unblocked.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Block</maml:name> <maml:description> <maml:para>Block the specified user.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-TwitterBlockedUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to be blocked or unblocked.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Unblock</maml:name> <maml:description> <maml:para>Unblock the specified user.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to be blocked or unblocked.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Block</maml:name> <maml:description> <maml:para>Block the specified user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Unblock</maml:name> <maml:description> <maml:para>Unblock the specified user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User BluebirdPS | Set-TwitterBlockedUser -Block Blocking user 1330877955057344513: True</dev:code> <dev:remarks> <maml:para>Block the specified user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User BluebirdPS | Set-TwitterBlockedUser -Unblock Blocking user 1330877955057344513: False</dev:code> <dev:remarks> <maml:para>Unblock the specified user.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Set-TwitterBlockedUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterBlockedUser</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterBlockedUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterUser</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - POST /2/users/:id/blocking</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/users/blocks/api-reference/post-users-user_id-blocking</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - DELETE /2/users/:source_user_id/blocking/:target_user_id</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/users/blocks/api-reference/delete-users-user_id-blocking</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-TwitterMutedUser</command:name> <command:verb>Set</command:verb> <command:noun>TwitterMutedUser</command:noun> <maml:description> <maml:para>Allows the authenticating user to mute or unmute another user.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Allows the authenticating user to mute or unmute another user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-TwitterMutedUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to be muted or unmuted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Mute</maml:name> <maml:description> <maml:para>Mute the specified user.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-TwitterMutedUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to be muted or unmuted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Unmute</maml:name> <maml:description> <maml:para>Unmute the specified user.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to be muted or unmuted.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Mute</maml:name> <maml:description> <maml:para>Mute the specified user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Unmute</maml:name> <maml:description> <maml:para>Unmute the specified user.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -UserName BluebirdPS | Set-TwitterMutedUser</dev:code> <dev:remarks> <maml:para>Mutes the specified user.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -UserName BluebirdPS | Set-TwitterMutedUser -Unmute</dev:code> <dev:remarks> <maml:para>Unmutes the specified user.</maml:para> <maml:para>NOTE: If you are not muting the user, an attempt to unmute will result in an error.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Set-TwitterMutedUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterMutedUser</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterMutedUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterUser</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - POST /2/users/:id/muting</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/post-users-user_id-muting</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - DELETE /2/users/:source_user_id/muting/:target_user_id</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/users/mutes/api-reference/delete-users-user_id-muting</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Submit-TwitterUserAsSpam</command:name> <command:verb>Submit</command:verb> <command:noun>TwitterUserAsSpam</command:noun> <maml:description> <maml:para>Report the specified user as a spam account to Twitter.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Report the specified user as a spam account to Twitter.</maml:para> <maml:para>You can opt to block the user by using the Block switch parameter.</maml:para> <maml:para>If you want to verify that you have reported a user, you can use the Get-TwitterFriendship command.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Submit-TwitterUserAsSpam</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to report as spam, and optionally block.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Block</maml:name> <maml:description> <maml:para>Indicates to block the specified user, at the same time as reporting them as spam.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>User</maml:name> <maml:description> <maml:para>The user object, returned by Get-TwitterUser, to report as spam, and optionally block.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">BluebirdPS.APIV2.UserInfo.User</command:parameterValue> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Block</maml:name> <maml:description> <maml:para>Indicates to block the specified user, at the same time as reporting them as spam.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"> <maml:name>Confirm</maml:name> <maml:description> <maml:para>Prompts you for confirmation before running the cmdlet.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"> <maml:name>WhatIf</maml:name> <maml:description> <maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>BluebirdPS.APIV2.UserInfo.User</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User rossxhype | Submit-TwitterUserAsSpam Confirm Are you sure you want to perform this action? Performing the operation "Report as Spam" on target "rossxhype, CreatedAt: 10/17/2015 4:42:02 AM, Description: ********". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y</dev:code> <dev:remarks> <maml:para>Report the specified user as spam.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS > Get-TwitterUser -User ihezoyetahek | Submit-TwitterUserAsSpam -Block Confirm Are you sure you want to perform this action? Performing the operation "Report as Spam and Block" on target "ihezoyetahek, CreatedAt: 10/14/2015 11:41:01 PM, Description: ********". [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"): y</dev:code> <dev:remarks> <maml:para>Report the specified user as spam as well as block them.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Submit-TwitterUserAsSpam</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterUser</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterUser</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Get-TwitterFriendship</maml:linkText> <maml:uri>https://docs.bluebirdps.dev/en/v0.8.2/Users%2C%20Followers%2C%20Friends%2C%20and%20Blocks/Get-TwitterFriendship</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Api Reference - POST users/report_spam</maml:linkText> <maml:uri>https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/mute-block-report-users/api-reference/post-users-report_spam</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |