220 строки
16 KiB
YAML
220 строки
16 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties"
|
|
name: "TwinProperties"
|
|
nameWithType: "TwinProperties"
|
|
summary: "INNER TWINPARSER CLASS Twin<wbr>Parser Properties representation This class is part of the Twin<wbr>Parser."
|
|
deprecatedTag: "As of release 0.4.0, replaced by <xref uid=\"com.microsoft.azure.sdk.iot.deps.twin.TwinProperties\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.microsoft.azure.sdk.iot.deps.twin.TwinProperties\"></xref>"
|
|
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: "</br>public class **TwinProperties**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.TwinProperties()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.TwinProperties()"
|
|
name: "TwinProperties()"
|
|
nameWithType: "TwinProperties.TwinProperties()"
|
|
syntax: "public TwinProperties()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.clearDesired()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.clearDesired()"
|
|
name: "clearDesired()"
|
|
nameWithType: "TwinProperties.clearDesired()"
|
|
modifiers:
|
|
- "protected"
|
|
syntax: "protected void clearDesired()"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.clearReported()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.clearReported()"
|
|
name: "clearReported()"
|
|
nameWithType: "TwinProperties.clearReported()"
|
|
modifiers:
|
|
- "protected"
|
|
syntax: "protected void clearReported()"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.enableDesiredMetadata()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.enableDesiredMetadata()"
|
|
name: "enableDesiredMetadata()"
|
|
nameWithType: "TwinProperties.enableDesiredMetadata()"
|
|
modifiers:
|
|
- "protected"
|
|
syntax: "protected void enableDesiredMetadata()"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.enableReportedMetadata()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.enableReportedMetadata()"
|
|
name: "enableReportedMetadata()"
|
|
nameWithType: "TwinProperties.enableReportedMetadata()"
|
|
modifiers:
|
|
- "protected"
|
|
syntax: "protected void enableReportedMetadata()"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.getDesiredPropertyMap()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.getDesiredPropertyMap()"
|
|
name: "getDesiredPropertyMap()"
|
|
nameWithType: "TwinProperties.getDesiredPropertyMap()"
|
|
modifiers:
|
|
- "protected"
|
|
syntax: "protected Map<String,Object> getDesiredPropertyMap()"
|
|
returns:
|
|
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.getDesiredVersion()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.getDesiredVersion()"
|
|
name: "getDesiredVersion()"
|
|
nameWithType: "TwinProperties.getDesiredVersion()"
|
|
modifiers:
|
|
- "protected"
|
|
syntax: "protected Integer getDesiredVersion()"
|
|
returns:
|
|
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.getReportedPropertyMap()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.getReportedPropertyMap()"
|
|
name: "getReportedPropertyMap()"
|
|
nameWithType: "TwinProperties.getReportedPropertyMap()"
|
|
modifiers:
|
|
- "protected"
|
|
syntax: "protected Map<String,Object> getReportedPropertyMap()"
|
|
returns:
|
|
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.getReportedVersion()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.getReportedVersion()"
|
|
name: "getReportedVersion()"
|
|
nameWithType: "TwinProperties.getReportedVersion()"
|
|
modifiers:
|
|
- "protected"
|
|
syntax: "protected Integer getReportedVersion()"
|
|
returns:
|
|
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.resetDesired(java.util.Map<java.lang.String,java.lang.Object>)"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.resetDesired(Map<String,Object> property)"
|
|
name: "resetDesired(Map<String,Object> property)"
|
|
nameWithType: "TwinProperties.resetDesired(Map<String,Object> property)"
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- name: "property"
|
|
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "protected JsonElement resetDesired(Map<String,Object> property)"
|
|
returns:
|
|
type: "<xref href=\"com.google.gson.JsonElement?alt=com.google.gson.JsonElement&text=JsonElement\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.resetReported(java.util.Map<java.lang.String,java.lang.Object>)"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.resetReported(Map<String,Object> property)"
|
|
name: "resetReported(Map<String,Object> property)"
|
|
nameWithType: "TwinProperties.resetReported(Map<String,Object> property)"
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- name: "property"
|
|
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "protected JsonElement resetReported(Map<String,Object> property)"
|
|
returns:
|
|
type: "<xref href=\"com.google.gson.JsonElement?alt=com.google.gson.JsonElement&text=JsonElement\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.toJson()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.toJson()"
|
|
name: "toJson()"
|
|
nameWithType: "TwinProperties.toJson()"
|
|
modifiers:
|
|
- "protected"
|
|
syntax: "protected String toJson()"
|
|
returns:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.toJsonElement()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.toJsonElement()"
|
|
name: "toJsonElement()"
|
|
nameWithType: "TwinProperties.toJsonElement()"
|
|
modifiers:
|
|
- "protected"
|
|
syntax: "protected JsonElement toJsonElement()"
|
|
returns:
|
|
type: "<xref href=\"com.google.gson.JsonElement?alt=com.google.gson.JsonElement&text=JsonElement\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.update(java.util.Map<java.lang.String,java.lang.Object>,com.microsoft.azure.sdk.iot.deps.serializer.TwinChangedCallback,com.microsoft.azure.sdk.iot.deps.serializer.TwinChangedCallback)"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.update(Map<String,Object> jsonTree, TwinChangedCallback onDesiredCallback, TwinChangedCallback onReportedCallback)"
|
|
name: "update(Map<String,Object> jsonTree, TwinChangedCallback onDesiredCallback, TwinChangedCallback onReportedCallback)"
|
|
nameWithType: "TwinProperties.update(Map<String,Object> jsonTree, TwinChangedCallback onDesiredCallback, TwinChangedCallback onReportedCallback)"
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- name: "jsonTree"
|
|
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />>"
|
|
- name: "onDesiredCallback"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.serializer.TwinChangedCallback?alt=com.microsoft.azure.sdk.iot.deps.serializer.TwinChangedCallback&text=TwinChangedCallback\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "onReportedCallback"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.serializer.TwinChangedCallback?alt=com.microsoft.azure.sdk.iot.deps.serializer.TwinChangedCallback&text=TwinChangedCallback\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected void update(Map<String,Object> jsonTree, TwinChangedCallback onDesiredCallback, TwinChangedCallback onReportedCallback)"
|
|
exceptions:
|
|
- type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.updateDesired(java.lang.String,com.microsoft.azure.sdk.iot.deps.serializer.TwinChangedCallback)"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.updateDesired(String json, TwinChangedCallback onDesiredCallback)"
|
|
name: "updateDesired(String json, TwinChangedCallback onDesiredCallback)"
|
|
nameWithType: "TwinProperties.updateDesired(String json, TwinChangedCallback onDesiredCallback)"
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- name: "json"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "onDesiredCallback"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.serializer.TwinChangedCallback?alt=com.microsoft.azure.sdk.iot.deps.serializer.TwinChangedCallback&text=TwinChangedCallback\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected void updateDesired(String json, TwinChangedCallback onDesiredCallback)"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.updateDesired(java.util.Map<java.lang.String,java.lang.Object>)"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.updateDesired(Map<String,Object> property)"
|
|
name: "updateDesired(Map<String,Object> property)"
|
|
nameWithType: "TwinProperties.updateDesired(Map<String,Object> property)"
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- name: "property"
|
|
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "protected JsonElement updateDesired(Map<String,Object> property)"
|
|
returns:
|
|
type: "<xref href=\"com.google.gson.JsonElement?alt=com.google.gson.JsonElement&text=JsonElement\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.updateReported(java.lang.String,com.microsoft.azure.sdk.iot.deps.serializer.TwinChangedCallback)"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.updateReported(String json, TwinChangedCallback onDesiredCallback)"
|
|
name: "updateReported(String json, TwinChangedCallback onDesiredCallback)"
|
|
nameWithType: "TwinProperties.updateReported(String json, TwinChangedCallback onDesiredCallback)"
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- name: "json"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "onDesiredCallback"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.serializer.TwinChangedCallback?alt=com.microsoft.azure.sdk.iot.deps.serializer.TwinChangedCallback&text=TwinChangedCallback\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected void updateReported(String json, TwinChangedCallback onDesiredCallback)"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.updateReported(java.util.Map<java.lang.String,java.lang.Object>)"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.updateReported(Map<String,Object> property)"
|
|
name: "updateReported(Map<String,Object> property)"
|
|
nameWithType: "TwinProperties.updateReported(Map<String,Object> property)"
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- name: "property"
|
|
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "protected JsonElement updateReported(Map<String,Object> property)"
|
|
returns:
|
|
type: "<xref href=\"com.google.gson.JsonElement?alt=com.google.gson.JsonElement&text=JsonElement\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.validate(java.util.Map<java.lang.String,java.lang.Object>)"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.TwinProperties.validate(Map<String,Object> jsonTree)"
|
|
name: "validate(Map<String,Object> jsonTree)"
|
|
nameWithType: "TwinProperties.validate(Map<String,Object> jsonTree)"
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- name: "jsonTree"
|
|
type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "protected void validate(Map<String,Object> jsonTree)"
|
|
exceptions:
|
|
- type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "INNER TWINPARSER CLASS TwinParser Properties representation This class is part of the TwinParser. It is necessary to generate the properties json."
|
|
hasDeprecatedTag: true
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.deps.serializer"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-deps:0.12.0
|