WebPubSubChatServiceClient.GetConversationAsync 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
GetConversationAsync(String, CancellationToken)	Get conversation information.
GetConversationAsync(String, RequestContext)	[Protocol Method] Get conversation information. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.

GetConversationAsync(String, CancellationToken)

Source:

WebPubSubChatServiceClient.cs

Get conversation information.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.WebPubSub.Chat.WebPubSubChatConversation>> GetConversationAsync(string conversationId, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetConversationAsync (conversationId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of WebPubSubChatConversation))

Parameters

conversationId

String

Conversation identifier.

cancellationToken

CancellationToken

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

Returns

Task<Response<WebPubSubChatConversation>>

Exceptions

ArgumentNullException

conversationId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

GetConversationAsync(String, RequestContext)

Source:

WebPubSubChatServiceClient.cs

[Protocol Method] Get conversation 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> GetConversationAsync(string conversationId, Azure.RequestContext context);

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

Public Overridable Function GetConversationAsync (conversationId As String, context As RequestContext) As Task(Of Response)

Parameters

conversationId

String

Conversation 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

conversationId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.