symphony.bdk.core.service.connection.connection_service.OboConnectionService#

class symphony.bdk.core.service.connection.connection_service.OboConnectionService(connection_api: symphony.bdk.gen.pod_api.connection_api.ConnectionApi, auth_session: symphony.bdk.core.auth.auth_session.AuthSession, retry_config: symphony.bdk.core.config.model.bdk_retry_config.BdkRetryConfig)#

Bases: object

Class exposing OBO-enabled endpoints for connection management.

This service is used for retrieving the connection status between the OBO user and a specified user or several 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 a user

  • Reject a connection request from a user

  • Remove a connection with a user

__init__(connection_api: symphony.bdk.gen.pod_api.connection_api.ConnectionApi, auth_session: symphony.bdk.core.auth.auth_session.AuthSession, retry_config: symphony.bdk.core.config.model.bdk_retry_config.BdkRetryConfig)#

Methods

__init__(connection_api, auth_session, ...)

accept_connection(user_id)

Accept the connection request from a requesting user.

create_connection(user_id)

Sends a connection request to another user.

get_connection(user_id)

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

list_connections([status, user_ids])

List all connection statuses of the requesting user with external or specified users.

reject_connection(user_id)

Reject the connection request from a requesting user.

remove_connection(user_id)

Removes a connection with a user.
accept_connection(user_id: int) → symphony.bdk.gen.pod_model.user_connection.UserConnection#

Accept the connection request from a requesting user. See: Accept Connection

Parameters

user_id – The id of the user who requested to connect with the caller.

Returns

Connection status with the requesting user.

create_connection(user_id: int) → symphony.bdk.gen.pod_model.user_connection.UserConnection#

Sends a connection request to another user. See: Create Connection

Parameters

user_id – The id of the user with whom the caller want to connect.

Returns

Connection status with the specified user.

get_connection(user_id: int) → symphony.bdk.gen.pod_model.user_connection.UserConnection#

Get connection status, i.e. check if the calling user is connected to the specified user. See: Get Connection

Parameters

user_id – The id of the user with whom the caller want to check.

Returns

Connection status with the specified user.

list_connections(status: symphony.bdk.core.service.connection.model.connection_status.ConnectionStatus = ConnectionStatus.ALL, user_ids: [<class 'int'>] = None) → [<class 'symphony.bdk.gen.pod_model.user_connection.UserConnection'>]#

List all connection statuses of the requesting user with external or specified users. See: List Connections

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.

  • user_ids – 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.

reject_connection(user_id: int) → symphony.bdk.gen.pod_model.user_connection.UserConnection#

Reject the connection request from a requesting user. See: Reject Connection

Parameters

user_id – The id of the user who requested to connect with the caller.

Returns

Connection status with the requesting user.

remove_connection(user_id: int) → None#

Removes a connection with a user. See: Remove Connection

Parameters

user_id – The id of the user with whom we want to remove the connection.