|
NAMENet::Twitter::Lite - A perl interface to the Twitter APIVERSIONversion 0.12008STOP!You probably want Net::Twitter::Lite::WithAPIv1_1 which has support for Twitter API v1.1. If you're using a service with an API compatible with Twitter's deprecated API v1, then you're in the right place.SYNOPSISuse Net::Twitter::Lite; my $nt = Net::Twitter::Lite->new( username => $user, password => $password legacy_lists_api => 0, ); my $result = eval { $nt->update('Hello, world!') }; eval { my $statuses = $nt->friends_timeline({ since_id => $high_water, count => 100 }); for my $status ( @$statuses ) { print "$status->{created_at} <$status->{user}{screen_name}> $status->{text}\n"; } }; warn "$@\n" if $@; DESCRIPTIONThis module provides a perl interface to the Twitter API v1.It uses the same API definitions as Net::Twitter, but without the extra bells and whistles and without the additional dependencies. Same great taste, less filling. This module is related to, but is not part of the "Net::Twitter" distribution. It's API methods and API method documentation are generated from "Net::Twitter"'s internals. It exists for those who cannot, or prefer not to install Moose and its dependencies. You should consider upgrading to "Net::Twitter" for additional functionality, finer grained control over features, backwards compatibility with older versions of "Net::Twitter", and additional error handling options. CLIENT CODE CHANGES REQUIREDLegacy Lists APITwitter re-implemented the Lists API using new endpoints and semantics. For backwards compatibility, this version of "Net::Twitter::Lite" defaults to the deprecated, legacy endpoints and semantics. It issues a warning if the "legacy_lists_api" option to new is not provided.To enable the new Lists endpoints and semantics, pass "(legacy_lists_api =" 0)> to "new". To disable the warning, and keep the backwards compatible endpoints and semantics, pass "(legacy_lists_api =" 1)> to "new". The "legacy_lists_api" option to "new" sets the default for all lists API method calls. You can override the default an each API call by passing a "-legacy_lists_api" option set to 1 or 0. Support for "legacy_lists_api" option will be removed in a future version and the option to "new" will be silently ignored. netrc optionThe default "apiurl" changed in version 0.08006. The change should be transparent to client code, unless you're using the "netrc" option. If so, you'll need to either update the ".netrc" entry and change the "machine" value from "twitter.com" to "api.twitter.com", or set either the "netrc" or "netrc_machine" options to "twitter.com".$nt = Net::Twitter::Lite->new(netrc_machine => 'twitter.com', netrc => 1); # -or- $nt = Net::Twitter::Lite->new(netrc => 'twitter.com'); OAuth requires callback parameterBeginning with version 0.03, it is necessary for web applications using OAuth authentication to pass the "callback" parameter to "get_authorization_url". In the absence of a callback parameter, when the user authorizes the application a PIN number is displayed rather than redirecting the user back to your site.MIGRATING FROM NET::TWITTER 2.xIf you are migrating from Net::Twitter 2.12 (or an earlier version), you may need to make some minor changes to your application code in order to user Net::Twitter::Lite successfully.The primary difference is in error handling. Net::Twitter::Lite throws exceptions on error. It does not support the "get_error", "http_code", and "http_message" methods used in Net::Twitter 2.12 and prior versions. Instead of # DON'T! my $friends = $nt->friends(); if ( $friends ) { # process $friends } wrap the API call in an eval block: # DO! my $friends = eval { $nt->friends() }; if ( $friends ) { # process $friends } Here's a much more complex example taken from application code using Net::Twitter 2.12: # DON'T! my $friends = $nt->friends(); if ( $friends ) { # process $friends } else { my $error = $nt->get_error; if ( ref $error ) { if ( ref($error) eq 'HASH' && exists $error->{error} ) { $error = $error->{error}; } else { $error = 'Unexpected error type ' . ref($error); } } else { $error = $nt->http_code() . ": " . $nt->http_message; } warn "$error\n"; } The Net::Twitter::Lite equivalent is: # DO! eval { my $friends = $nt->friends(); # process $friends }; warn "$@\n" if $@; return; In Net::Twitter::Lite, an error can always be treated as a string. See Net::Twitter::Lite::Error. The HTTP Status Code and HTTP Message are both available. Rather than accessing them via the Net::Twitter::Lite instance, you access them via the Net::Twitter::Lite::Error instance thrown as an error. For example: # DO! eval { my $friends = $nt->friends(); # process $friends }; if ( my $error = $@ ) { if ( blessed $error && $error->isa("Net::Twitter::Lite::Error) && $error->code() == 502 ) { $error = "Fail Whale!"; } warn "$error\n"; } Unsupported Net::Twitter 2.12 options to "new"Net::Twitter::Lite does not support the following Net::Twitter 2.12 options to "new". It silently ignores them:
Unsupported Net::Twitter 2.12 methods
METHODS AND ARGUMENTS
BASIC AUTHENTICATION METHODS
OAUTH METHODS
API METHODS AND ARGUMENTSMost Twitter API methods take parameters. All Net::Twitter::Lite API methods will accept a HASH ref of named parameters as specified in the Twitter API documentation. For convenience, many Net::Twitter::Lite methods accept simple positional arguments as documented, below. The positional parameter passing style is optional; you can always use the named parameters in a hash ref if you prefer.For example, the REST API method "update" has one required parameter, "status". You can call "update" with a HASH ref argument: $nt->update({ status => 'Hello world!' }); Or, you can use the convenient form: $nt->update('Hello world!'); The "update" method also has an optional parameter, "in_reply_to_status_id". To use it, you must use the HASH ref form: $nt->update({ status => 'Hello world!', in_reply_to_status_id => $reply_to }); Convenience form is provided for the required parameters of all API methods. So, these two calls are equivalent: $nt->friendship_exists({ user_a => $fred, user_b => $barney }); $nt->friendship_exists($fred, $barney); Many API methods have aliases. You can use the API method name, or any of its aliases, as you prefer. For example, these calls are all equivalent: $nt->friendship_exists($fred, $barney); $nt->relationship_exists($fred, $barney); $nt->follows($fred, $barney); Aliases support both the HASH ref and convenient forms: $nt->follows({ user_a => $fred, user_b => $barney }); Methods that support the "page" parameter expect page numbers > 0. Twitter silently ignores invalid "page" values. So "{ page => 0 }" produces the same result as "{ page => 1 }". In addition to the arguments specified for each API method described below, an additional "authenticate" parameter can be passed. To request an "Authorization" header, pass "authenticated => 1"; to suppress an authentication header, pass "authentication => 0". Even if requested, an Authorization header will not be added if there are no user credentials (username and password for Basic Authentication; access tokens for OAuth). This is probably only useful for the "rate_limit_status" method in the REST API, since it returns different values for an authenticated and a non-authenticated call. REST API MethodsSeveral of these methods accept a user ID as the "id" parameter. The user ID can be either a screen name, or the users numeric ID. To disambiguate, use the "screen_name" or "user_id" parameters, instead.For example, These calls are equivalent: $nt->create_friend('perl_api'); # screen name $nt->create_friend(1564061); # numeric ID $nt->create_friend({ id => 'perl_api' }); $nt->create_friend({ screen_name => 'perl_api' }); $nt->create_friend({ user_id => 1564061 }); However user_id 911 and screen_name 911 are separate Twitter accounts. These calls are NOT equivalent: $nt->create_friend(911); # interpreted as screen name $nt->create_friend({ user_id => 911 }); # screen name: richellis Whenever the "id" parameter is required and "user_id" and "screen_name" are also parameters, using any one of them satisfies the requirement.
Returns the current trend, geo and sleep time information for the authenticating user. Returns: HashRef
Returns the current count of friends, followers, updates (statuses) and favorites of the authenticating user. Returns: HashRef
Add a member to a list. The authenticated user must own the list to be able to add members to it. Note that lists can't have more than 500 members. Returns: User
Creates a new place object at the given latitude and longitude. Before creating a place you need to query "similar_places" with the latitude, longitude and name of the place you wish to create. The query will return an array of places which are similar to the one you wish to create, and a token. If the place you wish to create isn't in the returned array you can use the token with this method to create a new one. Returns: Place
Returns all lists the authenticating or specified user subscribes to, including their own. The user is specified using the user_id or screen_name parameters. If no user is given, the authenticating user is used. Returns: ArrayRef[List]
Returns if the authenticating user is blocking a target user. Will return the blocked user's object if a block exists, and error with HTTP 404 response code otherwise. Returns: BasicUser
Returns an array of user objects that the authenticating user is blocking. Returns: ArrayRef[BasicUser]
Returns an array of numeric user ids the authenticating user is blocking. Returns: ArrayRef[Int]
Returns an array of users that the specified user can contribute to. Returns: ArrayRef[User]
Returns an array of users who can contribute to the specified account. Returns: ArrayRef[User]
Blocks the user specified in the ID parameter as the authenticating user. Returns the blocked user when successful. You can find out more about blocking in the Twitter Support Knowledge Base. Returns: BasicUser
Favorites the status specified in the ID parameter as the authenticating user. Returns the favorite status when successful. Returns: Status
Befriends the user specified in the ID parameter as the authenticating user. Returns the befriended user when successful. Returns a string describing the failure condition when unsuccessful. Returns: BasicUser
Creates a new list for the authenticated user. Note that you can't create more than 20 lists per account. Returns: List
Creates a saved search for the authenticated user. Returns: SavedSearch
Deletes the specified list. The authenticated user must own the list to be able to destroy it. Returns: List
Removes the specified member from the list. The authenticated user must be the list's owner to remove members from the list. Returns: User
Un-blocks the user specified in the ID parameter as the authenticating user. Returns the un-blocked user when successful. Returns: BasicUser
Destroys the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message. Returns: DirectMessage
Un-favorites the status specified in the ID parameter as the authenticating user. Returns the un-favorited status. Returns: Status
Discontinues friendship with the user specified in the ID parameter as the authenticating user. Returns the un-friended user when successful. Returns a string describing the failure condition when unsuccessful. Returns: BasicUser
Destroys a saved search. The search, specified by "id", must be owned by the authenticating user. Returns: SavedSearch
Destroys the status specified by the required ID parameter. The authenticating user must be the author of the specified status. Returns: Status
Returns a list of the 20 most recent direct messages sent to the authenticating user including detailed information about the sending and recipient users. Returns: ArrayRef[DirectMessage]
Disables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful. Returns: BasicUser
Enables notifications for updates from the specified user to the authenticating user. Returns the specified user when successful. Returns: BasicUser
Ends the session of the authenticating user, returning a null cookie. Use this method to sign users out of client-facing applications like widgets. Returns: Error
Returns the 20 most recent favorite statuses for the authenticating user or user specified by the ID parameter. Returns: ArrayRef[Status]
Returns a reference to an array of numeric IDs for every user following the specified user. The order of the IDs may change from call to call. To obtain the screen names, pass the arrayref to "lookup_users". Use the optional "cursor" parameter to retrieve IDs in pages of 5000. When the "cursor" parameter is used, the return value is a reference to a hash with keys "previous_cursor", "next_cursor", and "ids". The value of "ids" is a reference to an array of IDS of the user's followers. Set the optional "cursor" parameter to -1 to get the first page of IDs. Set it to the prior return's value of "previous_cursor" or "next_cursor" to page forward or backwards. When there are no prior pages, the value of "previous_cursor" will be 0. When there are no subsequent pages, the value of "next_cursor" will be 0. Returns: HashRef|ArrayRef[Int]
Returns a reference to an array of numeric IDs for every user followed by the specified user. The order of the IDs is reverse chronological. Use the optional "cursor" parameter to retrieve IDs in pages of 5000. When the "cursor" parameter is used, the return value is a reference to a hash with keys "previous_cursor", "next_cursor", and "ids". The value of "ids" is a reference to an array of IDS of the user's friends. Set the optional "cursor" parameter to -1 to get the first page of IDs. Set it to the prior return's value of "previous_cursor" or "next_cursor" to page forward or backwards. When there are no prior pages, the value of "previous_cursor" will be 0. When there are no subsequent pages, the value of "next_cursor" will be 0. Returns: HashRef|ArrayRef[Int]
Tests for the existence of friendship between two users. Will return true if user_a follows user_b, otherwise will return false. Use of "user_a" and "user_b" is deprecated. It has been preserved for backwards compatibility, and is used for the two-argument positional form: $nt->friendship_exists($user_a, $user_b); Instead, you should use one of the named argument forms: $nt->friendship_exists({ user_id_a => $id1, user_id_b => $id2 }); $nt->friendship_exists({ screen_name_a => $name1, screen_name_b => $name2 }); Consider using "show_friendship" instead. Returns: Bool
Returns an HASH ref with an array of numeric IDs in the "ids" element for every user who has a pending request to follow the authenticating user. Returns: HashRef
Returns an HASH ref with an array of numeric IDs in the "ids" element for every protected user for whom the authenticating user has a pending follow request. Returns: HashRef
Returns details of a place returned from the "reverse_geocode" method. Returns: HashRef
Search for places that can be attached to a statuses/update. Given a latitude and a longitude pair, an IP address, or a name, this request will return a list of all the valid places that can be used as the place_id when updating a status. Conceptually, a query can be made from the user's location, retrieve a list of places, have the user validate the location he or she is at, and then send the ID of this location with a call to statuses/update. This is the recommended method to use find places that can be attached to statuses/update. Unlike geo/reverse_geocode which provides raw data access, this endpoint can potentially re-order places with regards to the user who is authenticated. This approach is also preferred for interactive place matching with the user. Returns: HashRef
Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths. It is recommended applications request this endpoint when they are loaded, but no more than once a day. Returns: HashRef
Returns the list of languages supported by Twitter along with their ISO 639-1 code. The ISO 639-1 code is the two letter value to use if you include lang with any of your requests. Returns: ArrayRef[Lanugage]
Returns the specified list. Private lists will only be shown if the authenticated user owns the specified list. Returns: List
Returns the lists of the specified (or authenticated) user. Private lists will be included if the authenticated user is the same as the user whose lists are being returned. Returns: Hashref
Returns Twitter's privacy policy. Returns: HashRef
Returns the Twitter Terms of Service. These are not the same as the Developer Rules of the Road. Returns: HashRef
Returns the 20 most recent statuses, including retweets, posted by the authenticating user and that user's friends. This is the equivalent of /timeline/home on the Web. Returns: ArrayRef[Status]
Check if the specified user is a member of the specified list. Returns the user or undef. Returns: Maybe[User]
Check if the specified user is a subscriber of the specified list. Returns the user or undef. Returns: Maybe[User]
Returns the members of the specified list. Private list members will only be shown if the authenticated user owns the specified list. Returns: Hashref
Returns the lists the specified user has been added to. If user_id or screen_name are not provided the memberships for the authenticating user are returned. Returns: Hashref
Returns tweet timeline for members of the specified list. Historically, retweets were not available in list timeline responses but you can now use the include_rts=true parameter to additionally receive retweet objects. Returns: ArrayRef[Status]
Returns the subscribers of the specified list. Private list subscribers will only be shown if the authenticated user owns the specified list. Returns: Hashref
Returns the relationship of the authenticating user to the comma separated list or ARRAY ref of up to 100 screen_names or user_ids provided. Values for connections can be: following, following_requested, followed_by, none. Requires authentication. Returns: ArrayRef
Return up to 100 users worth of extended information, specified by either ID, screen name, or combination of the two. The author's most recent status (if the authenticating user has permission) will be returned inline. This method is rate limited to 1000 calls per hour. This method will accept user IDs or screen names as either a comma delimited string, or as an ARRAY ref. It will also accept arguments in the normal HASHREF form or as a simple list of named arguments. I.e., any of the following forms are acceptable: $nt->lookup_users({ user_id => '1234,6543,3333' }); $nt->lookup_users(user_id => '1234,6543,3333'); $nt->lookup_users({ user_id => [ 1234, 6543, 3333 ] }); $nt->lookup_users({ screen_name => 'fred,barney,wilma' }); $nt->lookup_users(screen_name => ['fred', 'barney', 'wilma']); $nt->lookup_users( screen_name => ['fred', 'barney' ], user_id => '4321,6789', ); Returns: ArrayRef[User]
Adds multiple members to a list, by specifying a reference to an array or a comma-separated list of member ids or screen names. The authenticated user must own the list to be able to add members to it. Note that lists can't have more than 500 members, and you are limited to adding up to 100 members to a list at a time with this method. Returns: List
Removes multiple members from a list, by specifying a reference to an array of member ids or screen names, or a string of comma separated user ids or screen names. The authenticated user must own the list to be able to remove members from it. Note that lists can't have more than 500 members, and you are limited to removing up to 100 members to a list at a time with this method. 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. Returns: List
Returns the 20 most recent mentions (statuses containing @username) for the authenticating user. Returns: ArrayRef[Status]
Sends a new direct message to the specified user from the authenticating user. Requires both the user and text parameters. Returns the sent message when successful. In order to support numeric screen names, the "screen_name" or "user_id" parameters may be used instead of "user". Returns: DirectMessage
Returns an ARRAY ref of user IDs for which the authenticating user does not want to receive retweets. Returns: ArrayRef[UserIDs]
Returns the 20 most recent statuses from non-protected users who have set a custom user icon. Does not require authentication. Note that the public timeline is cached for 60 seconds so requesting it more often than that is a waste of resources. If user credentials are provided, "public_timeline" calls are authenticated, so they count against the authenticated user's rate limit. Use "->public_timeline({ authenticate => 0 })" to make an unauthenticated call which will count against the calling IP address' rate limit, instead. Returns: ArrayRef[Status]
Returns the remaining number of API requests available to the authenticated user before the API limit is reached for the current hour. Use "->rate_limit_status({ authenticate => 0 })" to force an unauthenticated call, which will return the status for the IP address rather than the authenticated user. (Note: for a web application, this is the server's IP address.) Returns: RateLimitStatus
If available, returns an array of replies and mentions related to the specified status. There is no guarantee there will be any replies or mentions in the response. This method is only available to users who have access to #newtwitter. Requires authentication. Returns: ArrayRef[Status]
The user specified in the id is blocked by the authenticated user and reported as a spammer. Returns: User
Retweets a tweet. Requires the id parameter of the tweet you are retweeting. Returns the original tweet with retweet details embedded. Returns: Status
Returns up to 100 users who retweeted the status identified by "id". Returns: ArrayRef[User]
Returns the IDs of up to 100 users who retweeted the status identified by "id". Returns: ArrayRef[User]
Returns the 20 most recent retweets posted by the authenticating user. Returns: ArrayRef[Status]
Returns the 20 most recent retweets posted by the specified user. The user is specified using the user_id or screen_name parameters. This method is identical to "retweeted_by_me" except you can choose the user to view. Does not require authentication, unless the user is protected. Returns: ArrayRef
Returns the 20 most recent retweets posted by the authenticating user's friends. Returns: ArrayRef[Status]
Returns the 20 most recent retweets posted by users the specified user follows. The user is specified using the user_id or screen_name parameters. This method is identical to "retweeted_to_me" except you can choose the user to view. Does not require authentication, unless the user is protected. Returns: ArrayRef
Returns up to 100 of the first retweets of a given tweet. Returns: Arrayref[Status]
Returns the 20 most recent tweets of the authenticated user that have been retweeted by others. Returns: ArrayRef[Status]
Search for places (cities and neighborhoods) that can be attached to a statuses/update. Given a latitude and a longitude, return a list of all the valid places that can be used as a place_id when updating a status. Conceptually, a query can be made from the user's location, retrieve a list of places, have the user validate the location he or she is at, and then send the ID of this location up with a call to statuses/update. There are multiple granularities of places that can be returned -- "neighborhoods", "cities", etc. At this time, only United States data is available through this method.
Returns: HashRef
Returns the authenticated user's saved search queries. Returns: ArrayRef[SavedSearch]
Returns a list of the 20 most recent direct messages sent by the authenticating user including detailed information about the sending and recipient users. Returns: ArrayRef[DirectMessage]
Returns a single direct message, specified by an id parameter. Like the "direct_messages" request, this method will include the user objects of the sender and recipient. Requires authentication. Returns: HashRef
Returns detailed information about the relationship between two users. Returns: Relationship
Retrieve the data for a saved search, by "id", owned by the authenticating user. Returns: SavedSearch
Returns a single status, specified by the id parameter. The status's author will be returned inline. Returns: Status
Returns extended information of a given user, specified by ID or screen name as per the required id parameter. This information includes design settings, so third party developers can theme their widgets according to a given user's preferences. You must be properly authenticated to request the page of a protected user. Returns: ExtendedUser
Locates places near the given coordinates which are similar in name. Conceptually you would use this method to get a list of known places to choose from first. Then, if the desired place doesn't exist, make a request to "add_place" to create a new one. The token contained in the response is the token needed to be able to create a new place. Returns: HashRef
Subscribes the authenticated user to the specified list. Returns: List
Obtain a collection of the lists the specified user is subscribed to, 20 lists per page by default. Does not include the user's own lists. Returns: ArrayRef[List]
Returns the list of suggested user categories. The category slug can be used in the "user_suggestions" API method get the users in that category . Does not require authentication. Returns: ArrayRef
Returns the string "ok" status code. Returns: Str
Returns the locations with trending topic information. The response is an array of "locations" that encode the location's WOEID (a Yahoo! Where On Earth ID <http://developer.yahoo.com/geo/geoplanet/>) and some other human-readable information such as a the location's canonical name and country. When the optional "lat" and "long" parameters are passed, the available trend locations are sorted by distance from that location, nearest to farthest. Use the WOEID returned in the location object to query trends for a specific location. Returns: ArrayRef[Location]
Returns the current top ten trending topics on Twitter. The response includes the time of the request, the name of each trending topic, and query used on Twitter Search results page for that topic. Returns: HashRef
Returns the top 20 trending topics for each hour in a given day. Returns: HashRef
Returns the top 10 trending topics for a specific location. The response is an array of "trend" objects that encode the name of the trending topic, the query parameter that can be used to search for the topic on Search, and the direct URL that can be issued against Search. This information is cached for five minutes, and therefore users are discouraged from querying these endpoints faster than once every five minutes. Global trends information is also available from this API by using a WOEID of 1. Returns: ArrayRef[Trend]
Returns the top 30 trending topics for each day in a given week. Returns: HashRef
Unsubscribes the authenticated user from the specified list. Returns: List
Updates the authenticating user's status. Requires the status parameter specified. A status update with text identical to the authenticating user's current status will be ignored.
Returns: Status
Sets which device Twitter delivers updates to for the authenticating user. Sending none as the device parameter will disable IM or SMS updates. Returns: BasicUser
Allows you enable or disable retweets and device notifications from the specified user. All other values are assumed to be false. Requires authentication. Returns: HashRef
Updates the specified list. The authenticated user must own the list to be able to update it. Returns: List
Sets values that users are able to set under the "Account" tab of their settings page. Only the parameters specified will be updated; to only update the "name" attribute, for example, only include that parameter in your request. Returns: ExtendedUser
Updates the authenticating user's profile background image. The "image" parameter must be an arrayref with the same interpretation as the "image" parameter in the "update_profile_image" method. The "use" parameter allows you to specify whether to use the uploaded profile background or not. See that method's documentation for details. Returns: ExtendedUser
Sets one or more hex values that control the color scheme of the authenticating user's profile page on twitter.com. These values are also returned in the /users/show API method. Returns: ExtendedUser
Updates the authenticating user's profile image. The "image" parameter is an arrayref with the following interpretation: [ $file ] [ $file, $filename ] [ $file, $filename, Content_Type => $mime_type ] [ undef, $filename, Content_Type => $mime_type, Content => $raw_image_data ] The first value of the array ($file) is the name of a file to open. The second value ($filename) is the name given to Twitter for the file. If $filename is not provided, the basename portion of $file is used. If $mime_type is not provided, it will be provided automatically using LWP::MediaTypes::guess_media_type(). $raw_image_data can be provided, rather than opening a file, by passing "undef" as the first array value. Returns: ExtendedUser
Updates the authenticating user's status and attaches media for upload. The "media[]" parameter is an arrayref with the following interpretation: [ $file ] [ $file, $filename ] [ $file, $filename, Content_Type => $mime_type ] [ undef, $filename, Content_Type => $mime_type, Content => $raw_image_data ] The first value of the array ($file) is the name of a file to open. The second value ($filename) is the name given to Twitter for the file. If $filename is not provided, the basename portion of $file is used. If $mime_type is not provided, it will be provided automatically using LWP::MediaTypes::guess_media_type(). $raw_image_data can be provided, rather than opening a file, by passing "undef" as the first array value. The Tweet text will be rewritten to include the media URL(s), which will reduce the number of characters allowed in the Tweet text. If the URL(s) cannot be appended without text truncation, the tweet will be rejected and this method will return an HTTP 403 error. Returns: Status
Access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user. Currently supported values for optional parameter "lang" are "en", "fr", "de", "es", "it". Does not require authentication. Returns: ArrayRef
Returns the 20 most recent statuses posted from the authenticating user. It's also possible to request another user's timeline via the id parameter. This is the equivalent of the Web /archive page for your own user, or the profile page for a third party. Returns: ArrayRef[Status]
Run a search for users similar to Find People button on Twitter.com; the same results returned by people search on Twitter.com will be returned by using this API (about being listed in the People Search). It is only possible to retrieve the first 1000 matches from this API. Returns: ArrayRef[Users]
Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not. Use this method to test if supplied user credentials are valid. Returns: ExtendedUser Search API Methods
Returns a HASH reference with some meta-data about the query including the "next_page", "refresh_url", and "max_id". The statuses are returned in "results". To iterate over the results, use something similar to: my $r = $nt->search($searh_term); for my $status ( @{$r->{results}} ) { print "$status->{text}\n"; } Returns: HashRef ERROR HANDLINGWhen "Net::Twitter::Lite" encounters a Twitter API error or a network error, it throws a "Net::Twitter::Lite::Error" object. You can catch and process these exceptions by using "eval" blocks and testing $@:eval { my $statuses = $nt->friends_timeline(); # this might die! for my $status ( @$statuses ) { #... } }; if ( $@ ) { # friends_timeline encountered an error if ( blessed $@ && $@->isa('Net::Twitter::Lite::Error' ) { #... use the thrown error obj warn $@->error; } else { # something bad happened! die $@; } } "Net::Twitter::Lite::Error" stringifies to something reasonable, so if you don't need detailed error information, you can simply treat $@ as a string: eval { $nt->update($status) }; if ( $@ ) { warn "update failed because: $@\n"; } AUTHENTICATIONNet::Twitter::Lite currently supports both Basic Authentication and OAuth. The choice of authentication strategies is determined by the options passed to "new" or the use of the "credentials" method. An error will be thrown if options for both strategies are provided.BASIC AUTHENTICATIONTo use Basic Authentication, pass the "username" and "password" options to "new", or call "credentials" to set them. When Basic Authentication is used, the "Authorization" header is set on each authenticated API call.OAUTH AUTHENTICATIONTo use OAuth authentication, pass the "consumer_key" and "consumer_secret" options to new.Net::OAuth::Simple must be installed in order to use OAuth and an error will be thrown if OAuth is attempted without it. Net::Twitter::Lite does not require Net::OAuth::Simple, making OAuth an optional feature. OAUTH EXAMPLESSee the "examples" directory included in this distribution for full working examples using OAuth.Here's how to authorize users as a desktop app mode: use Net::Twitter::Lite; my $nt = Net::Twitter::Lite->new( consumer_key => "YOUR-CONSUMER-KEY", consumer_secret => "YOUR-CONSUMER-SECRET", ); # You'll save the token and secret in cookie, config file or session database my($access_token, $access_token_secret) = restore_tokens(); if ($access_token && $access_token_secret) { $nt->access_token($access_token); $nt->access_token_secret($access_token_secret); } unless ( $nt->authorized ) { # The client is not yet authorized: Do it now print "Authorize this app at ", $nt->get_authorization_url, " and enter the PIN#\n"; my $pin = <STDIN>; # wait for input chomp $pin; my($access_token, $access_token_secret, $user_id, $screen_name) = $nt->request_access_token(verifier => $pin); save_tokens($access_token, $access_token_secret); # if necessary } # Everything's ready In a web application mode, you need to save the oauth_token and oauth_token_secret somewhere when you redirect the user to the OAuth authorization URL. sub twitter_authorize : Local { my($self, $c) = @_; my $nt = Net::Twitter::Lite->new(%param); my $url = $nt->get_authorization_url(callback => $callbackurl); $c->response->cookies->{oauth} = { value => { token => $nt->request_token, token_secret => $nt->request_token_secret, }, }; $c->response->redirect($url); } And when the user returns back, you'll reset those request token and secret to upgrade the request token to access token. sub twitter_auth_callback : Local { my($self, $c) = @_; my %cookie = $c->request->cookies->{oauth}->value; my $nt = Net::Twitter::Lite->new(%param); $nt->request_token($cookie{token}); $nt->request_token_secret($cookie{token_secret}); my $verifier = $c->req->param->{oauth_verifier}; my($access_token, $access_token_secret, $user_id, $screen_name) = $nt->request_access_token(verifier => $verifier); # Save $access_token and $access_token_secret in the database associated with $c->user } Later on, you can retrieve and reset those access token and secret before calling any Twitter API methods. sub make_tweet : Local { my($self, $c) = @_; my($access_token, $access_token_secret) = ...; my $nt = Net::Twitter::Lite->new(%param); $nt->access_token($access_token); $nt->access_token_secret($access_token_secret); # Now you can call any Net::Twitter::Lite API methods on $nt my $status = $c->req->param('status'); my $res = $nt->update({ status => $status }); } SEE ALSO
SUPPORTPlease report bugs to "bug-net-twitter@rt.cpan.org", or through the web interface at <https://rt.cpan.org/Dist/Display.html?Queue=Net-Twitter>.Join the Net::Twitter IRC channel at <irc://irc.perl.org/net-twitter>. Follow perl_api: <http://twitter.com/perl_api>. Track Net::Twitter::Lite development at <http://github.com/semifor/net-twitter-lite>. AUTHORMarc Mims <marc@questright.com>CONTRIBUTORSChris Page <chris@starforge.co.uk>LICENSECopyright (c) 2013 Marc MimsThis library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Visit the GSP FreeBSD Man Page Interface. |