ConnectedServiceGrid.ConfigureServiceInstanceAsync 方法

定义

命名空间:

Microsoft.VisualStudio.ConnectedServices

程序集:

Microsoft.VisualStudio.ConnectedServices.dll

包:

Microsoft.VisualStudio.ConnectedServices v16.2.45

通过对话框或链接到配置网页来配置服务实例。

public:
 virtual System::Threading::Tasks::Task<bool> ^ ConfigureServiceInstanceAsync(Microsoft::VisualStudio::ConnectedServices::ConnectedServiceInstance ^ instance, System::Threading::CancellationToken ct);

public virtual System.Threading.Tasks.Task<bool> ConfigureServiceInstanceAsync (Microsoft.VisualStudio.ConnectedServices.ConnectedServiceInstance instance, System.Threading.CancellationToken ct);

abstract member ConfigureServiceInstanceAsync : Microsoft.VisualStudio.ConnectedServices.ConnectedServiceInstance * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
override this.ConfigureServiceInstanceAsync : Microsoft.VisualStudio.ConnectedServices.ConnectedServiceInstance * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>

Public Overridable Function ConfigureServiceInstanceAsync (instance As ConnectedServiceInstance, ct As CancellationToken) As Task(Of Boolean)

参数

instance

ConnectedServiceInstance

要配置的服务实例。

ct

CancellationToken

CancellationToken 用于取消配置操作。

返回

Task<Boolean>

返回配置的 Task。 Task 的结果值指示是否对实例进行了任何更改。

注解

此方法保证从 UI 线程调用，并且仅在实现 ConnectedServiceAuthenticator 时从 IsAuthenticated 中返回“true”的提供程序上调用。

如果实现想要显示阻止/模式 UI，它可以这样做。 如果在方法返回之前同步配置服务实例，则返回的任务应标记为已完成 (例如，通过 Task.FromResult () ) 。

如果实现在后台运行，它可能会返回正在进行的任务，连接服务代码将在任务完成后刷新 UI。 在这种情况下，如果用户在创建实例之前关闭 Conencted Services UI，则连接服务代码可以通过 CancellationToken 取消任务。

如果实现不监视或无法监视实例的配置，则它可能会返回 null。 在这种情况下，连接的服务代码将不执行任何操作，并要求用户手动刷新/枚举服务实例，以检查配置实例的更改。

如果实现显示/处理任何错误，则 Task 不应对其出错，也不应将其作为异常引发。 如果返回的任务在错误状态下完成， (异常成员为非空) 连接服务 UI 将通知用户失败。