Bruno Tavares > Pikeo-API-1.01 > Pikeo::API::User::Logged

Download:
Pikeo-API-1.01.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

Pikeo::API::User::Logged - Abstraction the logged in pikeo user

DESCRIPTION ^

This modules provides an interface to the logged in user in pikeo.

This module inherits from Pikeo::API::User so all the methods of Pikeo::API::User are also available.

SYNOPSIS ^

    use Pikeo::API;
    use Pikeo::API::User::Logged;

    # create an API object to maintain you session
    # trough out the diferent calls
    my $api = Pikeo::API->new({api_secret=>'asd', api_key=>'asdas'});
    $api->login({ username => 'a', password => 'b' });
    
    # Get the logged in user 
    my $user1 = Pikeo::API::User::Logged->new({ api => $api });

    #get the public photos
    my $photos = $user->getPublicPhotos();

FUNCTIONS ^

CONSTRUCTORS

new( \%args )

Returns a Pikeo::API::User object.

Required args are:

INSTANCE METHODS

uploadPhoto(\%args)

Upload one photo to the photo repository

Returns the Pikeo::API::Photo object representing the uploaded photo

Required args:

Optional args:

getMyCommentedPhotos()

Return all the photos that the user owns that are commented.

Return a list of Pikeo::API::Photo

getPicturesCommentedByMe()

Returns all the photos that were commented by the user.

Return a list of Pikeo::API::Photo

getContactsList()

The function will get the contacts of the logged user.

Returns a list of Pikeo::API::Contact objects.

syntax highlighting: