286 строки
23 KiB
YAML
286 строки
23 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.communication.rooms.RoomsClient"
|
|
fullName: "com.azure.communication.rooms.RoomsClient"
|
|
name: "RoomsClient"
|
|
nameWithType: "RoomsClient"
|
|
summary: "Client for Rooms operations 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 **RoomsClient**"
|
|
methods:
|
|
- uid: "com.azure.communication.rooms.RoomsClient.addOrUpdateParticipants(java.lang.String,java.lang.Iterable<com.azure.communication.rooms.models.RoomParticipant>)"
|
|
fullName: "com.azure.communication.rooms.RoomsClient.addOrUpdateParticipants(String roomId, Iterable<RoomParticipant> participants)"
|
|
name: "addOrUpdateParticipants(String roomId, Iterable<RoomParticipant> participants)"
|
|
nameWithType: "RoomsClient.addOrUpdateParticipants(String roomId, Iterable<RoomParticipant> participants)"
|
|
summary: "add<wbr>OrUpdate 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><<xref href=\"com.azure.communication.rooms.models.RoomParticipant?alt=com.azure.communication.rooms.models.RoomParticipant&text=RoomParticipant\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public AddOrUpdateParticipantsResult addOrUpdateParticipants(String roomId, Iterable<RoomParticipant> participants)"
|
|
desc: "addOrUpdate participants to an existing Room."
|
|
returns:
|
|
description: "response for a successful addOrUpdate participants room request."
|
|
type: "<xref href=\"com.azure.communication.rooms.models.AddOrUpdateParticipantsResult?alt=com.azure.communication.rooms.models.AddOrUpdateParticipantsResult&text=AddOrUpdateParticipantsResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.rooms.RoomsClient.addOrUpdateParticipantsWithResponse(java.lang.String,java.lang.Iterable<com.azure.communication.rooms.models.RoomParticipant>,com.azure.core.util.Context)"
|
|
fullName: "com.azure.communication.rooms.RoomsClient.addOrUpdateParticipantsWithResponse(String roomId, Iterable<RoomParticipant> participants, Context context)"
|
|
name: "addOrUpdateParticipantsWithResponse(String roomId, Iterable<RoomParticipant> participants, Context context)"
|
|
nameWithType: "RoomsClient.addOrUpdateParticipantsWithResponse(String roomId, Iterable<RoomParticipant> participants, Context context)"
|
|
summary: "add<wbr>OrUpdate 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><<xref href=\"com.azure.communication.rooms.models.RoomParticipant?alt=com.azure.communication.rooms.models.RoomParticipant&text=RoomParticipant\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "The context of key value pairs for http request."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<AddOrUpdateParticipantsResult> addOrUpdateParticipantsWithResponse(String roomId, Iterable<RoomParticipant> participants, Context context)"
|
|
desc: "addOrUpdate participants to an existing Room with response"
|
|
returns:
|
|
description: "response for a successful addOrUpdate participants room request."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.rooms.models.AddOrUpdateParticipantsResult?alt=com.azure.communication.rooms.models.AddOrUpdateParticipantsResult&text=AddOrUpdateParticipantsResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.rooms.RoomsClient.createRoom(com.azure.communication.rooms.models.CreateRoomOptions)"
|
|
fullName: "com.azure.communication.rooms.RoomsClient.createRoom(CreateRoomOptions createRoomOptions)"
|
|
name: "createRoom(CreateRoomOptions createRoomOptions)"
|
|
nameWithType: "RoomsClient.createRoom(CreateRoomOptions createRoomOptions)"
|
|
summary: "Create a new room."
|
|
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 CommunicationRoom createRoom(CreateRoomOptions createRoomOptions)"
|
|
desc: "Create a new room. Input field is nullable."
|
|
returns:
|
|
description: "response for a successful create room request."
|
|
type: "<xref href=\"com.azure.communication.rooms.models.CommunicationRoom?alt=com.azure.communication.rooms.models.CommunicationRoom&text=CommunicationRoom\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.rooms.RoomsClient.createRoomWithResponse(com.azure.communication.rooms.models.CreateRoomOptions,com.azure.core.util.Context)"
|
|
fullName: "com.azure.communication.rooms.RoomsClient.createRoomWithResponse(CreateRoomOptions createRoomOptions, Context context)"
|
|
name: "createRoomWithResponse(CreateRoomOptions createRoomOptions, Context context)"
|
|
nameWithType: "RoomsClient.createRoomWithResponse(CreateRoomOptions createRoomOptions, Context context)"
|
|
summary: "Create a new Room with response."
|
|
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\" />"
|
|
- description: "The context of key value pairs for http request."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<CommunicationRoom> createRoomWithResponse(CreateRoomOptions createRoomOptions, Context context)"
|
|
desc: "Create a new Room with response."
|
|
returns:
|
|
description: "response for a successful create room request."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.rooms.models.CommunicationRoom?alt=com.azure.communication.rooms.models.CommunicationRoom&text=CommunicationRoom\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.rooms.RoomsClient.deleteRoom(java.lang.String)"
|
|
fullName: "com.azure.communication.rooms.RoomsClient.deleteRoom(String roomId)"
|
|
name: "deleteRoom(String roomId)"
|
|
nameWithType: "RoomsClient.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 void deleteRoom(String roomId)"
|
|
desc: "Delete an existing room."
|
|
- uid: "com.azure.communication.rooms.RoomsClient.deleteRoomWithResponse(java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.communication.rooms.RoomsClient.deleteRoomWithResponse(String roomId, Context context)"
|
|
name: "deleteRoomWithResponse(String roomId, Context context)"
|
|
nameWithType: "RoomsClient.deleteRoomWithResponse(String roomId, Context context)"
|
|
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>"
|
|
- description: "The context of key value pairs for http request."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> deleteRoomWithResponse(String roomId, Context context)"
|
|
desc: "Delete an existing room."
|
|
returns:
|
|
description: "Response with status code only."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.communication.rooms.RoomsClient.getRoom(java.lang.String)"
|
|
fullName: "com.azure.communication.rooms.RoomsClient.getRoom(String roomId)"
|
|
name: "getRoom(String roomId)"
|
|
nameWithType: "RoomsClient.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 CommunicationRoom getRoom(String roomId)"
|
|
desc: "Get an existing room."
|
|
returns:
|
|
description: "The existing room."
|
|
type: "<xref href=\"com.azure.communication.rooms.models.CommunicationRoom?alt=com.azure.communication.rooms.models.CommunicationRoom&text=CommunicationRoom\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.rooms.RoomsClient.getRoomWithResponse(java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.communication.rooms.RoomsClient.getRoomWithResponse(String roomId, Context context)"
|
|
name: "getRoomWithResponse(String roomId, Context context)"
|
|
nameWithType: "RoomsClient.getRoomWithResponse(String roomId, Context context)"
|
|
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>"
|
|
- description: "The context of key value pairs for http request."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<CommunicationRoom> getRoomWithResponse(String roomId, Context context)"
|
|
desc: "Get an existing room with response."
|
|
returns:
|
|
description: "The existing room."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.rooms.models.CommunicationRoom?alt=com.azure.communication.rooms.models.CommunicationRoom&text=CommunicationRoom\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.rooms.RoomsClient.listParticipants(java.lang.String)"
|
|
fullName: "com.azure.communication.rooms.RoomsClient.listParticipants(String roomId)"
|
|
name: "listParticipants(String roomId)"
|
|
nameWithType: "RoomsClient.listParticipants(String roomId)"
|
|
summary: "List 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 PagedIterable<RoomParticipant> listParticipants(String roomId)"
|
|
desc: "List Room participants."
|
|
returns:
|
|
description: "Room Participants List"
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.rooms.models.RoomParticipant?alt=com.azure.communication.rooms.models.RoomParticipant&text=RoomParticipant\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.rooms.RoomsClient.listParticipants(java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.communication.rooms.RoomsClient.listParticipants(String roomId, Context context)"
|
|
name: "listParticipants(String roomId, Context context)"
|
|
nameWithType: "RoomsClient.listParticipants(String roomId, Context context)"
|
|
summary: "List 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>"
|
|
- description: "The context of key value pairs for http request."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PagedIterable<RoomParticipant> listParticipants(String roomId, Context context)"
|
|
desc: "List Room participants."
|
|
returns:
|
|
description: "Room Participants List"
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.rooms.models.RoomParticipant?alt=com.azure.communication.rooms.models.RoomParticipant&text=RoomParticipant\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.rooms.RoomsClient.listRooms()"
|
|
fullName: "com.azure.communication.rooms.RoomsClient.listRooms()"
|
|
name: "listRooms()"
|
|
nameWithType: "RoomsClient.listRooms()"
|
|
summary: "Lists all rooms."
|
|
syntax: "public PagedIterable<CommunicationRoom> listRooms()"
|
|
desc: "Lists all rooms."
|
|
returns:
|
|
description: "The existing rooms."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.rooms.models.CommunicationRoom?alt=com.azure.communication.rooms.models.CommunicationRoom&text=CommunicationRoom\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.rooms.RoomsClient.listRooms(com.azure.core.util.Context)"
|
|
fullName: "com.azure.communication.rooms.RoomsClient.listRooms(Context context)"
|
|
name: "listRooms(Context context)"
|
|
nameWithType: "RoomsClient.listRooms(Context context)"
|
|
summary: "Lists all rooms."
|
|
parameters:
|
|
- description: "The context of key value pairs for http request."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PagedIterable<CommunicationRoom> listRooms(Context context)"
|
|
desc: "Lists all rooms."
|
|
returns:
|
|
description: "The existing rooms."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.rooms.models.CommunicationRoom?alt=com.azure.communication.rooms.models.CommunicationRoom&text=CommunicationRoom\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.rooms.RoomsClient.removeParticipants(java.lang.String,java.lang.Iterable<com.azure.communication.common.CommunicationIdentifier>)"
|
|
fullName: "com.azure.communication.rooms.RoomsClient.removeParticipants(String roomId, Iterable<CommunicationIdentifier> identifiers)"
|
|
name: "removeParticipants(String roomId, Iterable<CommunicationIdentifier> identifiers)"
|
|
nameWithType: "RoomsClient.removeParticipants(String roomId, Iterable<CommunicationIdentifier> identifiers)"
|
|
summary: "Remove 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 communication identifiers list."
|
|
name: "identifiers"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.azure.communication.common.CommunicationIdentifier?alt=com.azure.communication.common.CommunicationIdentifier&text=CommunicationIdentifier\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public RemoveParticipantsResult removeParticipants(String roomId, Iterable<CommunicationIdentifier> identifiers)"
|
|
desc: "Remove participants to an existing Room."
|
|
returns:
|
|
description: "response for a successful remove participants room request."
|
|
type: "<xref href=\"com.azure.communication.rooms.models.RemoveParticipantsResult?alt=com.azure.communication.rooms.models.RemoveParticipantsResult&text=RemoveParticipantsResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.rooms.RoomsClient.removeParticipantsWithResponse(java.lang.String,java.lang.Iterable<com.azure.communication.common.CommunicationIdentifier>,com.azure.core.util.Context)"
|
|
fullName: "com.azure.communication.rooms.RoomsClient.removeParticipantsWithResponse(String roomId, Iterable<CommunicationIdentifier> identifiers, Context context)"
|
|
name: "removeParticipantsWithResponse(String roomId, Iterable<CommunicationIdentifier> identifiers, Context context)"
|
|
nameWithType: "RoomsClient.removeParticipantsWithResponse(String roomId, Iterable<CommunicationIdentifier> identifiers, Context context)"
|
|
summary: "Remove 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 communication identifiers list."
|
|
name: "identifiers"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html\">Iterable</a><<xref href=\"com.azure.communication.common.CommunicationIdentifier?alt=com.azure.communication.common.CommunicationIdentifier&text=CommunicationIdentifier\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "The context of key value pairs for http request."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<RemoveParticipantsResult> removeParticipantsWithResponse(String roomId, Iterable<CommunicationIdentifier> identifiers, Context context)"
|
|
desc: "Remove participants to an existing Room with response"
|
|
returns:
|
|
description: "response for a successful remove participants room request."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.rooms.models.RemoveParticipantsResult?alt=com.azure.communication.rooms.models.RemoveParticipantsResult&text=RemoveParticipantsResult\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.rooms.RoomsClient.updateRoom(java.lang.String,com.azure.communication.rooms.models.UpdateRoomOptions)"
|
|
fullName: "com.azure.communication.rooms.RoomsClient.updateRoom(String roomId, UpdateRoomOptions updateRoomOptions)"
|
|
name: "updateRoom(String roomId, UpdateRoomOptions updateRoomOptions)"
|
|
nameWithType: "RoomsClient.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 CommunicationRoom updateRoom(String roomId, UpdateRoomOptions updateRoomOptions)"
|
|
desc: "Update an existing Room."
|
|
returns:
|
|
description: "response for a successful update room request."
|
|
type: "<xref href=\"com.azure.communication.rooms.models.CommunicationRoom?alt=com.azure.communication.rooms.models.CommunicationRoom&text=CommunicationRoom\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.rooms.RoomsClient.updateRoomWithResponse(java.lang.String,com.azure.communication.rooms.models.UpdateRoomOptions,com.azure.core.util.Context)"
|
|
fullName: "com.azure.communication.rooms.RoomsClient.updateRoomWithResponse(String roomId, UpdateRoomOptions updateRoomOptions, Context context)"
|
|
name: "updateRoomWithResponse(String roomId, UpdateRoomOptions updateRoomOptions, Context context)"
|
|
nameWithType: "RoomsClient.updateRoomWithResponse(String roomId, UpdateRoomOptions updateRoomOptions, Context context)"
|
|
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\" />"
|
|
- description: "The context of key value pairs for http request."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<CommunicationRoom> updateRoomWithResponse(String roomId, UpdateRoomOptions updateRoomOptions, Context context)"
|
|
desc: "Update an existing Room with response."
|
|
returns:
|
|
description: "response for a successful update room request."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.rooms.models.CommunicationRoom?alt=com.azure.communication.rooms.models.CommunicationRoom&text=CommunicationRoom\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "class"
|
|
desc: "Client for Rooms operations of Azure Communication Room Service\n\n**Instantiating a Room Client**\n\n```java\nRoomsClient roomsClient = new RoomsClientBuilder()\n .endpoint(endpoint)\n .credential(azureKeyCredential)\n .buildClient();\n```"
|
|
metadata: {}
|
|
package: "com.azure.communication.rooms"
|
|
artifact: com.azure:azure-communication-rooms:1.1.7
|