Net::Twitter::Lite::WrapResult - Wrap the HTTP response and Twitter result
version 0.12006
use Net::Twitter::Lite::WithAPIv1_1; my $nt = Net::Twitter::Lite::WithAPIv1_1->new( consumer_key => $consumer_key, consumer_secret => $consumer_secret, access_token => $access_token, access_token_secret => $access_token_secret, wrap_result => 1, ); my $r = $nt->verify_credentials; my $http_response = $r->http_response; my $twitter_result = $r->result; my $rate_limit_remaining = $r->rate_limit_remaining;
Often, the result of a Twitter API call, inflated from the JSON body of the HTTP response does not contain all the information you need. Twitter includes meta data, such as rate limiting information, in HTTP response headers. This object wraps both the inflated Twitter result and the HTTP response giving the caller full access to all the meta data. It also provides accessors for the rate limit information.
Constructs an object wrapping the Twitter result and HTTP response.
Returns the inflated Twitter API result.
Returns the HTTP::Response object for the API call.
Returns the rate limit, per 15 minute window, for the API endpoint called. Returns undef if no suitable rate limit header is available.
Returns the calls remaining in the current 15 minute window for the API endpoint called. Returns undef if no suitable header is available.
Returns the unix epoch time time of the next 15 minute window, i.e., when the rate limit will be reset, for the API endpoint called. Returns undef if no suitable header is available.
Marc Mims <marc@questright.com>
Copyright (c) 2014 Marc Mims <marc@questright.com>
This program is free software; you can redistribute it and/or modify it under the same terms as perl itself.
To install Net::Twitter::Lite, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::Twitter::Lite
CPAN shell
perl -MCPAN -e shell install Net::Twitter::Lite
For more information on module installation, please visit the detailed CPAN module installation guide.