org.symphonyoss.symphony.clients

Interface ConnectionsClient

All Known Implementing Classes:

ConnectionsClientImpl

public interface ConnectionsClient

Method Summary

Modifier and Type	Method and Description
SymUserConnection	acceptConnectionRequest(SymUserConnection symUserConnection) Accept a connection request
SymUserConnection	acceptConnectionRequest(SymUserConnectionRequest symUserConnectionRequest) Accept a connection request
java.util.List<SymUserConnection>	getAcceptedRequests() Retrieve accepted connection requests
java.util.List<SymUserConnection>	getAllConnections() Retrieve all connection requests with all states
java.util.List<SymUserConnection>	getIncomingRequests() Retrieve incoming connection requests
java.util.List<SymUserConnection>	getPendingRequests() Retrieve pending incoming connection requests
java.util.List<SymUserConnection>	getRejectedRequests() Retrieve rejected connection requests
SymUserConnection	getUserConnection(java.lang.String userId) Deprecated. please use getUserConnection(SymUser) Retrieve a user connection request
SymUserConnection	getUserConnection(SymUser symUser) Retrieve a user connection request by SymUser
SymUserConnection	rejectConnectionRequest(SymUserConnectionRequest symUserConnectionRequest) Reject a connection request
void	removeConnectionRequest(SymUser symUser) Remove incoming connection requests
SymUserConnection	sendConnectionRequest(SymUserConnectionRequest symUserConnectionRequest) Send a connection request

Method Detail

getIncomingRequests

java.util.List<SymUserConnection> getIncomingRequests()
                                               throws ConnectionsException

Retrieve incoming connection requests

Returns:

List of SymUserConnectionRequest

Throws:

ConnectionsException - from underlying API exceptions.

getPendingRequests

java.util.List<SymUserConnection> getPendingRequests()
                                              throws ConnectionsException

Retrieve pending incoming connection requests

Returns:

List of SymUserConnectionRequest

Throws:

ConnectionsException - from underlying API exceptions.

getRejectedRequests

java.util.List<SymUserConnection> getRejectedRequests()
                                               throws ConnectionsException

Retrieve rejected connection requests

Returns:

List of SymUserConnectionRequest

Throws:

ConnectionsException - from underlying API exceptions.

getAcceptedRequests

java.util.List<SymUserConnection> getAcceptedRequests()
                                               throws ConnectionsException

Retrieve accepted connection requests

Returns:

List of SymUserConnectionRequest

Throws:

ConnectionsException - from underlying API exceptions.

getAllConnections

java.util.List<SymUserConnection> getAllConnections()
                                             throws ConnectionsException

Retrieve all connection requests with all states

Returns:

List of SymUserConnectionRequest

Throws:

ConnectionsException - from underlying API exceptions.

removeConnectionRequest

void removeConnectionRequest(SymUser symUser)
                      throws ConnectionsException

Remove incoming connection requests

Parameters:

symUser - The symphony user to remove a connection from.

Throws:

ConnectionsException - from underlying API exceptions.

sendConnectionRequest

SymUserConnection sendConnectionRequest(SymUserConnectionRequest symUserConnectionRequest)
                                 throws ConnectionsException

Send a connection request

Parameters:

symUserConnectionRequest - User connection request

Returns:

The result of the connection inclusive of state

Throws:

ConnectionsException - from underlying API exceptions.

acceptConnectionRequest

SymUserConnection acceptConnectionRequest(SymUserConnectionRequest symUserConnectionRequest)
                                   throws ConnectionsException

Accept a connection request

Parameters:

symUserConnectionRequest - User connection request

Returns:

The result of the connection inclusive of state

Throws:

ConnectionsException - from underlying API exceptions.

rejectConnectionRequest

SymUserConnection rejectConnectionRequest(SymUserConnectionRequest symUserConnectionRequest)
                                   throws ConnectionsException

Reject a connection request

Parameters:

symUserConnectionRequest - User connection request

Returns:

The result of the connection inclusive of state

Throws:

ConnectionsException - from underlying API exceptions.

getUserConnection

@Deprecated
SymUserConnection getUserConnection(java.lang.String userId)
                                         throws ConnectionsException

Deprecated. please use getUserConnection(SymUser) Retrieve a user connection request

Parameters:

userId - Symphony user ID

Returns:

The result of the connection inclusive of state

Throws:

ConnectionsException - from underlying API exceptions.

acceptConnectionRequest

SymUserConnection acceptConnectionRequest(SymUserConnection symUserConnection)
                                   throws ConnectionsException

Accept a connection request

Parameters:

symUserConnection - User connection request

Returns:

The result of the connection inclusive of state

Throws:

ConnectionsException - from underlying API exceptions.

getUserConnection

SymUserConnection getUserConnection(SymUser symUser)
                             throws ConnectionsException

Retrieve a user connection request by SymUser

Parameters:

symUser - The Symphony user

Returns:

The connection

Throws:

ConnectionsException - from underlying API exceptions