org.symphonyoss.symphony.clients.impl

Class RoomMembershipClientImpl

java.lang.Object

org.symphonyoss.symphony.clients.impl.RoomMembershipClientImpl

All Implemented Interfaces:

RoomMembershipClient

public class RoomMembershipClientImpl
extends java.lang.Object
implements RoomMembershipClient

Supports the ability to identify and administrate members of a room (stream). It also supports identification of users for any streamID. This includes 1:1 and multi-party chat conversations.

Constructor Summary

Constructors

Constructor and Description
RoomMembershipClientImpl(SymAuth symAuth, SymphonyClientConfig config) Init
RoomMembershipClientImpl(SymAuth symAuth, SymphonyClientConfig config, javax.ws.rs.client.Client httpClient) If you need to override HttpClient.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoomMembershipClientImpl

public RoomMembershipClientImpl(SymAuth symAuth,
                                SymphonyClientConfig config)

Init

Parameters:

symAuth - Authorization object holding session and key tokens

config - Symphony client config

RoomMembershipClientImpl

public RoomMembershipClientImpl(SymAuth symAuth,
                                SymphonyClientConfig config,
                                javax.ws.rs.client.Client httpClient)

If you need to override HttpClient. Important for handling individual client certs.

Parameters:

symAuth - Authorization object holding session and key tokens

config - Symphony Client config

httpClient - The HttpClient to use when calling Symphony API

Method Detail

getRoomMembership

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

Provides room membership

Specified by:

getRoomMembership in interface RoomMembershipClient

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

public 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

Specified by:

addMemberToRoom in interface RoomMembershipClient

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

public 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

Specified by:

removeMemberFromRoom in interface RoomMembershipClient

Parameters:

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

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