SecurityTokenProvider.CancelTokenCoreAsync(TimeSpan, SecurityToken) Method
Definition
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.
Cancels a security token.
protected:
virtual System::Threading::Tasks::Task ^ CancelTokenCoreAsync(TimeSpan timeout, System::IdentityModel::Tokens::SecurityToken ^ token);protected virtual System.Threading.Tasks.Task CancelTokenCoreAsync (TimeSpan timeout, System.IdentityModel.Tokens.SecurityToken token);abstract member CancelTokenCoreAsync : TimeSpan * System.IdentityModel.Tokens.SecurityToken -> System.Threading.Tasks.Task
override this.CancelTokenCoreAsync : TimeSpan * System.IdentityModel.Tokens.SecurityToken -> System.Threading.Tasks.TaskProtected Overridable Function CancelTokenCoreAsync (timeout As TimeSpan, token As SecurityToken) As TaskParameters
- timeout
- TimeSpan
A TimeSpan that specifies the timeout value for the message that cancels the security token.
- token
- SecurityToken
The SecurityToken to cancel.
Returns
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.
When the CancelTokenCoreAsync method is overridden and the security token passed into the token parameter cannot be canceled, throw the SecurityTokenException exception.
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 CancelTokenCore(TimeSpan, SecurityToken).
