IRemoteProxiedUserControlClient.ObjectValueNotificationAsync 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.
Notifies the client of the current value of a uniquely identifiable object. This method is called when the client queries for an object value using GetObjectAsync(ObjectId, CancellationToken).
public System.Threading.Tasks.Task ObjectValueNotificationAsync (Microsoft.VisualStudio.RpcContracts.RemoteUI.MessagePackFragment value, System.Threading.CancellationToken cancellationToken);abstract member ObjectValueNotificationAsync : Microsoft.VisualStudio.RpcContracts.RemoteUI.MessagePackFragment * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function ObjectValueNotificationAsync (value As MessagePackFragment, cancellationToken As CancellationToken) As TaskParameters
- value
- MessagePackFragment
The current value of the uniquely identifiable object.
- cancellationToken
- CancellationToken
Cancellation token for the async call.
Returns
A Task tracking the completion of the async operation.
Remarks
We don't send the object value as a result of the GetObjectAsync(ObjectId, CancellationToken) method because we cannot guarantee proper ordering of handling of async method results. We can guarantee ordering of execution of StreamJsonRpc methods, so all object values and updates are always sent as method parameters, never as method results.