org.symphonyoss.symphony.pod.api

Class ConnectionApi

java.lang.Object

org.symphonyoss.symphony.pod.api.ConnectionApi

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-12-17T23:29:05.070-05:00")
public class ConnectionApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ConnectionApi()
ConnectionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
UserConnection	v1ConnectionAcceptPost(String sessionToken, UserConnectionRequest connectionRequest) Accept the connection request for the requesting user
UserConnection	v1ConnectionCreatePost(String sessionToken, UserConnectionRequest connectionRequest) Sends an invitation to connect with another user
UserConnectionList	v1ConnectionListGet(String sessionToken, String status, String userIds) List of requesting user's connection This retrieves all connections of the requesting user.
UserConnection	v1ConnectionRejectPost(String sessionToken, UserConnectionRequest connectionRequest) Reject the connection request for the requesting user.
SuccessResponse	v1ConnectionUserUidRemovePost(String sessionToken, Long uid) Removes a connection with a user.
UserConnection	v1ConnectionUserUserIdInfoGet(String sessionToken, String userId) The status of the connection invitation to another user.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectionApi

public ConnectionApi()

ConnectionApi

public ConnectionApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

v1ConnectionAcceptPost

public UserConnection v1ConnectionAcceptPost(String sessionToken,
                                             UserConnectionRequest connectionRequest)
                                      throws ApiException

Accept the connection request for the requesting user

Parameters:

sessionToken - Session authentication token. (required)

connectionRequest - (required)

Returns:

UserConnection

Throws:

ApiException - if fails to make API call

v1ConnectionCreatePost

public UserConnection v1ConnectionCreatePost(String sessionToken,
                                             UserConnectionRequest connectionRequest)
                                      throws ApiException

Sends an invitation to connect with another user

Parameters:

sessionToken - Session authentication token. (required)

connectionRequest - (required)

Returns:

UserConnection

Throws:

ApiException - if fails to make API call

v1ConnectionListGet

public UserConnectionList v1ConnectionListGet(String sessionToken,
                                              String status,
                                              String userIds)
                                       throws 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:

UserConnectionList

Throws:

ApiException - if fails to make API call

v1ConnectionRejectPost

public UserConnection v1ConnectionRejectPost(String sessionToken,
                                             UserConnectionRequest connectionRequest)
                                      throws 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:

ApiException - if fails to make API call

v1ConnectionUserUidRemovePost

public SuccessResponse v1ConnectionUserUidRemovePost(String sessionToken,
                                                     Long uid)
                                              throws ApiException

Removes a connection with a user.

Parameters:

sessionToken - Session authentication token. (required)

uid - User ID as a decimal integer (required)

Returns:

SuccessResponse

Throws:

ApiException - if fails to make API call

v1ConnectionUserUserIdInfoGet

public UserConnection v1ConnectionUserUserIdInfoGet(String sessionToken,
                                                    String userId)
                                             throws ApiException

The status of the connection invitation to another user.

Parameters:

sessionToken - Session authentication token. (required)

userId - user Id (required)

Returns:

UserConnection

Throws:

ApiException - if fails to make API call