com.symphony.bdk.core.service.connection

Class ConnectionService

java.lang.Object

com.symphony.bdk.core.service.connection.ConnectionService

All Implemented Interfaces:

OboConnectionService, OboService<OboConnectionService>

@API(status=STABLE)
public class ConnectionService
extends java.lang.Object
implements OboConnectionService, OboService<OboConnectionService>

Service class for managing connection status.

This service is used for retrieving the connection status if the calling user with a specified user or with many other internal or external users in the pod, and perform some actions related to the connection status like:

• Send a connection request to an user
• Accept a connection request from an user
• Reject a connection request from an user
• Remove a connection with an user

Constructor Summary

Constructors

Constructor and Description
ConnectionService(ConnectionApi connectionApi, AuthSession authSession, RetryWithRecoveryBuilder<?> retryBuilder)
ConnectionService(ConnectionApi connectionApi, RetryWithRecoveryBuilder<?> retryBuilder)

Method Summary

Modifier and Type	Method and Description
UserConnection	acceptConnection(java.lang.Long userId) Accept the connection request from a requesting user.
UserConnection	createConnection(java.lang.Long userId) Sends a connection request to another user.
UserConnection	getConnection(java.lang.Long userId) Get connection status, i.e.
java.util.List<UserConnection>	listConnections(ConnectionStatus status, java.util.List<java.lang.Long> userIdList) List all current connection statuses with external or specified users.
OboConnectionService	obo(AuthSession oboSession) Returns a new service instance with OBO-enabled endpoints from a given OBO session.
UserConnection	rejectConnection(java.lang.Long userId) Reject the connection request from a requesting user.
void	removeConnection(java.lang.Long userId) Removes a connection with a user.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.symphony.bdk.core.service.OboService

checkAuthSession

Constructor Detail

ConnectionService

public ConnectionService(ConnectionApi connectionApi,
                         AuthSession authSession,
                         RetryWithRecoveryBuilder<?> retryBuilder)

ConnectionService

public ConnectionService(ConnectionApi connectionApi,
                         RetryWithRecoveryBuilder<?> retryBuilder)

Method Detail

obo

public OboConnectionService obo(AuthSession oboSession)

Returns a new service instance with OBO-enabled endpoints from a given OBO session.

Specified by:

obo in interface OboService<OboConnectionService>

Parameters:

oboSession - the OBO session

Returns:

the instance of the service class with OBO-enabled endpoints

getConnection

public UserConnection getConnection(@Nonnull
                                    java.lang.Long userId)

Get connection status, i.e. check if the calling user is connected to the specified user. getConnection(Long)

Specified by:

getConnection in interface OboConnectionService

Parameters:

userId - The id of the user with whom the caller want to check.

Returns:

Connection status with the specified user.

See Also:

Get Connection

listConnections

public java.util.List<UserConnection> listConnections(@Nullable
                                                      ConnectionStatus status,
                                                      @Nullable
                                                      java.util.List<java.lang.Long> userIdList)

List all current connection statuses with external or specified users. listConnections(ConnectionStatus, List)

Specified by:

listConnections in interface OboConnectionService

Parameters:

status - Filter the connection list based on the connection status. The connection status can only be pending_incoming, pending_outgoing, accepted, rejected, or all. If you do not specify a status, all connections will be returned.

userIdList - List of user ids which are used to restrict the list of results. This can be used to return connections with internal users; although, by default, this endpoint does not list implicit connections with internal users.

Returns:

List of connection statuses with the specified users and status.

See Also:

List Connections

createConnection

public UserConnection createConnection(@Nonnull
                                       java.lang.Long userId)

Sends a connection request to another user. createConnection(Long)

Specified by:

createConnection in interface OboConnectionService

Parameters:

userId - The id of the user with whom the caller want to connect.

Returns:

Connection status with the specified user.

See Also:

Create Connection

acceptConnection

public UserConnection acceptConnection(@Nonnull
                                       java.lang.Long userId)

Accept the connection request from a requesting user. acceptConnection(Long)

Specified by:

acceptConnection in interface OboConnectionService

Parameters:

userId - The id of the user who requested to connect with the caller.

Returns:

Connection status with the requesting user.

See Also:

Accept Connection

rejectConnection

public UserConnection rejectConnection(@Nonnull
                                       java.lang.Long userId)

Reject the connection request from a requesting user. rejectConnection(Long)

Specified by:

rejectConnection in interface OboConnectionService

Parameters:

userId - The id of the user who requested to connect with the caller.

Returns:

Connection status with the requesting user.

See Also:

Reject Connection

removeConnection

public void removeConnection(@Nonnull
                             java.lang.Long userId)

Removes a connection with a user. removeConnection(Long)

Specified by:

removeConnection in interface OboConnectionService

Parameters:

userId - The id of the user with whom we want to remove the connection.

See Also:

Remove Connection