View on
MetaCPAN
Marc Mims > Net-Twitter > Net::Twitter::Role::WrapResult

Download:
Net-Twitter-4.01042.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 4.01042   Source  

NAME ^

Net::Twitter::Role::WrapResult - Wrap Twitter API response and HTTP Response

VERSION ^

version 4.01042

SYNOPSIS ^

    use Net::Twitter;

    my $nt = Net::Twitter->new(
        traits => [ qw/API::RESTv1_1 WrapResult/ ],
        %other_new_options,
    );

    my $r = $nt->verify_credentials;

    my $http_response        = $r->http_response;
    my $twitter_result       = $r->result;
    my $rate_limit_remaining = $r->rate_limit_remaining;

DESCRIPTION ^

Normally, Net::Twitter API methods return the decoded JSON body from the HTTP response. Some useful information, notably rate limit information, is included in HTTP response headers. With this role applied, API methods will return a Net::Twitter::WrappedResult object that includes both the HTTP response and the decoded JSON response body. See Net::Twitter::WrappedResult for details.

AUTHOR ^

Marc Mims <marc@questright.com>

COPYRIGHT ^

Copyright (c) 2016 Marc Mims

LICENSE ^

This library is free software and may be distributed under the same terms as perl itself.

syntax highlighting: