Share via

ReportedPropertiesParameters Class

Package:
com.microsoft.azure.sdk.iot.device
Maven Artifact:
com.microsoft.azure.sdk.iot:iot-device-client:1.30.1
  • java.lang.Object
    • com.microsoft.azure.sdk.iot.device.ReportedPropertiesParameters

public class ReportedPropertiesParameters

Convenience class for the sendReportedProperties method in the DeviceClient

Constructor Summary

Constructor Description
ReportedPropertiesParameters(Set<DeviceTwin.Property> properties)

Creates the class with the properties to send
ReportedPropertiesParameters(Set<DeviceTwin.Property> properties, Integer version)

Creates the class with the properties to send and sets version

Method Summary

Modifier and Type Method and Description
void setCorrelationCallback(CorrelatingMessageCallback correlatingMessageCallback)

Set the correlation callback for the sendReportedProperties method
void setCorrelationCallback(CorrelatingMessageCallback correlatingMessageCallback, Object correlatingMessageCallbackContext)

Set the correlation callback for the sendReportedProperties method
void setReportedPropertiesCallback(IotHubEventCallback reportedPropertiesCallback)

Set the event callback for the sendReportedProperties method
void setReportedPropertiesCallback(IotHubEventCallback reportedPropertiesCallback, Object reportedPropertiesCallbackContext)

Set the event callback for the sendReportedProperties method

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

ReportedPropertiesParameters

public ReportedPropertiesParameters(Set<DeviceTwin.Property> properties)

Creates the class with the properties to send

Parameters:

properties - the properties to be reported. Value can not be null.

Throws:

java.lang.IllegalArgumentException - when the properties parmeter is null.

ReportedPropertiesParameters

public ReportedPropertiesParameters(Set<DeviceTwin.Property> properties, Integer version)

Creates the class with the properties to send and sets version

Parameters:

properties - Properties to be reported. Value can not be null.
version - Version to set for properties. Value can not be null.

Throws:

java.lang.IllegalArgumentException - when either the properties or version parmeters are null.

Method Details

setCorrelationCallback

public void setCorrelationCallback(CorrelatingMessageCallback correlatingMessageCallback)

Set the correlation callback for the sendReportedProperties method

Parameters:

correlatingMessageCallback - A callback that will monitor the message lifecycle. Value can be null.

setCorrelationCallback

public void setCorrelationCallback(CorrelatingMessageCallback correlatingMessageCallback, Object correlatingMessageCallbackContext)

Set the correlation callback for the sendReportedProperties method

Parameters:

correlatingMessageCallback - A callback that will monitor the message lifecycle. Value can be null.
correlatingMessageCallbackContext - The context for the callback. Value can be null.

setReportedPropertiesCallback

public void setReportedPropertiesCallback(IotHubEventCallback reportedPropertiesCallback)

Set the event callback for the sendReportedProperties method

Parameters:

reportedPropertiesCallback - A callback that will be executed once the messaage has been sent and acknowledged. Value can be null.

setReportedPropertiesCallback

public void setReportedPropertiesCallback(IotHubEventCallback reportedPropertiesCallback, Object reportedPropertiesCallbackContext)

Set the event callback for the sendReportedProperties method

Parameters:

reportedPropertiesCallback - A callback that will be executed once the messaage has been sent and acknowledged. Value can be null.
reportedPropertiesCallbackContext - The context for the callback. Value can be null.

Applies to