Bruno Tavares

NAME

Pikeo::API::Photos

SYNOPSIS

    use Pikeo::API;
    use Pikeo::API::Photos;

    # create an API object to maintain you session
    # trough out the diferent calls
    my $api = Pikeo::API->new({secret=>'asd', key=>'asdas'});
    
    # Create the Photos facade
    my $photos = Pikeo::API::Photos->new({ api => $api });

    # Search for photos
    $photos_searched = $photos->search({ text=>'shozu', num_items=>5 });

DESCRIPTION

This modules provides an interface to the pikeo API photos searching methods.

The methods normally return a list of Pikeo::API::Photo objects.

FUNCTIONS

CONSTRUCTORS

new( \%args )

Returns a Pikeo::API::Photos object.

Required args are:

  • api

    The Pikeo::API object used to interact with the pikeo API

INSTANCE METHODS

getMostViewed(\%args)

(pikeo.photos.getMostViewed)

Gets most viewed public photos from the whole photo repository.

Returns a list of Pikeo::API::Photo objects

Optional args:

  • num_items

    Maximum number of items to return. Default 100, maximum 500.

search(\%args)

(pikeo.photos.search)

Search photos which title or associated tags contains a given text, or that match with all different criteria sent in parameters.

Returns a list of Pikeo::API::Photo objects

Optional args:

  • num_items

    Maximum number of items to return. Default 100, maximum 500.

  • text

    The text to search in photo title or tag name, must contain at least 3 characters

  • offset

    Number of the first element to return.

  • user_id

    Select photos for this user Id

  • user

    Select photos for this user

  • album_id

    Select photos for this album Id

  • album

    Select photos for this album

  • group_id

    Select photos for this group id

  • include_contact_photos

    Boolean, Include photos from contacts too

  • only_public

    Boolean, Filter to public photos only

  • order_asc

    Boolean, Acsendant or descendant order

  • order_type

    Order Type : 0 by default, 1 by date taken, 2 by upload date, 3 by most viewed, 4 by comment date, 5 by group add date.

  • tag_id_list

    Reference to an array

    Select photos for this list of tag id

  • high_date =item * end_date

    Select photos which date is before this date

    Date format: 2008-01-29 10:00:53

  • low_date =item * start_date

    Select photos which date is after this date

    Date format: 2008-01-29 10:00:53