org.symphonyoss.symphony.clients

Interface StreamsClient

All Known Implementing Classes:

StreamsClientImpl

public interface StreamsClient

Method Summary

Modifier and Type	Method and Description
SymRoomDetail	createChatRoom(SymRoomAttributes roomAttributes)
void	deactivateRoom(java.lang.String roomId) Deactivates a room for a given roomId
SymRoomDetail	getRoomDetail(java.lang.String id)
SymStream	getStream(java.util.Set<SymUser> users)
SymStream	getStream(SymUser user)
SymStream	getStream(org.symphonyoss.symphony.pod.model.UserIdList userIdList)
SymStreamAttributes	getStreamAttributes(java.lang.String streamId)
SymStream	getStreamFromEmail(java.lang.String email)
SymAdminStreamList	getStreams(java.lang.Integer skip, java.lang.Integer limit, SymAdminStreamFilter symAdminStreamFilter)
java.util.List<SymStreamAttributes>	getStreams(java.lang.Integer skip, java.lang.Integer limit, SymStreamFilter symStreamFilter)
SymRoomSearchResults	roomSearch(SymRoomSearchCriteria searchCriteria, java.lang.Integer skip, java.lang.Integer limit)
SymRoomDetail	updateChatRoom(java.lang.String streamId, SymRoomAttributes roomAttributes)

Method Detail

getStream

SymStream getStream(SymUser user)
             throws StreamsException

Throws:

StreamsException

getStream

SymStream getStream(java.util.Set<SymUser> users)
             throws StreamsException

Throws:

StreamsException

getStream

SymStream getStream(org.symphonyoss.symphony.pod.model.UserIdList userIdList)
             throws StreamsException

Throws:

StreamsException

getStreams

SymAdminStreamList getStreams(java.lang.Integer skip,
                              java.lang.Integer limit,
                              SymAdminStreamFilter symAdminStreamFilter)
                       throws StreamsException

Throws:

StreamsException

getStreams

java.util.List<SymStreamAttributes> getStreams(java.lang.Integer skip,
                                               java.lang.Integer limit,
                                               SymStreamFilter symStreamFilter)
                                        throws StreamsException

Throws:

StreamsException

getStreamFromEmail

SymStream getStreamFromEmail(java.lang.String email)
                      throws StreamsException

Throws:

StreamsException

getRoomDetail

SymRoomDetail getRoomDetail(java.lang.String id)
                     throws StreamsException

Throws:

StreamsException

createChatRoom

SymRoomDetail createChatRoom(SymRoomAttributes roomAttributes)
                      throws StreamsException

Throws:

StreamsException

updateChatRoom

SymRoomDetail updateChatRoom(java.lang.String streamId,
                             SymRoomAttributes roomAttributes)
                      throws StreamsException

Throws:

StreamsException

roomSearch

SymRoomSearchResults roomSearch(SymRoomSearchCriteria searchCriteria,
                                java.lang.Integer skip,
                                java.lang.Integer limit)
                         throws StreamsException

Throws:

StreamsException

getStreamAttributes

SymStreamAttributes getStreamAttributes(java.lang.String streamId)
                                 throws StreamsException

Throws:

StreamsException

deactivateRoom

void deactivateRoom(java.lang.String roomId)
             throws StreamsException

Deactivates a room for a given roomId

Parameters:

roomId - the room to be deactivated

Throws:

StreamsException - if the deactivation failed