Package com.symphony.bdk.gen.api

Class ConnectionApi

java.lang.Object
com.symphony.bdk.gen.api.ConnectionApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-03-26T16:14:56.804588655Z[Etc/UTC]") public class ConnectionApi extends Object

  • Constructor Details

    • ConnectionApi

      public ConnectionApi(com.symphony.bdk.http.api.ApiClient apiClient)

  • Method Details

    • getApiClient

      public com.symphony.bdk.http.api.ApiClient getApiClient()
      Get the API cilent
      Returns:
      API client

    • setApiClient

      public void setApiClient(com.symphony.bdk.http.api.ApiClient apiClient)
      Set the API cilent
      Parameters:
      apiClient - an instance of API client

    • v1ConnectionAcceptPost

      public UserConnection v1ConnectionAcceptPost(String sessionToken, UserConnectionRequest connectionRequest) throws com.symphony.bdk.http.api.ApiException
      Accept the connection request for the requesting user
      Parameters:
      sessionToken - Session authentication token. (required)
      connectionRequest - (required)
      Returns:
      UserConnection
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1ConnectionAcceptPostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<UserConnection> v1ConnectionAcceptPostWithHttpInfo(String sessionToken, UserConnectionRequest connectionRequest) throws com.symphony.bdk.http.api.ApiException
      Accept the connection request for the requesting user
      Parameters:
      sessionToken - Session authentication token. (required)
      connectionRequest - (required)
      Returns:
      ApiResponse<UserConnection>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1ConnectionCreatePost

      public UserConnection v1ConnectionCreatePost(String sessionToken, UserConnectionRequest connectionRequest) throws com.symphony.bdk.http.api.ApiException
      Sends an invitation to connect with another user
      Parameters:
      sessionToken - Session authentication token. (required)
      connectionRequest - (required)
      Returns:
      UserConnection
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1ConnectionCreatePostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<UserConnection> v1ConnectionCreatePostWithHttpInfo(String sessionToken, UserConnectionRequest connectionRequest) throws com.symphony.bdk.http.api.ApiException
      Sends an invitation to connect with another user
      Parameters:
      sessionToken - Session authentication token. (required)
      connectionRequest - (required)
      Returns:
      ApiResponse<UserConnection>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1ConnectionListGet

      public List<UserConnection> v1ConnectionListGet(String sessionToken, String status, String userIds) throws com.symphony.bdk.http.api.ApiException
      List of requesting user's connection This retrieves all connections of the requesting user. (i.e. both connections in which the requesting user is the sender and those in which the requesting user is the inivtee) By default, if you haven't specified the connection status to filter on, this call will only return results for both \"pending_incoming\" and \"pending_outgoing\". You can optionally filter by userIds to further restrict the results of a specific connection status. If the users are in the same private pod, the users have an implicit connection status of \"accepted\". Those users will not be returned in the response if you don't specify the connection status as \"accepted\" (default is \"pending\") and the explicit userIds in the request.
      Parameters:
      sessionToken - Session authentication token. (required)
      status - Filter the connection list based on the connection status. The connection status can only be pending_incoming, pending_outgoing, accepted, rejected, or all (all of the above) (optional)
      userIds - The userIds parameter should be specified as a comma delimited list of user ids and can be used to restrict the results of a specific connection. Note that this is particularly important if the caller intends to retrieve results for implicit connection (user within the same pod). Implicit connections will not be included in the response if userId is not provided. (optional)
      Returns:
      List<UserConnection>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1ConnectionListGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<List<UserConnection>> v1ConnectionListGetWithHttpInfo(String sessionToken, String status, String userIds) throws com.symphony.bdk.http.api.ApiException
      List of requesting user's connection This retrieves all connections of the requesting user. (i.e. both connections in which the requesting user is the sender and those in which the requesting user is the inivtee) By default, if you haven't specified the connection status to filter on, this call will only return results for both \"pending_incoming\" and \"pending_outgoing\". You can optionally filter by userIds to further restrict the results of a specific connection status. If the users are in the same private pod, the users have an implicit connection status of \"accepted\". Those users will not be returned in the response if you don't specify the connection status as \"accepted\" (default is \"pending\") and the explicit userIds in the request.
      Parameters:
      sessionToken - Session authentication token. (required)
      status - Filter the connection list based on the connection status. The connection status can only be pending_incoming, pending_outgoing, accepted, rejected, or all (all of the above) (optional)
      userIds - The userIds parameter should be specified as a comma delimited list of user ids and can be used to restrict the results of a specific connection. Note that this is particularly important if the caller intends to retrieve results for implicit connection (user within the same pod). Implicit connections will not be included in the response if userId is not provided. (optional)
      Returns:
      ApiResponse<List<UserConnection>>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1ConnectionRejectPost

      public UserConnection v1ConnectionRejectPost(String sessionToken, UserConnectionRequest connectionRequest) throws com.symphony.bdk.http.api.ApiException
      Reject the connection request for the requesting user. Reject the connection between the requesting user and request sender. If both users are in the same private pod, an error will be returned because both users have an implicit connection which cannot be rejected.
      Parameters:
      sessionToken - Session authentication token. (required)
      connectionRequest - (required)
      Returns:
      UserConnection
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1ConnectionRejectPostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<UserConnection> v1ConnectionRejectPostWithHttpInfo(String sessionToken, UserConnectionRequest connectionRequest) throws com.symphony.bdk.http.api.ApiException
      Reject the connection request for the requesting user. Reject the connection between the requesting user and request sender. If both users are in the same private pod, an error will be returned because both users have an implicit connection which cannot be rejected.
      Parameters:
      sessionToken - Session authentication token. (required)
      connectionRequest - (required)
      Returns:
      ApiResponse<UserConnection>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1ConnectionUserUidRemovePost

      public SuccessResponse v1ConnectionUserUidRemovePost(String sessionToken, Long uid) throws com.symphony.bdk.http.api.ApiException
      Removes a connection with a user.
      Parameters:
      sessionToken - Session authentication token. (required)
      uid - User ID as a decimal integer (required)
      Returns:
      SuccessResponse
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1ConnectionUserUidRemovePostWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1ConnectionUserUidRemovePostWithHttpInfo(String sessionToken, Long uid) throws com.symphony.bdk.http.api.ApiException
      Removes a connection with a user.
      Parameters:
      sessionToken - Session authentication token. (required)
      uid - User ID as a decimal integer (required)
      Returns:
      ApiResponse<SuccessResponse>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1ConnectionUserUserIdInfoGet

      public UserConnection v1ConnectionUserUserIdInfoGet(String sessionToken, String userId) throws com.symphony.bdk.http.api.ApiException
      The status of the connection invitation to another user.
      Parameters:
      sessionToken - Session authentication token. (required)
      userId - user Id (required)
      Returns:
      UserConnection
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call

    • v1ConnectionUserUserIdInfoGetWithHttpInfo

      public com.symphony.bdk.http.api.ApiResponse<UserConnection> v1ConnectionUserUserIdInfoGetWithHttpInfo(String sessionToken, String userId) throws com.symphony.bdk.http.api.ApiException
      The status of the connection invitation to another user.
      Parameters:
      sessionToken - Session authentication token. (required)
      userId - user Id (required)
      Returns:
      ApiResponse<UserConnection>
      Throws:
      com.symphony.bdk.http.api.ApiException - if fails to make API call