Share via


IRemoteProxiedUserControl.GetObjectAsync(ObjectId, CancellationToken) Method

Definition

This method allows querying for the value of a uniquely identifiable object that is part of the DataContext of the control. The value of the object will be sent to the client using ObjectValueNotificationAsync(MessagePackFragment, CancellationToken).

public System.Threading.Tasks.Task<bool> GetObjectAsync (Microsoft.VisualStudio.RpcContracts.RemoteUI.ObjectId id, System.Threading.CancellationToken cancellationToken);
abstract member GetObjectAsync : Microsoft.VisualStudio.RpcContracts.RemoteUI.ObjectId * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
Public Function GetObjectAsync (id As ObjectId, cancellationToken As CancellationToken) As Task(Of Boolean)

Parameters

id
ObjectId

The unique identifier of the object to return.

cancellationToken
CancellationToken

Cancellation token for the async call.

Returns

Whether the object was found. If the result is true, IRemoteProxiedUserControl will call ObjectValueNotificationAsync(MessagePackFragment, CancellationToken) providing a value for the object.

Applies to