WebPubSubChatServiceClient.GetRoom Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| GetRoom(String, RequestContext) |
[Protocol Method] Get room information.
|
| GetRoom(String, CancellationToken) |
Get room information. |
GetRoom(String, RequestContext)
[Protocol Method] Get room information.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual Azure.Response GetRoom(string roomId, Azure.RequestContext context);abstract member GetRoom : string * Azure.RequestContext -> Azure.Response
override this.GetRoom : string * Azure.RequestContext -> Azure.ResponsePublic Overridable Function GetRoom (roomId As String, context As RequestContext) As ResponseParameters
- roomId
- String
Room identifier.
- context
- RequestContext
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
roomId is null.
roomId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
GetRoom(String, CancellationToken)
Get room information.
public virtual Azure.Response<Azure.Messaging.WebPubSub.Chat.WebPubSubChatRoom> GetRoom(string roomId, System.Threading.CancellationToken cancellationToken = default);abstract member GetRoom : string * System.Threading.CancellationToken -> Azure.Response<Azure.Messaging.WebPubSub.Chat.WebPubSubChatRoom>
override this.GetRoom : string * System.Threading.CancellationToken -> Azure.Response<Azure.Messaging.WebPubSub.Chat.WebPubSubChatRoom>Public Overridable Function GetRoom (roomId As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of WebPubSubChatRoom)Parameters
- roomId
- String
Room identifier.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
roomId is null.
roomId is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
