org.springframework.social.yammer.api.impl
Class MessageTemplate

java.lang.Object
  org.springframework.social.yammer.api.impl.AbstractYammerOperations
      org.springframework.social.yammer.api.impl.MessageTemplate

All Implemented Interfaces:

MessageOperations

public class MessageTemplate
extends AbstractYammerOperations
implements MessageOperations

Author:

Morten Andersen-Gott

Field Summary

Fields inherited from interface org.springframework.social.yammer.api.MessageOperations

NO_THREADING, THREADED, THREADED_EXTENDED

Constructor Summary

MessageTemplate(org.springframework.web.client.RestTemplate restTemplate)

Method Summary

void	delete(long messageId) Deletes a message, current user must be owner
MessageInfo	getMessages(long olderThan, long newerThan, java.lang.String threaded, int limit) Gets messages from the company feed, essentially all messages posted in a Yammer network
MessageInfo	getMessagesAboutTopic(long topicId, long olderThan, long newerThan, java.lang.String threaded, int limit) Gets messages on a specified topic
MessageInfo	getMessagesFollowing(long olderThan, long newerThan, java.lang.String threaded, int limit) Gets messages from groups, topics and users you are following
MessageInfo	getMessagesFromUser(long userId, long olderThan, long newerThan, java.lang.String threaded, int limit) Gets the message posted by a given user
MessageInfo	getMessagesInGroup(long groupId, long olderThan, long newerThan, java.lang.String threaded, int limit)
MessageInfo	getMessagesInThread(long threadId, long olderThan, long newerThan, int limit) Get all messages for a thread
MessageInfo	getMessagesLikedByUser(long userId, long olderThan, long newerThan, java.lang.String threaded, int limit) Gets messages liked by a specified user
MessageInfo	getMessagesPrivate(long olderThan, long newerThan, java.lang.String threaded, int limit) Gets your private messages
MessageInfo	getMessagesReceived(long olderThan, long newerThan, java.lang.String threaded, int limit) Gets messages you've received
MessageInfo	getMessagesSent(long olderThan, long newerThan, java.lang.String threaded, int limit) Gets your sent messages
void	like(long messageId) Lets the logged in user like a message
MessageInfo	postUpdate(java.lang.String message) Post a textual message to your network
MessageInfo	postUpdate(java.lang.String message, YammerPostDetails details) Post an update to your network with details (ie attachments etc)
void	unlike(long messageId) Unlike a message that has previously been liked by logged in user

Methods inherited from class org.springframework.social.yammer.api.impl.AbstractYammerOperations

buildUri, buildUri, buildUri

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageTemplate

public MessageTemplate(org.springframework.web.client.RestTemplate restTemplate)

Parameters:

restTemplate -

Method Detail

getMessages

public MessageInfo getMessages(long olderThan,
                               long newerThan,
                               java.lang.String threaded,
                               int limit)

Description copied from interface: MessageOperations

Gets messages from the company feed, essentially all messages posted in a Yammer network

Specified by:

getMessages in interface MessageOperations

Parameters:

olderThan - return only messages older than this message id

newerThan - return only messages newer than this message id

threaded - type of threaded view or null if no threaded view is required. Valid values are: MessageOperations.THREADED_EXTENDED: return first message of thread and two most recent messages of thread, MessageOperations.THREADED: returns first message of each thread, MessageOperations.NO_THREADING: no threading

limit - the limit of number of messages returned (50 max)

Returns:

MessageInfo containing meta data and a list of messages

See Also:

MessageOperations.THREADED, MessageOperations.THREADED_EXTENDED, MessageOperations.NO_THREADING

getMessagesFollowing

public MessageInfo getMessagesFollowing(long olderThan,
                                        long newerThan,
                                        java.lang.String threaded,
                                        int limit)

Description copied from interface: MessageOperations

Gets messages from groups, topics and users you are following

Specified by:

getMessagesFollowing in interface MessageOperations

Parameters:

olderThan - return only messages older than this message id

newerThan - return only messages newer than this message id

threaded - type of threaded view or null if no threaded view is required. Valid values are: MessageOperations.THREADED_EXTENDED: return first message of thread and two most recent messages of thread, MessageOperations.THREADED: returns first message of each thread, MessageOperations.NO_THREADING: no threading

limit - the limit of number of messages returned (50 max)

Returns:

MessageInfo containing meta data and a list of messages

See Also:

MessageOperations.THREADED, MessageOperations.THREADED_EXTENDED, MessageOperations.NO_THREADING

getMessagesSent

public MessageInfo getMessagesSent(long olderThan,
                                   long newerThan,
                                   java.lang.String threaded,
                                   int limit)

Description copied from interface: MessageOperations

Gets your sent messages

Specified by:

getMessagesSent in interface MessageOperations

Parameters:

olderThan - return only messages older than this message id

newerThan - return only messages newer than this message id

threaded - type of threaded view or null if no threaded view is required. Valid values are: MessageOperations.THREADED_EXTENDED: return first message of thread and two most recent messages of thread, MessageOperations.THREADED: returns first message of each thread, MessageOperations.NO_THREADING: no threading

limit - the limit of number of messages returned (50 max)

Returns:

MessageInfo containing meta data and a list of messages

See Also:

MessageOperations.THREADED, MessageOperations.THREADED_EXTENDED, MessageOperations.NO_THREADING

getMessagesPrivate

public MessageInfo getMessagesPrivate(long olderThan,
                                      long newerThan,
                                      java.lang.String threaded,
                                      int limit)

Description copied from interface: MessageOperations

Gets your private messages

Specified by:

getMessagesPrivate in interface MessageOperations

Parameters:

olderThan - return only messages older than this message id

newerThan - return only messages newer than this message id

threaded - type of threaded view or null if no threaded view is required. Valid values are: MessageOperations.THREADED_EXTENDED: return first message of thread and two most recent messages of thread, MessageOperations.THREADED: returns first message of each thread, MessageOperations.NO_THREADING: no threading

limit - the limit of number of messages returned (50 max)

Returns:

MessageInfo containing meta data and a list of messages

See Also:

MessageOperations.THREADED, MessageOperations.THREADED_EXTENDED, MessageOperations.NO_THREADING

getMessagesAboutTopic

public MessageInfo getMessagesAboutTopic(long topicId,
                                         long olderThan,
                                         long newerThan,
                                         java.lang.String threaded,
                                         int limit)

Description copied from interface: MessageOperations

Gets messages on a specified topic

Specified by:

getMessagesAboutTopic in interface MessageOperations

Parameters:

topicId - the id of the topic for which you want to see messages

olderThan - return only messages older than this message id

newerThan - return only messages newer than this message id

threaded - type of threaded view or null if no threaded view is required. Valid values are: MessageOperations.THREADED_EXTENDED: return first message of thread and two most recent messages of thread, MessageOperations.THREADED: returns first message of each thread, MessageOperations.NO_THREADING: no threading

limit - the limit of number of messages returned (50 max)

Returns:

MessageInfo containing meta data and a list of messages

See Also:

MessageOperations.THREADED, MessageOperations.THREADED_EXTENDED, MessageOperations.NO_THREADING

getMessagesInGroup

public MessageInfo getMessagesInGroup(long groupId,
                                      long olderThan,
                                      long newerThan,
                                      java.lang.String threaded,
                                      int limit)

getMessagesInThread

public MessageInfo getMessagesInThread(long threadId,
                                       long olderThan,
                                       long newerThan,
                                       int limit)

Description copied from interface: MessageOperations

Get all messages for a thread

Specified by:

getMessagesInThread in interface MessageOperations

Parameters:

threadId - id of the thread for which messages will be returned

olderThan - return only messages older than this message id

newerThan - return only messages newer than this message id

limit - the limit of number of messages returned (50 max)

Returns:

MessageInfo containing meta data and a list of messages

getMessagesFromUser

public MessageInfo getMessagesFromUser(long userId,
                                       long olderThan,
                                       long newerThan,
                                       java.lang.String threaded,
                                       int limit)

Description copied from interface: MessageOperations

Gets the message posted by a given user

Specified by:

getMessagesFromUser in interface MessageOperations

Parameters:

userId - the user id you want to see the messages for

olderThan - return only messages older than this message id

newerThan - return only messages newer than this message id

threaded - type of threaded view or null if no threaded view is required. Valid values are: MessageOperations.THREADED_EXTENDED: return first message of thread and two most recent messages of thread, MessageOperations.THREADED: returns first message of each thread, MessageOperations.NO_THREADING: no threading

limit - the limit of number of messages returned (50 max)

Returns:

MessageInfo containing meta data and a list of messages

See Also:

MessageOperations.THREADED, MessageOperations.THREADED_EXTENDED, MessageOperations.NO_THREADING

getMessagesLikedByUser

public MessageInfo getMessagesLikedByUser(long userId,
                                          long olderThan,
                                          long newerThan,
                                          java.lang.String threaded,
                                          int limit)

Description copied from interface: MessageOperations

Gets messages liked by a specified user

Specified by:

getMessagesLikedByUser in interface MessageOperations

Parameters:

userId - of the person who've liked the messages

olderThan - return only messages older than this message id

newerThan - return only messages newer than this message id

threaded - type of threaded view or null if no threaded view is required. Valid values are: MessageOperations.THREADED_EXTENDED: return first message of thread and two most recent messages of thread, MessageOperations.THREADED: returns first message of each thread, MessageOperations.NO_THREADING: no threading

limit - the limit of number of messages returned (50 max)

Returns:

MessageInfo containing meta data and a list of messages

See Also:

MessageOperations.THREADED, MessageOperations.THREADED_EXTENDED, MessageOperations.NO_THREADING

getMessagesReceived

public MessageInfo getMessagesReceived(long olderThan,
                                       long newerThan,
                                       java.lang.String threaded,
                                       int limit)

Description copied from interface: MessageOperations

Gets messages you've received

Specified by:

getMessagesReceived in interface MessageOperations

Parameters:

olderThan - return only messages older than this message id

newerThan - return only messages newer than this message id

threaded - type of threaded view or null if no threaded view is required. Valid values are: MessageOperations.THREADED_EXTENDED: return first message of thread and two most recent messages of thread, MessageOperations.THREADED: returns first message of each thread, MessageOperations.NO_THREADING: no threading

limit - the limit of number of messages returned (50 max)

Returns:

MessageInfo containing meta data and a list of messages

See Also:

MessageOperations.THREADED, MessageOperations.THREADED_EXTENDED, MessageOperations.NO_THREADING

postUpdate

public MessageInfo postUpdate(java.lang.String message)

Description copied from interface: MessageOperations

Post a textual message to your network

Specified by:

postUpdate in interface MessageOperations

Returns:

MessageInfo containing meta data and your newly posted message

postUpdate

public MessageInfo postUpdate(java.lang.String message,
                              YammerPostDetails details)

Description copied from interface: MessageOperations

Post an update to your network with details (ie attachments etc)

Specified by:

postUpdate in interface MessageOperations

Parameters:

message - the text part of your message

details - additional details for your message

Returns:

MessageInfo containing meta data and your newly posted message

like

public void like(long messageId)

Description copied from interface: MessageOperations

Lets the logged in user like a message

Specified by:

like in interface MessageOperations

Parameters:

messageId - id to like

unlike

public void unlike(long messageId)

Description copied from interface: MessageOperations

Unlike a message that has previously been liked by logged in user

Specified by:

unlike in interface MessageOperations

Parameters:

messageId - id to unlike

delete

public void delete(long messageId)

Description copied from interface: MessageOperations

Deletes a message, current user must be owner

Specified by:

delete in interface MessageOperations