org.springframework.social.yammer.api
Class YammerReference

java.lang.Object
  org.springframework.social.yammer.api.YammerReference

Direct Known Subclasses:

GroupReference, MessageReference, TagReference, ThreadReference, TopicReference, UserReference

public class YammerReference
extends java.lang.Object

A reference to a tag, topic, user, message group or thread. References are lightweight representations of the underlying object. This allows you to display key data about objects referenced in messages without doing additional polls. Each reference type maps to a subclass of YammerReference, which provides additional information beyond the common properties specified by this class. Unknown references will be mapped to the parent class YammerReference. From the Yammer API documentation: References are used when one object refers to another, and data about the referenced object would be useful. This avoids redundancy in what is returned. For example, a page of messages may include 20 messages from the same user. Each message will indicate that it was sent by a user and that user's ID, and the references section will include that user only once and include the name and mugshot (profile picture) URL.

Author:

Morten Andersen-Gott

Constructor Summary

YammerReference(long id, java.lang.String url, java.lang.String webUrl)

Method Summary

long	getId()
java.lang.String	getUrl()
java.lang.String	getWebUrl()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

YammerReference

public YammerReference(long id,
                       java.lang.String url,
                       java.lang.String webUrl)

Method Detail

getId

public long getId()

getUrl

public java.lang.String getUrl()

getWebUrl

public java.lang.String getWebUrl()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object