wehub-resource-sync
db620d33df
dotnet-build-and-test / dotnet-test-functions (push) Has been cancelled
dotnet-build-and-test / paths-filter (push) Has been cancelled
dotnet-build-and-test / dotnet-build (Debug, windows-latest, net9.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-build (Release, ubuntu-latest, net10.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-build (Release, ubuntu-latest, net8.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-build (Release, windows-latest, net472) (push) Has been cancelled
dotnet-build-and-test / dotnet-test (Release, integration, true, ubuntu-latest, net10.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-test (Release, integration, true, windows-latest, net472) (push) Has been cancelled
dotnet-build-and-test / dotnet-foundry-hosted-it (push) Has been cancelled
dotnet-build-and-test / dotnet-build-and-test-check (push) Has been cancelled
dotnet-build-and-test / Integration Test Report (push) Has been cancelled
CodeQL / Analyze (csharp) (push) Has been cancelled
CodeQL / Analyze (python) (push) Has been cancelled
35 lines
1.3 KiB
C#
35 lines
1.3 KiB
C#
// Copyright (c) Microsoft. All rights reserved.
|
|
|
|
namespace Microsoft.Agents.AI.DurableTask.Workflows;
|
|
|
|
/// <summary>
|
|
/// Represents a workflow run that can be awaited for completion.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// This interface extends <see cref="IWorkflowRun"/> to provide methods for waiting
|
|
/// until the workflow execution completes. Not all workflow runners support this capability.
|
|
/// </para>
|
|
/// <para>
|
|
/// Use pattern matching to check if a workflow run supports awaiting:
|
|
/// <code>
|
|
/// IWorkflowRun run = await client.RunAsync(workflow, input);
|
|
/// if (run is IAwaitableWorkflowRun awaitableRun)
|
|
/// {
|
|
/// string? result = await awaitableRun.WaitForCompletionAsync<string>();
|
|
/// }
|
|
/// </code>
|
|
/// </para>
|
|
/// </remarks>
|
|
public interface IAwaitableWorkflowRun : IWorkflowRun
|
|
{
|
|
/// <summary>
|
|
/// Waits for the workflow to complete and returns the result.
|
|
/// </summary>
|
|
/// <typeparam name="TResult">The expected result type.</typeparam>
|
|
/// <param name="cancellationToken">A cancellation token to observe.</param>
|
|
/// <returns>The result of the workflow execution.</returns>
|
|
/// <exception cref="InvalidOperationException">Thrown when the workflow failed or was terminated.</exception>
|
|
ValueTask<TResult?> WaitForCompletionAsync<TResult>(CancellationToken cancellationToken = default);
|
|
}
|