SecurityTokenProvider.CancelTokenAsync(TimeSpan, SecurityToken) Method

Definition

Namespace:

System.IdentityModel.Selectors

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.0

Source:

SecurityTokenProvider.cs

Cancels a security token.

public:
 System::Threading::Tasks::Task ^ CancelTokenAsync(TimeSpan timeout, System::IdentityModel::Tokens::SecurityToken ^ token);

public System.Threading.Tasks.Task CancelTokenAsync (TimeSpan timeout, System.IdentityModel.Tokens.SecurityToken token);

member this.CancelTokenAsync : TimeSpan * System.IdentityModel.Tokens.SecurityToken -> System.Threading.Tasks.Task

Public Function CancelTokenAsync (timeout As TimeSpan, token As SecurityToken) As Task

Parameters

timeout

TimeSpan

A TimeSpan that specifies the timeout value for the message that cancels the security token.

token

SecurityToken

The SecurityToken to cancel.

Returns

Task

The Task that represents the asynchronous token cancellation operation.

Remarks

A security token that can be cancelled, such as one that is issued, allows a client that requested a security token to cancel it when it is done with it.

The CancelTokenAsync method calls CancelTokenCoreAsync method.

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by CancelToken(TimeSpan, SecurityToken).