ConfidentialClientApplicationExtensions.StopLongRunningProcessInWebApiAsync Method

Reference

Definition

Namespace:: Microsoft.Identity.Client.Extensibility

Assembly:: Microsoft.Identity.Client.dll

Package:: Microsoft.Identity.Client v4.60.3

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.

Stops an in-progress long-running on-behalf-of session by removing the tokens associated with the provided cache key. See Long-running OBO in MSAL.NET.

public static System.Threading.Tasks.Task<bool> StopLongRunningProcessInWebApiAsync (this Microsoft.Identity.Client.ILongRunningWebApi clientApp, string longRunningProcessSessionKey, System.Threading.CancellationToken cancellationToken = default);

static member StopLongRunningProcessInWebApiAsync : Microsoft.Identity.Client.ILongRunningWebApi * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>

<Extension()>
Public Function StopLongRunningProcessInWebApiAsync (clientApp As ILongRunningWebApi, longRunningProcessSessionKey As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)

Parameters

clientApp: ILongRunningWebApi

Client application to remove tokens from.

longRunningProcessSessionKey: String

OBO cache key used to remove the tokens.

cancellationToken: CancellationToken

Cancellation token.

Returns

Task<Boolean>

True if tokens are removed from the cache; false, otherwise.

Exceptions

ArgumentNullException

longRunningProcessSessionKey is not set.

Applies to