org.symphonyoss.symphony.pod.api

Class RoomMembershipApi

java.lang.Object

org.symphonyoss.symphony.pod.api.RoomMembershipApi

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2018-01-28T11:18:17.901-05:00")
public class RoomMembershipApi
extends Object

Constructor Summary

Constructors

Constructor and Description
RoomMembershipApi()
RoomMembershipApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
void	setApiClient(ApiClient apiClient)
SuccessResponse	v1AdminRoomIdMembershipAddPost(String id, UserId payload, String sessionToken) Add a member to an existing room.
MembershipList	v1AdminRoomIdMembershipListGet(String id, String sessionToken, Boolean includePastMembers) Lists current and previous members of an existing room.
SuccessResponse	v1AdminRoomIdMembershipRemovePost(String id, UserId payload, String sessionToken) Remove a member from a room.
SuccessResponse	v1RoomIdMembershipAddPost(String id, UserId payload, String sessionToken) Adds new member to an existing room.
SuccessResponse	v1RoomIdMembershipDemoteOwnerPost(String id, UserId payload, String sessionToken) Demotes room owner.
MembershipList	v1RoomIdMembershipListGet(String id, String sessionToken) Lists the members of an existing room.
SuccessResponse	v1RoomIdMembershipPromoteOwnerPost(String id, UserId payload, String sessionToken) Promotes user to owner.
SuccessResponse	v1RoomIdMembershipRemovePost(String id, UserId payload, String sessionToken) Removes member from an existing room.
MembershipList	v2RoomIdMembershipListGet(String id, 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()

RoomMembershipApi

public RoomMembershipApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

v1AdminRoomIdMembershipAddPost

public SuccessResponse v1AdminRoomIdMembershipAddPost(String id,
                                                      UserId payload,
                                                      String sessionToken)
                                               throws ApiException

Add a member to an existing room.

Parameters:

id - Room streamId (required)

payload - (required)

sessionToken - Session authentication token. (required)

Returns:

SuccessResponse

Throws:

ApiException - if fails to make API call

v1AdminRoomIdMembershipListGet

public MembershipList v1AdminRoomIdMembershipListGet(String id,
                                                     String sessionToken,
                                                     Boolean includePastMembers)
                                              throws 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:

MembershipList

Throws:

ApiException - if fails to make API call

v1AdminRoomIdMembershipRemovePost

public SuccessResponse v1AdminRoomIdMembershipRemovePost(String id,
                                                         UserId payload,
                                                         String sessionToken)
                                                  throws ApiException

Remove a member from a room.

Parameters:

id - Room streamId (required)

payload - (required)

sessionToken - Session authentication token. (required)

Returns:

SuccessResponse

Throws:

ApiException - if fails to make API call

v1RoomIdMembershipAddPost

public SuccessResponse v1RoomIdMembershipAddPost(String id,
                                                 UserId payload,
                                                 String sessionToken)
                                          throws ApiException

Adds new member to an existing room.

Parameters:

id - Room streamId (required)

payload - (required)

sessionToken - Session authentication token. (required)

Returns:

SuccessResponse

Throws:

ApiException - if fails to make API call

v1RoomIdMembershipDemoteOwnerPost

public SuccessResponse v1RoomIdMembershipDemoteOwnerPost(String id,
                                                         UserId payload,
                                                         String sessionToken)
                                                  throws ApiException

Demotes room owner.

Parameters:

id - Room streamId (required)

payload - (required)

sessionToken - Session authentication token. (required)

Returns:

SuccessResponse

Throws:

ApiException - if fails to make API call

v1RoomIdMembershipListGet

public MembershipList v1RoomIdMembershipListGet(String id,
                                                String sessionToken)
                                         throws ApiException

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:

MembershipList

Throws:

ApiException - if fails to make API call

v1RoomIdMembershipPromoteOwnerPost

public SuccessResponse v1RoomIdMembershipPromoteOwnerPost(String id,
                                                          UserId payload,
                                                          String sessionToken)
                                                   throws ApiException

Promotes user to owner.

Parameters:

id - Room streamId (required)

payload - (required)

sessionToken - Session authentication token. (required)

Returns:

SuccessResponse

Throws:

ApiException - if fails to make API call

v1RoomIdMembershipRemovePost

public SuccessResponse v1RoomIdMembershipRemovePost(String id,
                                                    UserId payload,
                                                    String sessionToken)
                                             throws ApiException

Removes member from an existing room.

Parameters:

id - Room streamId (required)

payload - (required)

sessionToken - Session authentication token. (required)

Returns:

SuccessResponse

Throws:

ApiException - if fails to make API call

v2RoomIdMembershipListGet

public MembershipList v2RoomIdMembershipListGet(String id,
                                                String sessionToken)
                                         throws ApiException

Lists current members of an existing room.

Parameters:

id - Room streamId (required)

sessionToken - Session authentication token. (required)

Returns:

MembershipList

Throws:

ApiException - if fails to make API call