com.flickr4java.flickr.contacts

Class Contact

java.lang.Object

com.flickr4java.flickr.contacts.Contact

All Implemented Interfaces:

BuddyIconable

public class Contact
extends java.lang.Object
implements BuddyIconable

Class representing a Flickr contact.

Constructor Summary

Constructors

Constructor and Description
Contact()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAwayMessage() Get the contact's away message.
java.lang.String	getBuddyIconUrl() Construct the BuddyIconUrl.
int	getIconFarm()
int	getIconServer()
java.lang.String	getId()
OnlineStatus	getOnline()
java.lang.String	getPathAlias() Get the contact's path alias, which may appear instead of nsid in urls published by Flickr.
java.lang.String	getRealName()
java.lang.String	getUsername()
boolean	isFamily()
boolean	isFriend()
boolean	isIgnored()
void	setAwayMessage(java.lang.String awayMessage)
void	setFamily(boolean family)
void	setFriend(boolean friend)
void	setIconFarm(int iconFarm)
void	setIconFarm(java.lang.String iconFarm)
void	setIconServer(int iconServer)
void	setIconServer(java.lang.String iconServer)
void	setId(java.lang.String id)
void	setIgnored(boolean ignored)
void	setOnline(OnlineStatus online)
void	setPathAlias(java.lang.String pathAlias)
void	setRealName(java.lang.String realName)
void	setUsername(java.lang.String username)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Contact

public Contact()

Method Detail

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getUsername

public java.lang.String getUsername()

setUsername

public void setUsername(java.lang.String username)

getRealName

public java.lang.String getRealName()

setRealName

public void setRealName(java.lang.String realName)

isFriend

public boolean isFriend()

setFriend

public void setFriend(boolean friend)

isFamily

public boolean isFamily()

setFamily

public void setFamily(boolean family)

isIgnored

public boolean isIgnored()

setIgnored

public void setIgnored(boolean ignored)

getOnline

public OnlineStatus getOnline()

setOnline

public void setOnline(OnlineStatus online)

getAwayMessage

public java.lang.String getAwayMessage()

Get the contact's away message. This method may return null if the contact online status is not 'away'.

Returns:

The away message or null

setAwayMessage

public void setAwayMessage(java.lang.String awayMessage)

getBuddyIconUrl

public java.lang.String getBuddyIconUrl()

Construct the BuddyIconUrl.

If none available, return the default, or an URL assembled from farm, iconserver and nsid.

Specified by:

getBuddyIconUrl in interface BuddyIconable

Returns:

The BuddyIconUrl

See Also:

Flickr Documentation

getIconFarm

public int getIconFarm()

Specified by:

getIconFarm in interface BuddyIconable

setIconFarm

public void setIconFarm(int iconFarm)

Specified by:

setIconFarm in interface BuddyIconable

setIconFarm

public void setIconFarm(java.lang.String iconFarm)

Specified by:

setIconFarm in interface BuddyIconable

getIconServer

public int getIconServer()

Specified by:

getIconServer in interface BuddyIconable

setIconServer

public void setIconServer(int iconServer)

Specified by:

setIconServer in interface BuddyIconable

setIconServer

public void setIconServer(java.lang.String iconServer)

Specified by:

setIconServer in interface BuddyIconable

getPathAlias

public java.lang.String getPathAlias()

Get the contact's path alias, which may appear instead of nsid in urls published by Flickr. For example feeds have urls of the form .../photos/${NSID_OR_PATHALIAS}/${PHOTO_ID} & .../people/${NSID_OR_PATHALIAS}. This allows clients to look up a Contact given such a url. (Note that <author> elements in feeds have a <flickr:nsid> child which could be used instead of the lookup this method enables.)

Returns:

the path alias, or null

setPathAlias

public void setPathAlias(java.lang.String pathAlias)