DeviceClient.SetDesiredPropertyUpdateCallbackAsync Method

Definition

Namespace:

Microsoft.Azure.Devices.Client

Assemblies:

Microsoft.Azure.Devices.Client.dll, Microsoft.Azure.Devices.Client.PCL.dll

Packages:

Microsoft.Azure.Devices.Client v1.41.2, Microsoft.Azure.Devices.Client.PCL v1.0.16

Overloads

SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object)	Set a callback that will be called whenever the client receives a state update (desired or reported) from the service. Set callback value to null to clear.
SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object, CancellationToken)	Set a callback that will be called whenever the client receives a state update (desired or reported) from the service. Set callback value to null to clear.

SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object)

Set a callback that will be called whenever the client receives a state update (desired or reported) from the service. Set callback value to null to clear.

public System.Threading.Tasks.Task SetDesiredPropertyUpdateCallbackAsync (Microsoft.Azure.Devices.Client.DesiredPropertyUpdateCallback callback, object userContext);

member this.SetDesiredPropertyUpdateCallbackAsync : Microsoft.Azure.Devices.Client.DesiredPropertyUpdateCallback * obj -> System.Threading.Tasks.Task

Public Function SetDesiredPropertyUpdateCallbackAsync (callback As DesiredPropertyUpdateCallback, userContext As Object) As Task

Parameters

callback

DesiredPropertyUpdateCallback

Callback to call after the state update has been received and applied

userContext

Object

Context object that will be passed into callback

Returns

Task

Remarks

This has the side-effect of subscribing to the PATCH topic on the service.

SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object, CancellationToken)

Set a callback that will be called whenever the client receives a state update (desired or reported) from the service. Set callback value to null to clear.

public System.Threading.Tasks.Task SetDesiredPropertyUpdateCallbackAsync (Microsoft.Azure.Devices.Client.DesiredPropertyUpdateCallback callback, object userContext, System.Threading.CancellationToken cancellationToken);

member this.SetDesiredPropertyUpdateCallbackAsync : Microsoft.Azure.Devices.Client.DesiredPropertyUpdateCallback * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function SetDesiredPropertyUpdateCallbackAsync (callback As DesiredPropertyUpdateCallback, userContext As Object, cancellationToken As CancellationToken) As Task

Parameters

callback

DesiredPropertyUpdateCallback

Callback to call after the state update has been received and applied.

userContext

Object

Context object that will be passed into callback.

cancellationToken

CancellationToken

A cancellation token to cancel the operation.

Returns

Task

Exceptions

OperationCanceledException

Thrown when the operation has been canceled.

TaskCanceledException

Thrown when the operation has been canceled.

Remarks

This has the side-effect of subscribing to the PATCH topic on the service.