API::Facebook - Facebook.com API Client
version 0.04
use API::Facebook; my $facebook = API::Facebook->new( access_token => 'ACCESS_TOKEN', identifier => 'IDENTIFIER', ); $facebook->debug(1); $facebook->fatal(1); my $feed = $facebook->me('feed'); my $results = $feed->fetch; # after some introspection $feed->update( ... );
This distribution provides an object-oriented thin-client library for interacting with the Facebook (http://facebook.com) API. For usage and documentation information visit https://developers.facebook.com/docs/graph-api. API::Facebook is derived from API::Client and inherits all of it's functionality. Please read the documentation for API::Client for more usage information.
$facebook->access_token; $facebook->access_token('ACCESS_TOKEN');
The access_token attribute should be set to an API access token associated with your account.
$facebook->identifier; $facebook->identifier('IDENTIFIER');
The identifier attribute should be set to a string that identifies your app.
$facebook->debug; $facebook->debug(1);
The debug attribute if true prints HTTP requests and responses to standard out.
$facebook->fatal; $facebook->fatal(1);
The fatal attribute if true promotes 4xx and 5xx server response codes to exceptions, a API::Client::Exception object.
$facebook->retries; $facebook->retries(10);
The retries attribute determines how many times an HTTP request should be retried if a 4xx or 5xx response is received. This attribute defaults to 1.
$facebook->timeout; $facebook->timeout(5);
The timeout attribute determines how long an HTTP connection should be kept alive. This attribute defaults to 10.
$facebook->url; $facebook->url(Mojo::URL->new('https://graph.facebook.com'));
The url attribute set the base/pre-configured URL object that will be used in all HTTP requests. This attribute expects a Mojo::URL object.
$facebook->user_agent; $facebook->user_agent(Mojo::UserAgent->new);
The user_agent attribute set the pre-configured UserAgent object that will be used in all HTTP requests. This attribute expects a Mojo::UserAgent object.
my $result = $facebook->action($verb, %args); # e.g. $facebook->action('head', %args); # HEAD request $facebook->action('options', %args); # OPTIONS request $facebook->action('patch', %args); # PATCH request
The action method issues a request to the API resource represented by the object. The first parameter will be used as the HTTP request method. The arguments, expected to be a list of key/value pairs, will be included in the request if the key is either data or query.
data
query
my $results = $facebook->create(%args); # or $facebook->POST(%args);
The create method issues a POST request to the API resource represented by the object. The arguments, expected to be a list of key/value pairs, will be included in the request if the key is either data or query.
POST
my $results = $facebook->delete(%args); # or $facebook->DELETE(%args);
The delete method issues a DELETE request to the API resource represented by the object. The arguments, expected to be a list of key/value pairs, will be included in the request if the key is either data or query.
DELETE
my $results = $facebook->fetch(%args); # or $facebook->GET(%args);
The fetch method issues a GET request to the API resource represented by the object. The arguments, expected to be a list of key/value pairs, will be included in the request if the key is either data or query.
GET
my $results = $facebook->update(%args); # or $facebook->PUT(%args);
The update method issues a PUT request to the API resource represented by the object. The arguments, expected to be a list of key/value pairs, will be included in the request if the key is either data or query.
PUT
$facebook->resource(param('achievement'));
The achievement resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/achievement.
$facebook->resource(param('achievement_type'));
The achievement_type resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/achievement_type.
$facebook->resource(param('ad-campaign'));
The ad_campaign resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/marketing-api/reference/ad-campaign.
$facebook->resource(param('ad-campaign-group'));
The ad_campaign_group resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/marketing-api/reference/ad-campaign-group.
$facebook->resource(param('ad-image'));
The ad_image resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/marketing-api/reference/ad-image.
$facebook->resource(param('ad-label'));
The ad_label resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/marketing-api/reference/ad-label.
$facebook->resource(param('app-request'));
The app_request resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/app-request.
$facebook->resource(param('application'));
The application resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/application.
$facebook->resource(param('application-context'));
The application_context resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/application-context.
$facebook->resource(param('friend-list'));
The friend_list resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/friend-list.
$facebook->resource(param('hashtag'));
The hashtag resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/hashtag.
$facebook->resource(param('life-event'));
The life_event resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/life-event.
$facebook->resource(param('mailing-address'));
The mailing_address resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/mailing-address.
$facebook->resource(param('offsite-pixel'));
The offsite_pixel resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/offsite-pixel.
$facebook->resource(param('open-graph-context'));
The open_graph_context resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/open-graph-context.
$facebook->resource(param('page'));
The page resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/page.
$facebook->resource(param('photo'));
The photo resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/photo.
$facebook->resource(param('place-tag'));
The place_tag resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/place-tag.
$facebook->resource(param('product-catalog'));
The product_catalog resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/marketing-api/reference/product-catalog.
$facebook->resource(param('product-feed'));
The product_feed resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/product-feed.
$facebook->resource(param('product-feed-upload'));
The product_feed_upload resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/product-feed-upload.
$facebook->resource(param('product-feed-upload-error'));
The product_feed_upload_error resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/product-feed-upload-error.
$facebook->resource(param('product-group'));
The product_group resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/product-group.
$facebook->resource(param('product-item'));
The product_item resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/product-item.
$facebook->resource(param('product-set'));
The product_set resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/product-set.
$facebook->resource(param('promotion-info'));
The promotion_info resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/promotion-info.
$facebook->resource(param('user'));
The user resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/user.
$facebook->resource(param('user-context'));
The user_context resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/user-context.
$facebook->resource(param('video'));
The video resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/video.
$facebook->resource(param('video-broadcast'));
The video_broadcast resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/video-broadcast.
$facebook->resource(param('video-list'));
The video_list resource returns a new instance representative of the API resource requested. This method accepts a list of path segments which will be used in the HTTP request. The following documentation can be used to find more information. https://developers.facebook.com/docs/graph-api/reference/video-list.
Al Newkirk <anewkirk@ana.io>
This software is copyright (c) 2014 by Al Newkirk.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install API::Facebook, copy and paste the appropriate command in to your terminal.
cpanm
cpanm API::Facebook
CPAN shell
perl -MCPAN -e shell install API::Facebook
For more information on module installation, please visit the detailed CPAN module installation guide.