Create a WebService::GData::Feed instance.

Accept a json feed entry that has been perlified (from_json($json_string)) and an optional request object (WebService::GData::Base). The request object is passed along each entry classes but the Feed class itself does not use it.

Parameters

"json_feed:Object" - a json feed perlified

"request:Object" - a request object WebService::GData::Base

Returns

"WebService::GData::Feed"

set/get the title of the feed.

Parameters

"none" - as a getter

"title:Scalar" as a setter

Returns

"none" - as a setter

"title:Scalar" as a getter

Example:

    use WebService::GData::Feed;
    
    my $feed = new WebService::GData::Feed();
    
    $feed->title("my Title");
    
    $feed->title();#my Title

Get the id of the feed.

Parameters

"none" - getter

Returns

"id:Scalar"

Example:

    use WebService::GData::Feed;
    
    my $feed = new WebService::GData::Feed($jsonfeed);
    
    $feed->id();#"tag:youtube.com,2008:video"

Get the updated date of the feed.

Parameters

"none" - getter

Returns

"updated:Scalar"

Example:

    use WebService::GData::Feed;
    
    my $feed = new WebService::GData::Feed($jsonfeed);
    
    $feed->updated();#"2010-09-20T13:49:20.028Z"

Get the categories of the feed. At the feed level, it is almost always one category that defines the kind of the feed (video feed, related feed,etc). The "entry()" uses this information to load the proper class, ie Video or Comment entries.

Parameters

"none" - getter

Returns

"categories:Collection" - WebService::GData::Collection containing WebService::GData::Node::Category.

Example:

    use WebService::GData::Feed;
    
    my $feed = new WebService::GData::Feed($jsonfeed);
    
    my $categories = $feed->category();
    foreach my $category (@$categories) {
        #$category->scheme,$category->term,$category->label
    }
    
    #search for a particular kind of category
    my $kind = $categories->scheme('kind')->[0];
    
    #json feed category is as below:
    "category": [
      {
       "scheme": "http://schemas.google.com/g/2005#kind",
       "term": "http://gdata.youtube.com/schemas/2007#video"
      }
    ]

Get the etag of the feed. The etag is a unique identifier key to track updates to the document.

Parameters

"none" - getter

Returns

"etag:Scalar" - the etag value

Example:

    use WebService::GData::Feed;
    
    my $feed = new WebService::GData::Feed($jsonfeed);
    
   $feed->etag();#W/\"CkICQX45cCp7ImA9Wx5XGUQ.\"

See also <http://code.google.com/intl/en/apis/gdata/docs/2.0/reference.html#ResourceVersioning> for further information about resource versioning.

Get the author of the feed.

Parameters

"none" - getter

Returns

"author:Collection" - WebService::GData::Collection containing WebService::GData::Node::AuthorEntity.

Example:

    use WebService::GData::Feed;
    
    my $feed = new WebService::GData::Feed($jsonfeed);
    
   my $authors=  $feed->author();
   
   foreach my $author (@$authors){
       #$author->name,$author->uri
   }
   
   #raw json feed:
   
   "author": [
     {
       "name": {
        "$t": "YouTube"
       },
       "uri": {
        "$t": "http://www.youtube.com/"
       }
      }
    ],

Get the total result of the feed.

Parameters

"none" - getter

Returns

"total_items:Int" - the total number of items

Example:

    use WebService::GData::Feed;
    
    my $feed = new WebService::GData::Feed($jsonfeed);
    
    $feed->total_items();#1000000

Get the total result of the feed. Alias for total_items

Parameters

"none" - getter

Returns

"total_results:Int" - the total number of items

Example:

    use WebService::GData::Feed;
    
    my $feed = new WebService::GData::Feed($jsonfeed);
    
    $feed->total_results();#1000000

Get the start number of the feed.

Parameters

"none" - getter

Returns

"start_index:Int" - the start index of the feed counting from 1.

Example:

    use WebService::GData::Feed;
    
    my $feed = new WebService::GData::Feed($jsonfeed);
    
    $feed->start_index();#1

Get the the number of items sent per result.

Parameters

"none" - getter

Returns

"items_per_page:Int" - the number of item in the result.

Example:

    use WebService::GData::Feed;
    
    my $feed = new WebService::GData::Feed($jsonfeed);
    
    $feed->items_per_page();#25

Get the links of the feed in a array reference.

Parameters

"none" - getter

Returns

"links:Collection" - WebService::GData::Collection containing WebService::GData::Node::Link instances. =back

Example:

    use WebService::GData::Feed;
    
    my $feed = new WebService::GData::Feed($jsonfeed);
    
    my $links = $feed->links();
    foreach my $link (@$links){
        #link->rel,$link->type,$link->href
    }
    
    #raw json data:
    
      "link": [
       {
        "rel": "alternate",
        "type": "text/html",
        "href": "http://www.youtube.com"
       },
       {
        "rel": "http://schemas.google.com/g/2005#feed",
        "type": "application/atom+xml",
        "href": "http://gdata.youtube.com/feeds/api/videos"
       },
       {
        "rel": "http://schemas.google.com/g/2005#batch",
        "type": "application/atom+xml",
        "href": "http://gdata.youtube.com/feeds/api/videos/batch"
       }
      ]
    

Get a specific link entry by looking in the rel attribute of the link tag.

Parameters

"link_type:Scalar" - set the type of link you are looking for.

Returns

"undef" - if the link is not found.

"url:Scalar" - the contents in href if the link is found.

Example:

    use WebService::GData::Feed;
    
    my $feed = new WebService::GData::Feed($jsonfeed);

    my $previous_url= $feed->get_link('previous');
    
    my $batch_url   = $feed->get_link('batch');

Get a the previous link if set or undef. Shortcut for $feed->get_link('previous');

Get a the next link if set or undef. Shortcut for $feed->get_link('next');

This method return an array reference of Feed::* objects.

It works as a factory by instantiating the proper Feed::* class.

For example,if you read a video feed from a youtube service, it will instantiate the WebService::GData::Youtube::Feed::Video class and feed it the result.

It will look first at the category scheme set in the feed or at the entry category scheme that contains the base schema name of the feed.

If it does not guess properly,you can always specify the name of the package to load as its first argument.

Parameters

"class_name::Scalar"* - (optional) Force a specific class to be loaded and do not let entry guess the feed type on its own.

Returns

"entries:ArrayRef" - By default it uses WebService::GData::Entry::Feed but will return instances of the found package or of the specified one

Example:

    use WebService::GData::Feed;
    
    my $feed = new WebService::GData::Feed($jsonfeed);
    
    my $entries = $feed->entry('WebService::GData::Feed::Entry');#force a particular class to be used
    my $entries = $feed->entry();#let entry figure it out by looking at the feed meta information.
    
    foreach my $entry (@$entries) {
        
        #$entry->title,$entry->id... all entry sub classes should inherit from WebService::GData::Feed::Entry
    }