com.microsoft.azure.sdk.iot.device.twin.ReportedPropertiesCallback Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of iot-device-client Show documentation

The Microsoft Azure IoT Device SDK for Java

There is a newer version: 2.5.0

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

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

import com.microsoft.azure.sdk.iot.device.IotHubStatusCode;
import com.microsoft.azure.sdk.iot.device.exceptions.IotHubClientException;

/**
 * Callback to be executed when a reported properties update request has completed.
 */
public interface ReportedPropertiesCallback
{
    /**
     * The callback that is executed when the reported properties update request has completed.
     * @param statusCode The service's status code for the request. If {@link IotHubStatusCode#OK} then the request was
     * processed succesfully.
     * @param response The new version of the reported properties after a successful update. If the client updating
     * its reported properties is connected to Edgehub instead of IoT Hub, then this version won't change since Edgehub
     * does not apply this reported properties update immediately.
     * @param e The exception that was encountered if any exception was encountered.
     * @param context The context that was provided for this callback in
     * {@link com.microsoft.azure.sdk.iot.device.InternalClient#updateReportedPropertiesAsync(TwinCollection, ReportedPropertiesCallback, Object)}
     */
    void onReportedPropertiesUpdateAcknowledged(IotHubStatusCode statusCode, ReportedPropertiesUpdateResponse response, IotHubClientException e, Object context);
}