WebPubSubChatServiceClient.GetRoomAsync Method

Definition

Namespace:

Azure.Messaging.WebPubSub.Chat

Assembly:

Azure.Messaging.WebPubSub.Chat.dll

Package:

Azure.Messaging.WebPubSub.Chat v1.0.0-beta.1

Overloads

Name	Description
GetRoomAsync(String, RequestContext)	[Protocol Method] Get room information. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRoomAsync(String, CancellationToken)	Get room information.

GetRoomAsync(String, RequestContext)

Source:

WebPubSubChatServiceClient.cs

[Protocol Method] Get room information.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

public virtual System.Threading.Tasks.Task<Azure.Response> GetRoomAsync(string roomId, Azure.RequestContext context);

abstract member GetRoomAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetRoomAsync : string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetRoomAsync (roomId As String, context As RequestContext) As Task(Of Response)

Parameters

roomId

String

Room identifier.

context

RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

roomId is null.

ArgumentException

roomId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

GetRoomAsync(String, CancellationToken)

Source:

WebPubSubChatServiceClient.cs

Get room information.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.WebPubSub.Chat.WebPubSubChatRoom>> GetRoomAsync(string roomId, System.Threading.CancellationToken cancellationToken = default);

abstract member GetRoomAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.WebPubSub.Chat.WebPubSubChatRoom>>
override this.GetRoomAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.WebPubSub.Chat.WebPubSubChatRoom>>

Public Overridable Function GetRoomAsync (roomId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of WebPubSubChatRoom))

Parameters

roomId

String

Room identifier.

cancellationToken

CancellationToken

The cancellation token that can be used to cancel the operation.

Returns

Task<Response<WebPubSubChatRoom>>

Exceptions

ArgumentNullException

roomId is null.

ArgumentException

roomId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.