View on
MetaCPAN
Bruno Tavares > Pikeo-API-1.01 > Pikeo::API::Album

Download:
Pikeo-API-1.01.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

Pikeo::API::Album - Abstraction of a pikeo photo album

SYNOPSIS ^

    use Pikeo::API;
    use Pikeo::API::User;
    use Pikeo::API::Album;

    # create an API object to maintain you session
    # trough out the diferent calls
    my $api = Pikeo::API->new({api_secret=>'asd', api_key=>'asdas'});
    
    # Get a user by id...
    my $user = Pikeo::API::User->new({ api => $api, id=>1 });
    # get the albums for this user
    my $albums = $user->getAlbumsList;
    # get one album photos
    my $album = $albums->[0];
    my $photos = $album->getPhotos();

    # .. or get a album by id 
    my $other_album = Pikeo::API::Album->new({ api => $api, id=>999 });

CONSTRUCTORS

new( \%args )

Returns a Pikeo::API::User object.

Required args are:

INSTANCE METHODS

owner()

Pikeo::API::User that owns the album

id()

Returns the album id

getPhotos()

Return a list of Pikeo::API::Photo with all the photos in the album

syntax highlighting: