Package com.symphony.bdk.gen.api
Class RoomMembershipApi
java.lang.Object
com.symphony.bdk.gen.api.RoomMembershipApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2024-03-05T16:31:00.394426599Z[Etc/UTC]")
public class RoomMembershipApi
extends Object
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncom.symphony.bdk.http.api.ApiClient
Get the API cilentvoid
setApiClient
(com.symphony.bdk.http.api.ApiClient apiClient) Set the API cilentv1AdminRoomIdMembershipAddPost
(String id, String sessionToken, UserId payload) Add a member to an existing room.com.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1AdminRoomIdMembershipAddPostWithHttpInfo
(String id, String sessionToken, UserId payload) Add a member to an existing room.v1AdminRoomIdMembershipListGet
(String id, String sessionToken, Boolean includePastMembers) Lists current and previous members of an existing room.com.symphony.bdk.http.api.ApiResponse<List<MemberInfo>>
v1AdminRoomIdMembershipListGetWithHttpInfo
(String id, String sessionToken, Boolean includePastMembers) Lists current and previous members of an existing room.v1AdminRoomIdMembershipRemovePost
(String id, String sessionToken, UserId payload) Remove a member from a room.com.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1AdminRoomIdMembershipRemovePostWithHttpInfo
(String id, String sessionToken, UserId payload) Remove a member from a room.v1RoomIdMembershipAddPost
(String id, String sessionToken, UserId payload) Adds new member to an existing room.com.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1RoomIdMembershipAddPostWithHttpInfo
(String id, String sessionToken, UserId payload) Adds new member to an existing room.v1RoomIdMembershipDemoteOwnerPost
(String id, String sessionToken, UserId payload) Demotes room owner.com.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1RoomIdMembershipDemoteOwnerPostWithHttpInfo
(String id, String sessionToken, UserId payload) Demotes room owner.v1RoomIdMembershipListGet
(String id, String sessionToken) Deprecated.com.symphony.bdk.http.api.ApiResponse<List<MemberInfo>>
v1RoomIdMembershipListGetWithHttpInfo
(String id, String sessionToken) Deprecated.v1RoomIdMembershipPromoteOwnerPost
(String id, String sessionToken, UserId payload) Promotes user to owner.com.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1RoomIdMembershipPromoteOwnerPostWithHttpInfo
(String id, String sessionToken, UserId payload) Promotes user to owner.v1RoomIdMembershipRemovePost
(String id, String sessionToken, UserId payload) Removes member from an existing room.com.symphony.bdk.http.api.ApiResponse<SuccessResponse>
v1RoomIdMembershipRemovePostWithHttpInfo
(String id, String sessionToken, UserId payload) Removes member from an existing room.v2RoomIdMembershipListGet
(String id, String sessionToken) Lists current members of an existing room.com.symphony.bdk.http.api.ApiResponse<List<MemberInfo>>
v2RoomIdMembershipListGetWithHttpInfo
(String id, String sessionToken) Lists current members of an existing room.
-
Constructor Details
-
RoomMembershipApi
public RoomMembershipApi(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
-
v1AdminRoomIdMembershipAddPost
public SuccessResponse v1AdminRoomIdMembershipAddPost(String id, 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(String id, 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 List<MemberInfo> v1AdminRoomIdMembershipListGet(String id, String sessionToken, 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<List<MemberInfo>> v1AdminRoomIdMembershipListGetWithHttpInfo(String id, String sessionToken, 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(String id, 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(String id, 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(String id, 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(String id, 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(String id, 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(String id, 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 List<MemberInfo> v1RoomIdMembershipListGet(String id, 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<List<MemberInfo>> v1RoomIdMembershipListGetWithHttpInfo(String id, 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(String id, 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(String id, 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(String id, 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(String id, 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 List<MemberInfo> v2RoomIdMembershipListGet(String id, 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<List<MemberInfo>> v2RoomIdMembershipListGetWithHttpInfo(String id, 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
-