en-US/about_BluebirdPS_TwitterRequest.help.txt
|
TOPIC
about_bluebirdps_twitterrequest SHORT DESCRIPTION The BluebirdPS module includes a class called [BluebirdPS.TwitterRequest] which can be used in conjunction with Invoke-TwitterRequest to make ad hoc calls against the Twitter API. LONG DESCRIPTION Using [BluebirdPS.TwitterRequest] will allow the user to craft requests for the Twitter API. The Invoke-TwitterRequest command performs all of the processing. Any API response that matches existing definitions will return rich objects specific to the data returned. Otherwise, the raw API response will be returned. ACADEMIC RESEARCH TRACK If your application for the Application Research track has been approved, you should be able to use the method described herein to makes requests against the search/recent/all endpoint. STREAMS NOT SUPPORTED The command Invoke-TwitterRequest uses Invoke-RestMethod which does not support response streams. You cannot use this module to consume any stream endpoints, such as /2/tweets/sample/stream or /2/tweets/search/stream. EXAMPLES Enable RawOutput in configuration. Set-BluebirdPSConfiguration -RawOutput $true UPDATE PROFILE URL $Request = [BluebirdPS.TwitterRequest]@{ HttpMethod = 'POST' Endpoint = 'https://api.twitter.com/1.1/account/update_profile.json' Query = @{ url = 'thedavecarroll.com' } } Invoke-TwitterRequest -RequestParameters $Request GET BLOCKED USERS $Request = [BluebirdPS.TwitterRequest]@{ Endpoint = 'https://api.twitter.com/2/users/292670084/blocking' } Invoke-TwitterRequest -RequestParameters $Request BluebirdPS already supports this endpoint, returning only the usernames. KEYWORDS TwitterAPI BluebirdPS.TwitterRequest Invoke-TwitterRequest |