Aaron Straup Cope > Net-Delicious-1.13 > Net::Delicious

Download:
Net-Delicious-1.13.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Module Version: 1.13   Source   Latest Release: Net-Delicious-1.14

NAME ^

Net::Delicious - OOP for the del.icio.us API

SYNOPSIS ^

  use Net::Delicious;
  use Log::Dispatch::Screen;

  my $del = Net::Delicious->new({user => "foo",
                                 pswd => "bar"});

  foreach my $p ($del->recent_posts()) {
      print $p->description()."\n";
  } 

DESCRIPTION ^

OOP for the del.icio.us API

PACKAGE METHODS ^

__PACKAGE__->new(\%args || Config::Simple)

Arguments to the Net::Delicious object may be defined in one of three ways :

The first option isn't going away any time soon but should be considered as deprecated. Valid hash reference arguments are :

Config::Simple options are expected to be grouped in a "block" labeled delicious. Valid options are :

Returns a Net::Delicious object or undef if there was a problem creating the object.

It is also possible to set additional config options to tweak the default settings for API call parameters and API response properties. Please consult the POD for Net::Delicious::Config for details.

UPDATE METHODS ^

$obj->update()

Returns return the time of the last update formatted as a W3CDTF string.

POST METHODS ^

$obj->add_post(\%args)

Makes a post to del.icio.us.

Valid arguments are :

Returns true or false.

$obj->delete_post(\%args)

Delete a post from del.icio.us.

Valid arguments are :

Returns true or false.

$obj->posts_per_date(\%args)

Get a list of dates with the number of posts at each date.

Valid arguments are :

Returns a list of Net::Delicious::Date objects when called in an array context.

Returns a Net::Delicious::Iterator object when called in a scalar context.

$obj->recent_posts(\%args)

Get a list of most recent posts, possibly filtered by tag.

Valid arguments are :

Returns a list of Net::Delicious::Post objects when called in an array context.

Returns a Net::Delicious::Iterator object when called in a scalar context.

$obj->all_posts()

Returns a list of Net::Delicious::Post objects when called in an array context.

Returns a Net::Delicious::Iterator object when called in a scalar context.

If no posts have been added between calls to this method, it will return an empty list (or undef if called in a scalar context.)

$obj->posts(\%args)

Get a list of posts on a given date, filtered by tag. If no date is supplied, most recent date will be used.

Valid arguments are :

Returns a list of Net::Delicious::Post objects when called in an array context.

Returns a Net::Delicious::Iterator object when called in a scalar context.

TAG METHODS ^

$obj->tags()

Returns a list of tags.

$obj->rename_tag(\%args)

Renames tags across all posts.

Valid arguments are :

Returns true or false.

$obj->all_posts_for_tag(\%args)

This is a just a helper method which hides a bunch of API calls behind a single method.

Valid arguments are :

Returns a list of Net::Delicious::Post objects when called in an array context.

Returns a Net::Delicious::Iterator object when called in a scalar context.

BUNDLE METHODS ^

$obj->bundles()

Returns a list of Net::Delicious::Bundle objects when called in an array context.

Returns a Net::Delicious::Iterator object when called in a scalar context.

$obj->set_bundle(\%args)

Valid arguments are :

Returns true or false

$obj->delete_bundle(\%args)

Valid arguments are :

Returns true or false

HELPER METHODS ^

$obj->logger()

Returns a Log::Dispatch object.

$obj->config(@args)

This is just a short-cut for calling the current object's internal Config::Simple param method. You may use to it to get and set config parameters although they will not be saved to disk when the object is destroyed.

$obj->username()

Returns the del.icio.us username for the current object.

$obj->password()

Returns the del.icio.us password for the current object.

$object->user_agent()

This returns the objects internal LWP::UserAgent in case you need to tweak timeouts, proxies, etc.

By default the UA object enables the proxy_env glue.

ERRORS ^

Errors are logged via the object's logger method which returns a Log::Dispatch object. If you want to get at the errors it is up to you to provide it with a dispatcher.

VERSION ^

1.13

DATE ^

$Date: 2008/03/03 16:55:04 $

AUTHOR ^

Aaron Straup Cope <ascope@cpan.org>

SEE ALSO ^

http://del.icio.us/doc/api

NOTES ^

This package implements the API in its entirety as of DATE.

LICENSE ^

Copyright (c) 2004-2008, Aaron Straup Cope. All Rights Reserved.

This is free software, you may use it and distribute it under the same terms as Perl itself.

syntax highlighting: