com.aetrion.flickr.contacts
Class ContactsInterface

java.lang.Object
  extended by com.aetrion.flickr.contacts.ContactsInterface

public class ContactsInterface
extends java.lang.Object

Interface for working with Flickr contacts.

Version:
$Id: ContactsInterface.java,v 1.18 2009/07/11 20:30:27 x-mago Exp $
Author:
Anthony Eden

Constructor Summary
ContactsInterface(java.lang.String apiKey, java.lang.String sharedSecret, Transport transportAPI)
           
 
Method Summary
 java.util.Collection getList()
          Get the collection of contacts for the calling user.
 java.util.Collection getListRecentlyUploaded(java.util.Date lastUpload, java.lang.String filter)
          Return a list of contacts for a user who have recently uploaded photos along with the total count of photos uploaded.
 java.util.Collection getPublicList(java.lang.String userId)
          Get the collection of public contacts for the specified user ID.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ContactsInterface

public ContactsInterface(java.lang.String apiKey,
                         java.lang.String sharedSecret,
                         Transport transportAPI)
Method Detail

getList

public java.util.Collection getList()
                             throws java.io.IOException,
                                    org.xml.sax.SAXException,
                                    FlickrException
Get the collection of contacts for the calling user.

Returns:
The Collection of Contact objects
Throws:
java.io.IOException
org.xml.sax.SAXException
FlickrException

getListRecentlyUploaded

public java.util.Collection getListRecentlyUploaded(java.util.Date lastUpload,
                                                    java.lang.String filter)
                                             throws java.io.IOException,
                                                    org.xml.sax.SAXException,
                                                    FlickrException
Return a list of contacts for a user who have recently uploaded photos along with the total count of photos uploaded.

Parameters:
lastUpload - Limits the resultset to contacts that have uploaded photos since this date. The date should be in the form of a Unix timestamp. The default, and maximum, offset is (1) hour. (Optional, can be null)
filter - Limit the result set to all contacts or only those who are friends or family.
Valid options are: ff -> friends and family, all -> all your contacts. (Optional, can be null)
Returns:
List of Contacts
Throws:
java.io.IOException
org.xml.sax.SAXException
FlickrException

getPublicList

public java.util.Collection getPublicList(java.lang.String userId)
                                   throws java.io.IOException,
                                          org.xml.sax.SAXException,
                                          FlickrException
Get the collection of public contacts for the specified user ID. This method does not require authentication.

Parameters:
userId - The user ID
Returns:
The Collection of Contact objects
Throws:
java.io.IOException
org.xml.sax.SAXException
FlickrException


Copyright (C) 2005-2008 Aetrion LLC. All Rights Reserved.