SecurityTokenProvider.GetTokenAsync(TimeSpan) 方法

定义

获取安全令牌。

public:
 System::Threading::Tasks::Task<System::IdentityModel::Tokens::SecurityToken ^> ^ GetTokenAsync(TimeSpan timeout);
public System.Threading.Tasks.Task<System.IdentityModel.Tokens.SecurityToken> GetTokenAsync(TimeSpan timeout);
member this.GetTokenAsync : TimeSpan -> System.Threading.Tasks.Task<System.IdentityModel.Tokens.SecurityToken>
Public Function GetTokenAsync (timeout As TimeSpan) As Task(Of SecurityToken)

参数

timeout
TimeSpan

一个 TimeSpan ,指定获取安全令牌的消息的超时值。

返回

表示 Task 异步读取操作并包装 SecurityToken 表示要获取的安全令牌的读取操作。

注解

GetTokenAsync当客户端发送 SOAP 消息和安全令牌时,类将调用ClientCredentials该方法。

该方法 GetTokenAsync 调用该方法 GetTokenCoreAsync

在大多数情况下, timeout 参数不由派生类 SecurityTokenProvider 使用,例如 UserNameSecurityTokenProvider。 但是,有时检索安全令牌涉及分布式消息传送。 联合服务中使用了一个示例 IssuedSecurityTokenProvider 。 在这些情况下, timeout 该参数用于避免网络故障、消息丢失和其他错误条件导致的异常。

此方法存储在任务中,它返回该方法的同步对应项可以引发的所有非使用异常。 如果异常存储在返回的任务中,则等待任务时将引发该异常。 使用情况异常(例如 ArgumentException)仍会同步引发。 有关存储的异常,请参阅由 GetToken(TimeSpan)..

适用于