org.symphonyoss.symphony.clients

Interface MessagesClient

All Known Implementing Classes:

MessagesClientImpl

public interface MessagesClient

Method Summary

Modifier and Type	Method and Description
java.util.List<SymMessage>	getMessagesFromStream(org.symphonyoss.symphony.pod.model.Stream stream, java.lang.Long since, java.lang.Integer offset, java.lang.Integer maxMessages) Retrieve historical messages from a given stream.
java.util.List<SymMessage>	getMessagesFromStream(SymStream symStream, java.lang.Long since, java.lang.Integer offset, java.lang.Integer maxMessages) Retrieve historical messages from a given stream.
java.util.List<SymMessage>	getMessagesFromStream(SymStream symStream, java.lang.Long since, java.lang.Integer offset, java.lang.Integer maxMessages, ApiVersion apiVersion1)
SymMessage	sendMessage(org.symphonyoss.symphony.pod.model.Stream stream, SymMessage message) Send message to stream
SymMessage	sendMessage(SymStream stream, SymMessage message) Send message to Symstream

Method Detail

sendMessage

SymMessage sendMessage(org.symphonyoss.symphony.pod.model.Stream stream,
                       SymMessage message)
                throws MessagesException

Send message to stream

Parameters:

stream - Stream to send message to

message - Message to send

Returns:

Message sent

Throws:

MessagesException - Exception caused by Symphony API calls

sendMessage

SymMessage sendMessage(SymStream stream,
                       SymMessage message)
                throws MessagesException

Send message to Symstream

Parameters:

stream - Stream to send message to

message - Message to send

Returns:

Message sent

Throws:

MessagesException - Exception caused by Symphony API calls

getMessagesFromStream

java.util.List<SymMessage> getMessagesFromStream(SymStream symStream,
                                                 java.lang.Long since,
                                                 java.lang.Integer offset,
                                                 java.lang.Integer maxMessages,
                                                 ApiVersion apiVersion1)
                                          throws MessagesException

Throws:

MessagesException

getMessagesFromStream

java.util.List<SymMessage> getMessagesFromStream(SymStream symStream,
                                                 java.lang.Long since,
                                                 java.lang.Integer offset,
                                                 java.lang.Integer maxMessages)
                                          throws MessagesException

Retrieve historical messages from a given stream. This is NOT a blocking call.

Parameters:

symStream - Stream to retrieve messages from

since - Date (long) from point in time

offset - Offset

maxMessages - Maximum number of messages to retrieve from the specified time (since)

Returns:

List of messages

Throws:

MessagesException - Exception caused by Symphony API calls

getMessagesFromStream

java.util.List<SymMessage> getMessagesFromStream(org.symphonyoss.symphony.pod.model.Stream stream,
                                                 java.lang.Long since,
                                                 java.lang.Integer offset,
                                                 java.lang.Integer maxMessages)
                                          throws MessagesException

Retrieve historical messages from a given stream. This is NOT a blocking call.

Parameters:

stream - Stream to retrieve messages from

since - Date (long) from point in time

offset - Offset

maxMessages - Maximum number of messages to retrieve from the specified time (since)

Returns:

List of messages

Throws:

MessagesException - Exception caused by Symphony API calls