112 строки
11 KiB
YAML
112 строки
11 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.device.ReportedPropertiesParameters"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.ReportedPropertiesParameters"
|
|
name: "ReportedPropertiesParameters"
|
|
nameWithType: "ReportedPropertiesParameters"
|
|
summary: "Convenience class for the send<wbr>Reported<wbr>Properties method in the Device<wbr>Client"
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **ReportedPropertiesParameters**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.ReportedPropertiesParameters.ReportedPropertiesParameters(java.util.Set<com.microsoft.azure.sdk.iot.device.DeviceTwin.Property>)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.ReportedPropertiesParameters.ReportedPropertiesParameters(Set<DeviceTwin.Property> properties)"
|
|
name: "ReportedPropertiesParameters(Set<DeviceTwin.Property> properties)"
|
|
nameWithType: "ReportedPropertiesParameters.ReportedPropertiesParameters(Set<DeviceTwin.Property> properties)"
|
|
summary: "Creates the class with the properties to send"
|
|
parameters:
|
|
- description: "the properties to be reported. Value can not be <code>null</code>."
|
|
name: "properties"
|
|
type: "<xref href=\"java.util.Set?alt=java.util.Set&text=Set\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.sdk.iot.device.DeviceTwin.Property?alt=com.microsoft.azure.sdk.iot.device.DeviceTwin.Property&text=Property\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public ReportedPropertiesParameters(Set<DeviceTwin.Property> properties)"
|
|
exceptions:
|
|
- description: "when the properties parmeter is null."
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Creates the class with the properties to send"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.ReportedPropertiesParameters.ReportedPropertiesParameters(java.util.Set<com.microsoft.azure.sdk.iot.device.DeviceTwin.Property>,java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.ReportedPropertiesParameters.ReportedPropertiesParameters(Set<DeviceTwin.Property> properties, Integer version)"
|
|
name: "ReportedPropertiesParameters(Set<DeviceTwin.Property> properties, Integer version)"
|
|
nameWithType: "ReportedPropertiesParameters.ReportedPropertiesParameters(Set<DeviceTwin.Property> properties, Integer version)"
|
|
summary: "Creates the class with the properties to send and sets version"
|
|
parameters:
|
|
- description: "Properties to be reported. Value can not be <code>null</code>."
|
|
name: "properties"
|
|
type: "<xref href=\"java.util.Set?alt=java.util.Set&text=Set\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.sdk.iot.device.DeviceTwin.Property?alt=com.microsoft.azure.sdk.iot.device.DeviceTwin.Property&text=Property\" data-throw-if-not-resolved=\"False\" />>"
|
|
- description: "Version to set for properties. Value can not be <code>null</code>."
|
|
name: "version"
|
|
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ReportedPropertiesParameters(Set<DeviceTwin.Property> properties, Integer version)"
|
|
exceptions:
|
|
- description: "when either the properties or version parmeters are null."
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Creates the class with the properties to send and sets version"
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.ReportedPropertiesParameters.setCorrelationCallback(com.microsoft.azure.sdk.iot.device.CorrelatingMessageCallback)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.ReportedPropertiesParameters.setCorrelationCallback(CorrelatingMessageCallback correlatingMessageCallback)"
|
|
name: "setCorrelationCallback(CorrelatingMessageCallback correlatingMessageCallback)"
|
|
nameWithType: "ReportedPropertiesParameters.setCorrelationCallback(CorrelatingMessageCallback correlatingMessageCallback)"
|
|
summary: "Set the correlation callback for the send<wbr>Reported<wbr>Properties method"
|
|
parameters:
|
|
- description: "A callback that will monitor the message lifecycle. Value can be <code>null</code>."
|
|
name: "correlatingMessageCallback"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.CorrelatingMessageCallback?alt=com.microsoft.azure.sdk.iot.device.CorrelatingMessageCallback&text=CorrelatingMessageCallback\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setCorrelationCallback(CorrelatingMessageCallback correlatingMessageCallback)"
|
|
desc: "Set the correlation callback for the sendReportedProperties method"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.ReportedPropertiesParameters.setCorrelationCallback(com.microsoft.azure.sdk.iot.device.CorrelatingMessageCallback,java.lang.Object)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.ReportedPropertiesParameters.setCorrelationCallback(CorrelatingMessageCallback correlatingMessageCallback, Object correlatingMessageCallbackContext)"
|
|
name: "setCorrelationCallback(CorrelatingMessageCallback correlatingMessageCallback, Object correlatingMessageCallbackContext)"
|
|
nameWithType: "ReportedPropertiesParameters.setCorrelationCallback(CorrelatingMessageCallback correlatingMessageCallback, Object correlatingMessageCallbackContext)"
|
|
summary: "Set the correlation callback for the send<wbr>Reported<wbr>Properties method"
|
|
parameters:
|
|
- description: "A callback that will monitor the message lifecycle. Value can be <code>null</code>."
|
|
name: "correlatingMessageCallback"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.CorrelatingMessageCallback?alt=com.microsoft.azure.sdk.iot.device.CorrelatingMessageCallback&text=CorrelatingMessageCallback\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The context for the callback. Value can be <code>null</code>."
|
|
name: "correlatingMessageCallbackContext"
|
|
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setCorrelationCallback(CorrelatingMessageCallback correlatingMessageCallback, Object correlatingMessageCallbackContext)"
|
|
desc: "Set the correlation callback for the sendReportedProperties method"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.ReportedPropertiesParameters.setReportedPropertiesCallback(com.microsoft.azure.sdk.iot.device.IotHubEventCallback)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.ReportedPropertiesParameters.setReportedPropertiesCallback(IotHubEventCallback reportedPropertiesCallback)"
|
|
name: "setReportedPropertiesCallback(IotHubEventCallback reportedPropertiesCallback)"
|
|
nameWithType: "ReportedPropertiesParameters.setReportedPropertiesCallback(IotHubEventCallback reportedPropertiesCallback)"
|
|
summary: "Set the event callback for the send<wbr>Reported<wbr>Properties method"
|
|
parameters:
|
|
- description: "A callback that will be executed once the messaage has been sent and acknowledged. Value can be <code>null</code>."
|
|
name: "reportedPropertiesCallback"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.IotHubEventCallback?alt=com.microsoft.azure.sdk.iot.device.IotHubEventCallback&text=IotHubEventCallback\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setReportedPropertiesCallback(IotHubEventCallback reportedPropertiesCallback)"
|
|
desc: "Set the event callback for the sendReportedProperties method"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.ReportedPropertiesParameters.setReportedPropertiesCallback(com.microsoft.azure.sdk.iot.device.IotHubEventCallback,java.lang.Object)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.ReportedPropertiesParameters.setReportedPropertiesCallback(IotHubEventCallback reportedPropertiesCallback, Object reportedPropertiesCallbackContext)"
|
|
name: "setReportedPropertiesCallback(IotHubEventCallback reportedPropertiesCallback, Object reportedPropertiesCallbackContext)"
|
|
nameWithType: "ReportedPropertiesParameters.setReportedPropertiesCallback(IotHubEventCallback reportedPropertiesCallback, Object reportedPropertiesCallbackContext)"
|
|
summary: "Set the event callback for the send<wbr>Reported<wbr>Properties method"
|
|
parameters:
|
|
- description: "A callback that will be executed once the messaage has been sent and acknowledged. Value can be <code>null</code>."
|
|
name: "reportedPropertiesCallback"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.IotHubEventCallback?alt=com.microsoft.azure.sdk.iot.device.IotHubEventCallback&text=IotHubEventCallback\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The context for the callback. Value can be <code>null</code>."
|
|
name: "reportedPropertiesCallbackContext"
|
|
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setReportedPropertiesCallback(IotHubEventCallback reportedPropertiesCallback, Object reportedPropertiesCallbackContext)"
|
|
desc: "Set the event callback for the sendReportedProperties method"
|
|
type: "class"
|
|
desc: "Convenience class for the sendReportedProperties method in the DeviceClient"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.device"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-device-client:1.30.1
|