GetTwinCorrelatingMessageCallback Interface

Package:

com.microsoft.azure.sdk.iot.device.twin

public interface GetTwinCorrelatingMessageCallback

Detailed state notification callback for tracking a particular getTwinAsync(GetTwinCorrelatingMessageCallback twinCallback, Object callbackContext) request.

Users who don't need all this information are advised to use getTwinAsync(GetTwinCallback twinCallback, Object callbackContext) instead.

Method Summary

Modifier and Type	Method and Description
void	onRequestAcknowledged(Message message, Object callbackContext, IotHubClientException e) Called when the message request has been sent and IoT hub has acknowledged the request.
void	onRequestQueued(Message message, Object callbackContext) Called when the message has been queued to the transport.
void	onRequestSent(Message message, Object callbackContext) Called when the message request has been sent by the transport.
void	onResponseAcknowledged(Message message, Object callbackContext) Called when a response to the message has been sent by IoT hub and has been acknowledged by the transport.
void	onResponseReceived(Twin twin, Message message, Object callbackContext, IotHubStatusCode statusCode, IotHubClientException e) Called when a response to the sent message has been sent by IoT hub and has been receieved by the transport. This response contains the twin that was requested.

Method Details

onRequestAcknowledged

public void onRequestAcknowledged(Message message, Object callbackContext, IotHubClientException e)

Called when the message request has been sent and IoT hub has acknowledged the request.

Parameters:

message - The request message sent by the transport.

callbackContext - The context sent with the message.

e -

The error or exception given by the transport. If there are no errors this will benull 

</code> . </p>

onRequestQueued

public void onRequestQueued(Message message, Object callbackContext)

Called when the message has been queued to the transport.

Parameters:

message - The request message queued by the transport.

callbackContext - The context sent with the message.

onRequestSent

public void onRequestSent(Message message, Object callbackContext)

Called when the message request has been sent by the transport.

Parameters:

message - The request message sent by the transport.

callbackContext - The context sent with the message.

onResponseAcknowledged

public void onResponseAcknowledged(Message message, Object callbackContext)

Called when a response to the message has been sent by IoT hub and has been acknowledged by the transport.

Parameters:

message - The response message queued to the transport.

callbackContext - The context sent with the message.

onResponseReceived

public void onResponseReceived(Twin twin, Message message, Object callbackContext, IotHubStatusCode statusCode, IotHubClientException e)

Called when a response to the sent message has been sent by IoT hub and has been receieved by the transport. This response contains the twin that was requested.

Parameters:

twin - The retrieved twin from the service. If null, check the status code and exception for details on why the twin could not be received.

message - The response message received by the transport.

callbackContext - The context sent with the message.

statusCode - The status of the update reported properties call as a whole.

e -

The error or exception given by the transport. If there are no errors this will benull 

</code> . </p>