com.symphony.bdk.core.service.connection

Interface OboConnectionService

All Known Implementing Classes:

ConnectionService

@API(status=STABLE)
public interface OboConnectionService

Service interface exposing OBO-enabled endpoints to manage user connection status.

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> userIds) List all current connection statuses with external or specified users.
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.

Method Detail

getConnection

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

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

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

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

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

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.

userIds - 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

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

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

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

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

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

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

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

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

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

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

Removes a connection with a user. ConnectionService.removeConnection(Long)

Parameters:

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

See Also:

Remove Connection