225 строки
12 KiB
YAML
225 строки
12 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.device.MessageProperty"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty"
|
|
name: "MessageProperty"
|
|
nameWithType: "MessageProperty"
|
|
summary: "An IoT Hub message property."
|
|
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 final class **MessageProperty**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.MessageProperty()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.MessageProperty()"
|
|
name: "MessageProperty()"
|
|
nameWithType: "MessageProperty.MessageProperty()"
|
|
modifiers:
|
|
- "protected"
|
|
syntax: "protected MessageProperty()"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.MessageProperty(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.MessageProperty(String name, String value)"
|
|
name: "MessageProperty(String name, String value)"
|
|
nameWithType: "MessageProperty.MessageProperty(String name, String value)"
|
|
summary: "Constructor."
|
|
parameters:
|
|
- description: "The IoT Hub message property name."
|
|
name: "name"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The IoT Hub message property value."
|
|
name: "value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MessageProperty(String name, String value)"
|
|
desc: "Constructor."
|
|
fields:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.CONNECTION_DEVICE_ID"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.CONNECTION_DEVICE_ID"
|
|
name: "CONNECTION_DEVICE_ID"
|
|
nameWithType: "MessageProperty.CONNECTION_DEVICE_ID"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "iothub-connection-device-id"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final String CONNECTION_DEVICE_ID"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.CONNECTION_MODULE_ID"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.CONNECTION_MODULE_ID"
|
|
name: "CONNECTION_MODULE_ID"
|
|
nameWithType: "MessageProperty.CONNECTION_MODULE_ID"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "iothub-connection-module-id"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final String CONNECTION_MODULE_ID"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_CONTENT_ENCODING"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_CONTENT_ENCODING"
|
|
name: "IOTHUB_CONTENT_ENCODING"
|
|
nameWithType: "MessageProperty.IOTHUB_CONTENT_ENCODING"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "iothub-contentencoding"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final String IOTHUB_CONTENT_ENCODING"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_CONTENT_TYPE"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_CONTENT_TYPE"
|
|
name: "IOTHUB_CONTENT_TYPE"
|
|
nameWithType: "MessageProperty.IOTHUB_CONTENT_TYPE"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "iothub-contenttype"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final String IOTHUB_CONTENT_TYPE"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_CREATION_TIME_UTC"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_CREATION_TIME_UTC"
|
|
name: "IOTHUB_CREATION_TIME_UTC"
|
|
nameWithType: "MessageProperty.IOTHUB_CREATION_TIME_UTC"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "iothub-creation-time-utc"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final String IOTHUB_CREATION_TIME_UTC"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_SECURITY_INTERFACE_ID"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_SECURITY_INTERFACE_ID"
|
|
name: "IOTHUB_SECURITY_INTERFACE_ID"
|
|
nameWithType: "MessageProperty.IOTHUB_SECURITY_INTERFACE_ID"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "iothub-interface-id"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final String IOTHUB_SECURITY_INTERFACE_ID"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_SECURITY_INTERFACE_ID_VALUE"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.IOTHUB_SECURITY_INTERFACE_ID_VALUE"
|
|
name: "IOTHUB_SECURITY_INTERFACE_ID_VALUE"
|
|
nameWithType: "MessageProperty.IOTHUB_SECURITY_INTERFACE_ID_VALUE"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "urn:azureiot:Security:SecurityAgent:1"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final String IOTHUB_SECURITY_INTERFACE_ID_VALUE"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.OUTPUT_NAME_PROPERTY"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.OUTPUT_NAME_PROPERTY"
|
|
name: "OUTPUT_NAME_PROPERTY"
|
|
nameWithType: "MessageProperty.OUTPUT_NAME_PROPERTY"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "iothub-outputname"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final String OUTPUT_NAME_PROPERTY"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.RESERVED_PROPERTY_NAMES"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.RESERVED_PROPERTY_NAMES"
|
|
name: "RESERVED_PROPERTY_NAMES"
|
|
nameWithType: "MessageProperty.RESERVED_PROPERTY_NAMES"
|
|
summary: "A set of reserved property names."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"java.util.Set?alt=java.util.Set&text=Set\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public static final Set<String> RESERVED_PROPERTY_NAMES"
|
|
desc: "A set of reserved property names. The reserved property names are interpreted in a meaningful way by the device and the IoT Hub."
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.getName()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.getName()"
|
|
name: "getName()"
|
|
nameWithType: "MessageProperty.getName()"
|
|
summary: "Returns the property name."
|
|
syntax: "public String getName()"
|
|
desc: "Returns the property name."
|
|
returns:
|
|
description: "the property name."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.getValue()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.getValue()"
|
|
name: "getValue()"
|
|
nameWithType: "MessageProperty.getValue()"
|
|
summary: "Returns the property value."
|
|
syntax: "public String getValue()"
|
|
desc: "Returns the property value."
|
|
returns:
|
|
description: "the property value."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.hasSameName(java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.hasSameName(String name)"
|
|
name: "hasSameName(String name)"
|
|
nameWithType: "MessageProperty.hasSameName(String name)"
|
|
summary: "Equivalent to property.<wbr>get<wbr>Name().equals<wbr>Ignore<wbr>Case(name)."
|
|
parameters:
|
|
- description: "the property name."
|
|
name: "name"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public boolean hasSameName(String name)"
|
|
desc: "Equivalent to property.getName().equalsIgnoreCase(name)."
|
|
returns:
|
|
description: "true if the given name is the property name."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.isValidAppProperty(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.isValidAppProperty(String name, String value)"
|
|
name: "isValidAppProperty(String name, String value)"
|
|
nameWithType: "MessageProperty.isValidAppProperty(String name, String value)"
|
|
summary: "Returns whether the property is a valid application property."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "the property name."
|
|
name: "name"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the property value."
|
|
name: "value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static boolean isValidAppProperty(String name, String value)"
|
|
desc: "Returns whether the property is a valid application property. The property is valid if it is not one of the reserved properties, only uses US-ASCII"
|
|
returns:
|
|
description: "whether the property is a valid application property."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.MessageProperty.isValidSystemProperty(java.lang.String,java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.MessageProperty.isValidSystemProperty(String name, String value)"
|
|
name: "isValidSystemProperty(String name, String value)"
|
|
nameWithType: "MessageProperty.isValidSystemProperty(String name, String value)"
|
|
summary: "Returns whether the property is a valid system property."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "the property name."
|
|
name: "name"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "the property value."
|
|
name: "value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static boolean isValidSystemProperty(String name, String value)"
|
|
desc: "Returns whether the property is a valid system property. The property is valid if it is one of the reserved properties and only uses US-ASCII"
|
|
returns:
|
|
description: "whether the property is a valid system property."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "An IoT Hub message property."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.device"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-device-client:1.30.1
|