Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Net::Twitter::Role::InUsereContributed PeNet::Twitter::Role::InflateObjects(3)

NAME
       Net::Twitter::Role::InflateObjects - Inflate Twitter API	return values
       to Moose	objects

VERSION
       version 4.01043

SYNOPSIS
	 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"

DESCRIPTION
       This role provides inflation of HASH refs, returned by the Twitter API,
       into Moose objects.  URLs are inflated to URI objects.  Dates are
       inflated	to DateTime objects.  Objects that have	a "created_at"
       attribute also have a "relative_created_at" method that prints times in
       the same	style as the Twitter web interface.

       All HASH	members	have read accessors, so

	 $r->[0]->{user}{screen_name}

       Can be accessed as

	 $r->[0]->user->screen_name

CAVEATS
       An accessor is created for each HASH 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 HASH element.  So,	code that relies on HASH element will
       fail loudly if Twitter drops support for	it.  (This may be a feature!)

AUTHOR
       Marc Mims <marc@questright.com>

LICENSE
       Copyright (c) 2016 Marc Mims

       The Twitter API itself, and the description text	used in	this module
       is:

       Copyright (c) 2009 Twitter

       This library is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself.

perl v5.32.0			  2018-01Net::Twitter::Role::InflateObjects(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | CAVEATS | AUTHOR | LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Net::Twitter::Role::InflateObjects&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help