DeviceClient.SetDesiredPropertyUpdateCallbackAsync 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.
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.TaskPublic Function SetDesiredPropertyUpdateCallbackAsync (callback As DesiredPropertyUpdateCallback, userContext As Object) As TaskParameters
- 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
Remarks
This has the side-effect of subscribing to the PATCH topic on the service.
Applies to
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.TaskPublic Function SetDesiredPropertyUpdateCallbackAsync (callback As DesiredPropertyUpdateCallback, userContext As Object, cancellationToken As CancellationToken) As TaskParameters
- 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
Exceptions
Thrown when the operation has been canceled.
Thrown when the operation has been canceled.
Remarks
This has the side-effect of subscribing to the PATCH topic on the service.
