azure-docs-sdk-java/docs-ref-autogen/com.azure.communication.rooms.RoomsAsyncClient.yml

### YamlMime:JavaType
uid: "com.azure.communication.rooms.RoomsAsyncClient"
fullName: "com.azure.communication.rooms.RoomsAsyncClient"
name: "RoomsAsyncClient"
nameWithType: "RoomsAsyncClient"
summary: "The Async client for Rooms of Azure Communication Room Service"
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **RoomsAsyncClient**"
methods:
- uid: "com.azure.communication.rooms.RoomsAsyncClient.addOrUpdateParticipants(java.lang.String,java.lang.Iterable<com.azure.communication.rooms.models.RoomParticipant>)"
  fullName: "com.azure.communication.rooms.RoomsAsyncClient.addOrUpdateParticipants(String roomId, Iterable<RoomParticipant> participants)"
  name: "addOrUpdateParticipants(String roomId, Iterable<RoomParticipant> participants)"
  nameWithType: "RoomsAsyncClient.addOrUpdateParticipants(String roomId, Iterable<RoomParticipant> participants)"
  summary: "Add or update participants to an existing Room."
  parameters:
  - description: "The room id."
    name: "roomId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The participants list."
    name: "participants"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a>&lt;<xref href=\"com.azure.communication.rooms.models.RoomParticipant?alt=com.azure.communication.rooms.models.RoomParticipant&text=RoomParticipant\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public Mono<AddOrUpdateParticipantsResult> addOrUpdateParticipants(String roomId, Iterable<RoomParticipant> participants)"
  desc: "Add or update participants to an existing Room."
  returns:
    description: "response for a successful add or update participants room request."
    type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.communication.rooms.models.AddOrUpdateParticipantsResult?alt=com.azure.communication.rooms.models.AddOrUpdateParticipantsResult&text=AddOrUpdateParticipantsResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.communication.rooms.RoomsAsyncClient.addOrUpdateParticipantsWithResponse(java.lang.String,java.lang.Iterable<com.azure.communication.rooms.models.RoomParticipant>)"
  fullName: "com.azure.communication.rooms.RoomsAsyncClient.addOrUpdateParticipantsWithResponse(String roomId, Iterable<RoomParticipant> participants)"
  name: "addOrUpdateParticipantsWithResponse(String roomId, Iterable<RoomParticipant> participants)"
  nameWithType: "RoomsAsyncClient.addOrUpdateParticipantsWithResponse(String roomId, Iterable<RoomParticipant> participants)"
  summary: "Add or update participants to an existing Room with response"
  parameters:
  - description: "The room id."
    name: "roomId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The participants list."
    name: "participants"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a>&lt;<xref href=\"com.azure.communication.rooms.models.RoomParticipant?alt=com.azure.communication.rooms.models.RoomParticipant&text=RoomParticipant\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public Mono<Response<AddOrUpdateParticipantsResult>> addOrUpdateParticipantsWithResponse(String roomId, Iterable<RoomParticipant> participants)"
  desc: "Add or update participants to an existing Room with response"
  returns:
    description: "response for a successful add or update participants room request."
    type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.communication.rooms.models.AddOrUpdateParticipantsResult?alt=com.azure.communication.rooms.models.AddOrUpdateParticipantsResult&text=AddOrUpdateParticipantsResult\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.communication.rooms.RoomsAsyncClient.createRoom(com.azure.communication.rooms.models.CreateRoomOptions)"
  fullName: "com.azure.communication.rooms.RoomsAsyncClient.createRoom(CreateRoomOptions createRoomOptions)"
  name: "createRoom(CreateRoomOptions createRoomOptions)"
  nameWithType: "RoomsAsyncClient.createRoom(CreateRoomOptions createRoomOptions)"
  summary: "Create a new Room, input field is nullable."
  parameters:
  - description: "the create room options."
    name: "createRoomOptions"
    type: "<xref href=\"com.azure.communication.rooms.models.CreateRoomOptions?alt=com.azure.communication.rooms.models.CreateRoomOptions&text=CreateRoomOptions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Mono<CommunicationRoom> createRoom(CreateRoomOptions createRoomOptions)"
  desc: "Create a new Room, input field is nullable."
  returns:
    description: "response for a successful create room request."
    type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.communication.rooms.models.CommunicationRoom?alt=com.azure.communication.rooms.models.CommunicationRoom&text=CommunicationRoom\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.communication.rooms.RoomsAsyncClient.createRoomWithResponse(com.azure.communication.rooms.models.CreateRoomOptions)"
  fullName: "com.azure.communication.rooms.RoomsAsyncClient.createRoomWithResponse(CreateRoomOptions createRoomOptions)"
  name: "createRoomWithResponse(CreateRoomOptions createRoomOptions)"
  nameWithType: "RoomsAsyncClient.createRoomWithResponse(CreateRoomOptions createRoomOptions)"
  summary: "Create a new Room, input field is nullable."
  parameters:
  - description: "the create room options."
    name: "createRoomOptions"
    type: "<xref href=\"com.azure.communication.rooms.models.CreateRoomOptions?alt=com.azure.communication.rooms.models.CreateRoomOptions&text=CreateRoomOptions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Mono<Response<CommunicationRoom>> createRoomWithResponse(CreateRoomOptions createRoomOptions)"
  desc: "Create a new Room, input field is nullable."
  returns:
    description: "response for a successful create room request."
    type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.communication.rooms.models.CommunicationRoom?alt=com.azure.communication.rooms.models.CommunicationRoom&text=CommunicationRoom\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.communication.rooms.RoomsAsyncClient.deleteRoom(java.lang.String)"
  fullName: "com.azure.communication.rooms.RoomsAsyncClient.deleteRoom(String roomId)"
  name: "deleteRoom(String roomId)"
  nameWithType: "RoomsAsyncClient.deleteRoom(String roomId)"
  summary: "Delete an existing room."
  parameters:
  - description: "The room Id."
    name: "roomId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public Mono<Void> deleteRoom(String roomId)"
  desc: "Delete an existing room."
  returns:
    description: "The response with status code."
    type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.communication.rooms.RoomsAsyncClient.deleteRoomWithResponse(java.lang.String)"
  fullName: "com.azure.communication.rooms.RoomsAsyncClient.deleteRoomWithResponse(String roomId)"
  name: "deleteRoomWithResponse(String roomId)"
  nameWithType: "RoomsAsyncClient.deleteRoomWithResponse(String roomId)"
  summary: "Delete a existing room."
  parameters:
  - description: "The room Id."
    name: "roomId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public Mono<Response<Void>> deleteRoomWithResponse(String roomId)"
  desc: "Delete a existing room."
  returns:
    description: "The response with status code."
    type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;&gt;"
- uid: "com.azure.communication.rooms.RoomsAsyncClient.getRoom(java.lang.String)"
  fullName: "com.azure.communication.rooms.RoomsAsyncClient.getRoom(String roomId)"
  name: "getRoom(String roomId)"
  nameWithType: "RoomsAsyncClient.getRoom(String roomId)"
  summary: "Get an existing room."
  parameters:
  - description: "The room Id."
    name: "roomId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public Mono<CommunicationRoom> getRoom(String roomId)"
  desc: "Get an existing room."
  returns:
    description: "The existing room."
    type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.communication.rooms.models.CommunicationRoom?alt=com.azure.communication.rooms.models.CommunicationRoom&text=CommunicationRoom\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.communication.rooms.RoomsAsyncClient.getRoomWithResponse(java.lang.String)"
  fullName: "com.azure.communication.rooms.RoomsAsyncClient.getRoomWithResponse(String roomId)"
  name: "getRoomWithResponse(String roomId)"
  nameWithType: "RoomsAsyncClient.getRoomWithResponse(String roomId)"
  summary: "Get an existing room with response."
  parameters:
  - description: "The room Id."
    name: "roomId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public Mono<Response<CommunicationRoom>> getRoomWithResponse(String roomId)"
  desc: "Get an existing room with response."
  returns:
    description: "The existing room."
    type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.communication.rooms.models.CommunicationRoom?alt=com.azure.communication.rooms.models.CommunicationRoom&text=CommunicationRoom\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.communication.rooms.RoomsAsyncClient.listParticipants(java.lang.String)"
  fullName: "com.azure.communication.rooms.RoomsAsyncClient.listParticipants(String roomId)"
  name: "listParticipants(String roomId)"
  nameWithType: "RoomsAsyncClient.listParticipants(String roomId)"
  summary: "Get a room participants."
  parameters:
  - description: "The room Id."
    name: "roomId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public PagedFlux<RoomParticipant> listParticipants(String roomId)"
  desc: "Get a room participants."
  returns:
    description: "The existing room."
    type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.communication.rooms.models.RoomParticipant?alt=com.azure.communication.rooms.models.RoomParticipant&text=RoomParticipant\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.communication.rooms.RoomsAsyncClient.listRooms()"
  fullName: "com.azure.communication.rooms.RoomsAsyncClient.listRooms()"
  name: "listRooms()"
  nameWithType: "RoomsAsyncClient.listRooms()"
  summary: "Lists all rooms."
  syntax: "public PagedFlux<CommunicationRoom> listRooms()"
  desc: "Lists all rooms."
  returns:
    description: "The existing rooms."
    type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.communication.rooms.models.CommunicationRoom?alt=com.azure.communication.rooms.models.CommunicationRoom&text=CommunicationRoom\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.communication.rooms.RoomsAsyncClient.removeParticipants(java.lang.String,java.lang.Iterable<com.azure.communication.common.CommunicationIdentifier>)"
  fullName: "com.azure.communication.rooms.RoomsAsyncClient.removeParticipants(String roomId, Iterable<CommunicationIdentifier> participantsIdentifiers)"
  name: "removeParticipants(String roomId, Iterable<CommunicationIdentifier> participantsIdentifiers)"
  nameWithType: "RoomsAsyncClient.removeParticipants(String roomId, Iterable<CommunicationIdentifier> participantsIdentifiers)"
  summary: "Remove participants from an existing Room."
  parameters:
  - description: "The room id."
    name: "roomId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The communication identifier list."
    name: "participantsIdentifiers"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a>&lt;<xref href=\"com.azure.communication.common.CommunicationIdentifier?alt=com.azure.communication.common.CommunicationIdentifier&text=CommunicationIdentifier\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public Mono<RemoveParticipantsResult> removeParticipants(String roomId, Iterable<CommunicationIdentifier> participantsIdentifiers)"
  desc: "Remove participants from an existing Room."
  returns:
    description: "response for a successful add participants room request."
    type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.communication.rooms.models.RemoveParticipantsResult?alt=com.azure.communication.rooms.models.RemoveParticipantsResult&text=RemoveParticipantsResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.communication.rooms.RoomsAsyncClient.removeParticipantsWithResponse(java.lang.String,java.lang.Iterable<com.azure.communication.common.CommunicationIdentifier>)"
  fullName: "com.azure.communication.rooms.RoomsAsyncClient.removeParticipantsWithResponse(String roomId, Iterable<CommunicationIdentifier> participantsIdentifiers)"
  name: "removeParticipantsWithResponse(String roomId, Iterable<CommunicationIdentifier> participantsIdentifiers)"
  nameWithType: "RoomsAsyncClient.removeParticipantsWithResponse(String roomId, Iterable<CommunicationIdentifier> participantsIdentifiers)"
  summary: "Remove participants from an existing Room with response."
  parameters:
  - description: "The room id."
    name: "roomId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The communication identifier list."
    name: "participantsIdentifiers"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a>&lt;<xref href=\"com.azure.communication.common.CommunicationIdentifier?alt=com.azure.communication.common.CommunicationIdentifier&text=CommunicationIdentifier\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public Mono<Response<RemoveParticipantsResult>> removeParticipantsWithResponse(String roomId, Iterable<CommunicationIdentifier> participantsIdentifiers)"
  desc: "Remove participants from an existing Room with response."
  returns:
    description: "response for a successful add participants room request."
    type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.communication.rooms.models.RemoveParticipantsResult?alt=com.azure.communication.rooms.models.RemoveParticipantsResult&text=RemoveParticipantsResult\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.communication.rooms.RoomsAsyncClient.updateRoom(java.lang.String,com.azure.communication.rooms.models.UpdateRoomOptions)"
  fullName: "com.azure.communication.rooms.RoomsAsyncClient.updateRoom(String roomId, UpdateRoomOptions updateRoomOptions)"
  name: "updateRoom(String roomId, UpdateRoomOptions updateRoomOptions)"
  nameWithType: "RoomsAsyncClient.updateRoom(String roomId, UpdateRoomOptions updateRoomOptions)"
  summary: "Update an existing Room."
  parameters:
  - description: "The room Id."
    name: "roomId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The update room options."
    name: "updateRoomOptions"
    type: "<xref href=\"com.azure.communication.rooms.models.UpdateRoomOptions?alt=com.azure.communication.rooms.models.UpdateRoomOptions&text=UpdateRoomOptions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Mono<CommunicationRoom> updateRoom(String roomId, UpdateRoomOptions updateRoomOptions)"
  desc: "Update an existing Room."
  returns:
    description: "response for a successful update room request."
    type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.communication.rooms.models.CommunicationRoom?alt=com.azure.communication.rooms.models.CommunicationRoom&text=CommunicationRoom\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.communication.rooms.RoomsAsyncClient.updateRoomWithResponse(java.lang.String,com.azure.communication.rooms.models.UpdateRoomOptions)"
  fullName: "com.azure.communication.rooms.RoomsAsyncClient.updateRoomWithResponse(String roomId, UpdateRoomOptions updateRoomOptions)"
  name: "updateRoomWithResponse(String roomId, UpdateRoomOptions updateRoomOptions)"
  nameWithType: "RoomsAsyncClient.updateRoomWithResponse(String roomId, UpdateRoomOptions updateRoomOptions)"
  summary: "Update an existing room with response."
  parameters:
  - description: "The room Id."
    name: "roomId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The update room options."
    name: "updateRoomOptions"
    type: "<xref href=\"com.azure.communication.rooms.models.UpdateRoomOptions?alt=com.azure.communication.rooms.models.UpdateRoomOptions&text=UpdateRoomOptions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public Mono<Response<CommunicationRoom>> updateRoomWithResponse(String roomId, UpdateRoomOptions updateRoomOptions)"
  desc: "Update an existing room with response."
  returns:
    description: "response for a successful update room request."
    type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.communication.rooms.models.CommunicationRoom?alt=com.azure.communication.rooms.models.CommunicationRoom&text=CommunicationRoom\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
type: "class"
desc: "The Async client for Rooms of Azure Communication Room Service\n\n**Instantiating an asynchronous Room Client**\n\n```java\nRoomsAsyncClient roomsClient = new RoomsClientBuilder()\n      .endpoint(endpoint)\n      .credential(azureKeyCredential)\n      .buildAsyncClient();\n```"
metadata: {}
package: "com.azure.communication.rooms"
artifact: com.azure:azure-communication-rooms:1.1.7