org.symphonyoss.symphony.clients

Interface RoomMembershipClient

All Known Implementing Classes:

RoomMembershipClientImpl

public interface RoomMembershipClient

Supports adding/removing members from a room. Also provides members lookup for a given stream

Method Summary

Modifier and Type	Method and Description
void	addMemberToRoom(java.lang.String roomStreamId, long userId) Call this method to add a member to a chat room.
org.symphonyoss.symphony.pod.model.MembershipList	getRoomMembership(java.lang.String roomStreamId) Provides room membership
void	removeMemberFromRoom(java.lang.String roomStreamId, long userId) Call this method to remove a member from a chat room.

Method Detail

getRoomMembership

org.symphonyoss.symphony.pod.model.MembershipList getRoomMembership(java.lang.String roomStreamId)
                                                             throws SymException

Provides room membership

Parameters:

roomStreamId - - stream-id of the chat room you want to add the member to

Returns:

MembershipList

Throws:

SymException - Exceptions from API calls into Symphony

addMemberToRoom

void addMemberToRoom(java.lang.String roomStreamId,
                     long userId)
              throws SymException

Call this method to add a member to a chat room. Pass in two parameters - chat-room stream-id and user-id

Parameters:

roomStreamId - - stream-id of the chat room you want to add the member to

userId - userId for the user in Symphony

Throws:

SymException - throws an ApiException if there were any issues while invoking the endpoint, IllegalArgumentException if the arguments were wrong, IllegalStateException if the session-token is null

removeMemberFromRoom

void removeMemberFromRoom(java.lang.String roomStreamId,
                          long userId)
                   throws SymException

Call this method to remove a member from a chat room. Pass in two parameters - chat-room stream-id and user-id

Parameters:

roomStreamId - - stream-id of the chat room you want to add the member to

userId - userId for the user in Symphony

Throws:

SymException - throws an ApiException if there were any issues while invoking the endpoint, IllegalArgumentException if the arguments were wrong, IllegalStateException if the session-token is null