com.symphony.bdk.gen.api

Class RoomMembershipApi

java.lang.Object

com.symphony.bdk.gen.api.RoomMembershipApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-02-19T08:46:08.823+01:00[Europe/Paris]")
public class RoomMembershipApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
RoomMembershipApi(com.symphony.bdk.http.api.ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
com.symphony.bdk.http.api.ApiClient	getApiClient() Get the API cilent
SuccessResponse	v1AdminRoomIdMembershipAddPost(java.lang.String id, java.lang.String sessionToken, UserId payload) Add a member to an existing room.
com.symphony.bdk.http.api.ApiResponse<SuccessResponse>	v1AdminRoomIdMembershipAddPostWithHttpInfo(java.lang.String id, java.lang.String sessionToken, UserId payload) Add a member to an existing room.
java.util.List<MemberInfo>	v1AdminRoomIdMembershipListGet(java.lang.String id, java.lang.String sessionToken, java.lang.Boolean includePastMembers) Lists current and previous members of an existing room.
com.symphony.bdk.http.api.ApiResponse<java.util.List<MemberInfo>>	v1AdminRoomIdMembershipListGetWithHttpInfo(java.lang.String id, java.lang.String sessionToken, java.lang.Boolean includePastMembers) Lists current and previous members of an existing room.
SuccessResponse	v1AdminRoomIdMembershipRemovePost(java.lang.String id, java.lang.String sessionToken, UserId payload) Remove a member from a room.
com.symphony.bdk.http.api.ApiResponse<SuccessResponse>	v1AdminRoomIdMembershipRemovePostWithHttpInfo(java.lang.String id, java.lang.String sessionToken, UserId payload) Remove a member from a room.
SuccessResponse	v1RoomIdMembershipAddPost(java.lang.String id, java.lang.String sessionToken, UserId payload) Adds new member to an existing room.
com.symphony.bdk.http.api.ApiResponse<SuccessResponse>	v1RoomIdMembershipAddPostWithHttpInfo(java.lang.String id, java.lang.String sessionToken, UserId payload) Adds new member to an existing room.
SuccessResponse	v1RoomIdMembershipDemoteOwnerPost(java.lang.String id, java.lang.String sessionToken, UserId payload) Demotes room owner.
com.symphony.bdk.http.api.ApiResponse<SuccessResponse>	v1RoomIdMembershipDemoteOwnerPostWithHttpInfo(java.lang.String id, java.lang.String sessionToken, UserId payload) Demotes room owner.
java.util.List<MemberInfo>	v1RoomIdMembershipListGet(java.lang.String id, java.lang.String sessionToken) Deprecated.
com.symphony.bdk.http.api.ApiResponse<java.util.List<MemberInfo>>	v1RoomIdMembershipListGetWithHttpInfo(java.lang.String id, java.lang.String sessionToken) Deprecated.
SuccessResponse	v1RoomIdMembershipPromoteOwnerPost(java.lang.String id, java.lang.String sessionToken, UserId payload) Promotes user to owner.
com.symphony.bdk.http.api.ApiResponse<SuccessResponse>	v1RoomIdMembershipPromoteOwnerPostWithHttpInfo(java.lang.String id, java.lang.String sessionToken, UserId payload) Promotes user to owner.
SuccessResponse	v1RoomIdMembershipRemovePost(java.lang.String id, java.lang.String sessionToken, UserId payload) Removes member from an existing room.
com.symphony.bdk.http.api.ApiResponse<SuccessResponse>	v1RoomIdMembershipRemovePostWithHttpInfo(java.lang.String id, java.lang.String sessionToken, UserId payload) Removes member from an existing room.
java.util.List<MemberInfo>	v2RoomIdMembershipListGet(java.lang.String id, java.lang.String sessionToken) Lists current members of an existing room.
com.symphony.bdk.http.api.ApiResponse<java.util.List<MemberInfo>>	v2RoomIdMembershipListGetWithHttpInfo(java.lang.String id, java.lang.String sessionToken) Lists current members of an existing room.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoomMembershipApi

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

Method Detail

getApiClient

public com.symphony.bdk.http.api.ApiClient getApiClient()

Get the API cilent

Returns:

API client

v1AdminRoomIdMembershipAddPost

public SuccessResponse v1AdminRoomIdMembershipAddPost(java.lang.String id,
                                                      java.lang.String sessionToken,
                                                      UserId payload)
                                               throws com.symphony.bdk.http.api.ApiException

Add a member to an existing room.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

SuccessResponse

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1AdminRoomIdMembershipAddPostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1AdminRoomIdMembershipAddPostWithHttpInfo(java.lang.String id,
                                                                                                         java.lang.String sessionToken,
                                                                                                         UserId payload)
                                                                                                  throws com.symphony.bdk.http.api.ApiException

Add a member to an existing room.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

ApiResponse<SuccessResponse>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1AdminRoomIdMembershipListGet

public java.util.List<MemberInfo> v1AdminRoomIdMembershipListGet(java.lang.String id,
                                                                 java.lang.String sessionToken,
                                                                 java.lang.Boolean includePastMembers)
                                                          throws com.symphony.bdk.http.api.ApiException

Lists current and previous members of an existing room.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

includePastMembers - If true, the membership list will include past members of the stream. If false, the listing will only incude current members. Default false. (optional)

Returns:

List<MemberInfo>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1AdminRoomIdMembershipListGetWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<java.util.List<MemberInfo>> v1AdminRoomIdMembershipListGetWithHttpInfo(java.lang.String id,
                                                                                                                    java.lang.String sessionToken,
                                                                                                                    java.lang.Boolean includePastMembers)
                                                                                                             throws com.symphony.bdk.http.api.ApiException

Lists current and previous members of an existing room.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

includePastMembers - If true, the membership list will include past members of the stream. If false, the listing will only incude current members. Default false. (optional)

Returns:

ApiResponse<List<MemberInfo>>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1AdminRoomIdMembershipRemovePost

public SuccessResponse v1AdminRoomIdMembershipRemovePost(java.lang.String id,
                                                         java.lang.String sessionToken,
                                                         UserId payload)
                                                  throws com.symphony.bdk.http.api.ApiException

Remove a member from a room.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

SuccessResponse

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1AdminRoomIdMembershipRemovePostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1AdminRoomIdMembershipRemovePostWithHttpInfo(java.lang.String id,
                                                                                                            java.lang.String sessionToken,
                                                                                                            UserId payload)
                                                                                                     throws com.symphony.bdk.http.api.ApiException

Remove a member from a room.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

ApiResponse<SuccessResponse>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1RoomIdMembershipAddPost

public SuccessResponse v1RoomIdMembershipAddPost(java.lang.String id,
                                                 java.lang.String sessionToken,
                                                 UserId payload)
                                          throws com.symphony.bdk.http.api.ApiException

Adds new member to an existing room.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

SuccessResponse

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1RoomIdMembershipAddPostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1RoomIdMembershipAddPostWithHttpInfo(java.lang.String id,
                                                                                                    java.lang.String sessionToken,
                                                                                                    UserId payload)
                                                                                             throws com.symphony.bdk.http.api.ApiException

Adds new member to an existing room.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

ApiResponse<SuccessResponse>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1RoomIdMembershipDemoteOwnerPost

public SuccessResponse v1RoomIdMembershipDemoteOwnerPost(java.lang.String id,
                                                         java.lang.String sessionToken,
                                                         UserId payload)
                                                  throws com.symphony.bdk.http.api.ApiException

Demotes room owner.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

SuccessResponse

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1RoomIdMembershipDemoteOwnerPostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1RoomIdMembershipDemoteOwnerPostWithHttpInfo(java.lang.String id,
                                                                                                            java.lang.String sessionToken,
                                                                                                            UserId payload)
                                                                                                     throws com.symphony.bdk.http.api.ApiException

Demotes room owner.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

ApiResponse<SuccessResponse>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1RoomIdMembershipListGet

@Deprecated
public java.util.List<MemberInfo> v1RoomIdMembershipListGet(java.lang.String id,
                                                                        java.lang.String sessionToken)
                                                                 throws com.symphony.bdk.http.api.ApiException

Deprecated.

Lists the members of an existing room. Lists the members of an existing room. If the requesting user is an administrator, lists current and previous members. If the requesting user is a regular user, lists only current members.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

Returns:

List<MemberInfo>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1RoomIdMembershipListGetWithHttpInfo

@Deprecated
public com.symphony.bdk.http.api.ApiResponse<java.util.List<MemberInfo>> v1RoomIdMembershipListGetWithHttpInfo(java.lang.String id,
                                                                                                                           java.lang.String sessionToken)
                                                                                                                    throws com.symphony.bdk.http.api.ApiException

Deprecated.

Lists the members of an existing room. Lists the members of an existing room. If the requesting user is an administrator, lists current and previous members. If the requesting user is a regular user, lists only current members.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

Returns:

ApiResponse<List<MemberInfo>>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1RoomIdMembershipPromoteOwnerPost

public SuccessResponse v1RoomIdMembershipPromoteOwnerPost(java.lang.String id,
                                                          java.lang.String sessionToken,
                                                          UserId payload)
                                                   throws com.symphony.bdk.http.api.ApiException

Promotes user to owner.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

SuccessResponse

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1RoomIdMembershipPromoteOwnerPostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1RoomIdMembershipPromoteOwnerPostWithHttpInfo(java.lang.String id,
                                                                                                             java.lang.String sessionToken,
                                                                                                             UserId payload)
                                                                                                      throws com.symphony.bdk.http.api.ApiException

Promotes user to owner.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

ApiResponse<SuccessResponse>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1RoomIdMembershipRemovePost

public SuccessResponse v1RoomIdMembershipRemovePost(java.lang.String id,
                                                    java.lang.String sessionToken,
                                                    UserId payload)
                                             throws com.symphony.bdk.http.api.ApiException

Removes member from an existing room.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

SuccessResponse

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v1RoomIdMembershipRemovePostWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<SuccessResponse> v1RoomIdMembershipRemovePostWithHttpInfo(java.lang.String id,
                                                                                                       java.lang.String sessionToken,
                                                                                                       UserId payload)
                                                                                                throws com.symphony.bdk.http.api.ApiException

Removes member from an existing room.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

payload - (required)

Returns:

ApiResponse<SuccessResponse>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v2RoomIdMembershipListGet

public java.util.List<MemberInfo> v2RoomIdMembershipListGet(java.lang.String id,
                                                            java.lang.String sessionToken)
                                                     throws com.symphony.bdk.http.api.ApiException

Lists current members of an existing room.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

Returns:

List<MemberInfo>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call

v2RoomIdMembershipListGetWithHttpInfo

public com.symphony.bdk.http.api.ApiResponse<java.util.List<MemberInfo>> v2RoomIdMembershipListGetWithHttpInfo(java.lang.String id,
                                                                                                               java.lang.String sessionToken)
                                                                                                        throws com.symphony.bdk.http.api.ApiException

Lists current members of an existing room.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

Returns:

ApiResponse<List<MemberInfo>>

Throws:

com.symphony.bdk.http.api.ApiException - if fails to make API call