.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Net::Twitter::Role::InflateObjects 3pm"
.TH Net::Twitter::Role::InflateObjects 3pm "2018-01-18" "perl v5.26.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::Twitter::Role::InflateObjects \- Inflate Twitter API return values to Moose objects
.SH "VERSION"
.IX Header "VERSION"
version 4.01043
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use Net::Twitter;
\&  my $nt = Net::Twitter\->new(traits => [qw/InflateObjects API::Rest/]);
\&
\&  $nt\->credentials($username, $password);
\&
\&  $r = $nt\->friends_timeline;
\&
\&  $r\->[0]\->user\->name; # return values are objects with read accessors
\&  $r\->[0]\->created_at; # dates are inflated to DateTime objects
\&  $r\->[0]\->relative_created_at; # "6 minutes ago"
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This role provides inflation of \s-1HASH\s0 refs, returned by the Twitter \s-1API,\s0 into
Moose objects.  URLs are inflated to \s-1URI\s0 objects.  Dates are inflated to
DateTime objects.  Objects that have a \f(CW\*(C`created_at\*(C'\fR attribute also have a
\&\f(CW\*(C`relative_created_at\*(C'\fR method that prints times in the same style as the
Twitter web interface.
.PP
All \s-1HASH\s0 members have read accessors, so
.PP
.Vb 1
\&  $r\->[0]\->{user}{screen_name}
.Ve
.PP
Can be accessed as
.PP
.Vb 1
\&  $r\->[0]\->user\->screen_name
.Ve
.SH "CAVEATS"
.IX Header "CAVEATS"
An accessor is created for each \s-1HASH\s0 key returned by Twitter.  As Twitter adds
new attributes, InflateObjects will create accessors for them.  However,
    InflateObjects will also drop accessors if Twitter drops the corresponding
\&\s-1HASH\s0 element.  So, code that relies on \s-1HASH\s0 element will fail loudly if Twitter
drops support for it.  (This may be a feature!)
.SH "AUTHOR"
.IX Header "AUTHOR"
Marc Mims <marc@questright.com>
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (c) 2016 Marc Mims
.PP
The Twitter \s-1API\s0 itself, and the description text used in this module is:
.PP
Copyright (c) 2009 Twitter
.PP
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.