Proactive.GetConversationAsync(String, CancellationToken) Method

Definition

Retrieves the conversation reference record associated with the specified conversation identifier asynchronously.

public System.Threading.Tasks.Task<Microsoft.Agents.Builder.App.Proactive.Conversation?> GetConversationAsync(string conversationId, System.Threading.CancellationToken cancellationToken = default);
member this.GetConversationAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Agents.Builder.App.Proactive.Conversation>
Public Function GetConversationAsync (conversationId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Conversation)

Parameters

conversationId
String

The unique identifier of the conversation for which to retrieve the reference record. Cannot be null or empty.

cancellationToken
CancellationToken

A cancellation token that can be used to cancel the asynchronous operation.

Returns

A Conversation representing the conversation reference if found; otherwise, null.

Remarks

If no conversation reference exists for the specified identifier, the method returns null. This method is thread-safe and does not modify storage.

Applies to