233 строки
15 KiB
YAML
233 строки
15 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.service.Message"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message"
|
|
name: "Message"
|
|
nameWithType: "Message"
|
|
summary: "Iot<wbr>Hub specific message container"
|
|
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 **Message**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.Message()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.Message()"
|
|
name: "Message()"
|
|
nameWithType: "Message.Message()"
|
|
summary: "Basic constructor"
|
|
syntax: "public Message()"
|
|
desc: "Basic constructor"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.Message(byte[])"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.Message(byte[] byteArray)"
|
|
name: "Message(byte[] byteArray)"
|
|
nameWithType: "Message.Message(byte[] byteArray)"
|
|
summary: "byte<wbr>Array: a byte array containing the body of the message"
|
|
parameters:
|
|
- description: "The byte array containing the message body"
|
|
name: "byteArray"
|
|
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
|
|
syntax: "public Message(byte[] byteArray)"
|
|
desc: "byteArray: a byte array containing the body of the message"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.Message(java.io.ByteArrayInputStream)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.Message(ByteArrayInputStream stream)"
|
|
name: "Message(ByteArrayInputStream stream)"
|
|
nameWithType: "Message.Message(ByteArrayInputStream stream)"
|
|
summary: "stream: a stream containing the body of the message"
|
|
parameters:
|
|
- description: "The stream containing the message body"
|
|
name: "stream"
|
|
type: "<xref href=\"java.io.ByteArrayInputStream?alt=java.io.ByteArrayInputStream&text=ByteArrayInputStream\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Message(ByteArrayInputStream stream)"
|
|
desc: "stream: a stream containing the body of the message"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.Message(java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.Message(String string)"
|
|
name: "Message(String string)"
|
|
nameWithType: "Message.Message(String string)"
|
|
parameters:
|
|
- description: "- a string containing the body of the message.\n Important: If a string is passed, the HttpBatch.SerializeAsString is set to true,\n and the internal byte representation is serialized as UTF-8,\n with HttpBatch.Encoding set to UTF-8."
|
|
name: "string"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Message(String string)"
|
|
exceptions:
|
|
- description: "This exception is thrown if unsupported encoding used"
|
|
type: "<xref href=\"java.io.UnsupportedEncodingException?alt=java.io.UnsupportedEncodingException&text=UnsupportedEncodingException\" data-throw-if-not-resolved=\"False\" />"
|
|
fields:
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.correlationId"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.correlationId"
|
|
name: "correlationId"
|
|
nameWithType: "Message.correlationId"
|
|
summary: "Used in message responses and feedback"
|
|
field:
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public String correlationId"
|
|
desc: "Used in message responses and feedback"
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.clearCustomProperties()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.clearCustomProperties()"
|
|
name: "clearCustomProperties()"
|
|
nameWithType: "Message.clearCustomProperties()"
|
|
syntax: "public void clearCustomProperties()"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.getBodyStream()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.getBodyStream()"
|
|
name: "getBodyStream()"
|
|
nameWithType: "Message.getBodyStream()"
|
|
summary: "The stream content of the body."
|
|
syntax: "public ByteArrayOutputStream getBodyStream()"
|
|
desc: "The stream content of the body."
|
|
returns:
|
|
description: "The ByteArrayOutputStream object containing the message body"
|
|
type: "<xref href=\"java.io.ByteArrayOutputStream?alt=java.io.ByteArrayOutputStream&text=ByteArrayOutputStream\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.getBytes()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.getBytes()"
|
|
name: "getBytes()"
|
|
nameWithType: "Message.getBytes()"
|
|
summary: "The byte content of the body."
|
|
syntax: "public byte[] getBytes()"
|
|
desc: "The byte content of the body."
|
|
returns:
|
|
description: "The byte array of the message body"
|
|
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.getCorrelationId()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.getCorrelationId()"
|
|
name: "getCorrelationId()"
|
|
nameWithType: "Message.getCorrelationId()"
|
|
syntax: "public String getCorrelationId()"
|
|
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.service.Message.getDeliveryAcknowledgement()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.getDeliveryAcknowledgement()"
|
|
name: "getDeliveryAcknowledgement()"
|
|
nameWithType: "Message.getDeliveryAcknowledgement()"
|
|
syntax: "public DeliveryAcknowledgement getDeliveryAcknowledgement()"
|
|
returns:
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.DeliveryAcknowledgement?alt=com.microsoft.azure.sdk.iot.service.DeliveryAcknowledgement&text=DeliveryAcknowledgement\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.getExpiryTimeUtc()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.getExpiryTimeUtc()"
|
|
name: "getExpiryTimeUtc()"
|
|
nameWithType: "Message.getExpiryTimeUtc()"
|
|
syntax: "public Date getExpiryTimeUtc()"
|
|
returns:
|
|
type: "<xref href=\"java.util.Date?alt=java.util.Date&text=Date\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.getLockToken()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.getLockToken()"
|
|
name: "getLockToken()"
|
|
nameWithType: "Message.getLockToken()"
|
|
syntax: "public String getLockToken()"
|
|
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.service.Message.getMessageId()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.getMessageId()"
|
|
name: "getMessageId()"
|
|
nameWithType: "Message.getMessageId()"
|
|
syntax: "public String getMessageId()"
|
|
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.service.Message.getProperties()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.getProperties()"
|
|
name: "getProperties()"
|
|
nameWithType: "Message.getProperties()"
|
|
syntax: "public Map<String,String> getProperties()"
|
|
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.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.getTo()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.getTo()"
|
|
name: "getTo()"
|
|
nameWithType: "Message.getTo()"
|
|
syntax: "public String getTo()"
|
|
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.service.Message.getUserId()"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.getUserId()"
|
|
name: "getUserId()"
|
|
nameWithType: "Message.getUserId()"
|
|
syntax: "public String getUserId()"
|
|
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.service.Message.setCorrelationId(java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.setCorrelationId(String correlationId)"
|
|
name: "setCorrelationId(String correlationId)"
|
|
nameWithType: "Message.setCorrelationId(String correlationId)"
|
|
parameters:
|
|
- name: "correlationId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setCorrelationId(String correlationId)"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.setDeliveryAcknowledgement(com.microsoft.azure.sdk.iot.service.DeliveryAcknowledgement)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.setDeliveryAcknowledgement(DeliveryAcknowledgement deliveryAcknowledgement)"
|
|
name: "setDeliveryAcknowledgement(DeliveryAcknowledgement deliveryAcknowledgement)"
|
|
nameWithType: "Message.setDeliveryAcknowledgement(DeliveryAcknowledgement deliveryAcknowledgement)"
|
|
deprecatedTag: "as of service-client version 1.15.1, please use <xref uid=\"com.microsoft.azure.sdk.iot.service.Message.setDeliveryAcknowledgementFinal(com.microsoft.azure.sdk.iot.service.DeliveryAcknowledgement)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setDeliveryAcknowledgementFinal(DeliveryAcknowledgement)\"></xref>"
|
|
parameters:
|
|
- description: "the delivery acknowledgement to set"
|
|
name: "deliveryAcknowledgement"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.DeliveryAcknowledgement?alt=com.microsoft.azure.sdk.iot.service.DeliveryAcknowledgement&text=DeliveryAcknowledgement\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "</br>public void setDeliveryAcknowledgement(DeliveryAcknowledgement deliveryAcknowledgement)"
|
|
hasDeprecatedTag: true
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.setDeliveryAcknowledgementFinal(com.microsoft.azure.sdk.iot.service.DeliveryAcknowledgement)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.setDeliveryAcknowledgementFinal(DeliveryAcknowledgement deliveryAcknowledgement)"
|
|
name: "setDeliveryAcknowledgementFinal(DeliveryAcknowledgement deliveryAcknowledgement)"
|
|
nameWithType: "Message.setDeliveryAcknowledgementFinal(DeliveryAcknowledgement deliveryAcknowledgement)"
|
|
modifiers:
|
|
- "final"
|
|
parameters:
|
|
- description: "the delivery acknowledgement to set"
|
|
name: "deliveryAcknowledgement"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.DeliveryAcknowledgement?alt=com.microsoft.azure.sdk.iot.service.DeliveryAcknowledgement&text=DeliveryAcknowledgement\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public final void setDeliveryAcknowledgementFinal(DeliveryAcknowledgement deliveryAcknowledgement)"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.setExpiryTimeUtc(java.util.Date)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.setExpiryTimeUtc(Date expiryTimeUtc)"
|
|
name: "setExpiryTimeUtc(Date expiryTimeUtc)"
|
|
nameWithType: "Message.setExpiryTimeUtc(Date expiryTimeUtc)"
|
|
parameters:
|
|
- name: "expiryTimeUtc"
|
|
type: "<xref href=\"java.util.Date?alt=java.util.Date&text=Date\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setExpiryTimeUtc(Date expiryTimeUtc)"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.setMessageId(java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.setMessageId(String messageId)"
|
|
name: "setMessageId(String messageId)"
|
|
nameWithType: "Message.setMessageId(String messageId)"
|
|
parameters:
|
|
- name: "messageId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setMessageId(String messageId)"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.setProperties(java.util.Map<java.lang.String,java.lang.String>)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.setProperties(Map<String,String> properties)"
|
|
name: "setProperties(Map<String,String> properties)"
|
|
nameWithType: "Message.setProperties(Map<String,String> properties)"
|
|
parameters:
|
|
- name: "properties"
|
|
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.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public void setProperties(Map<String,String> properties)"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.setTo(java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.setTo(String deviceId)"
|
|
name: "setTo(String deviceId)"
|
|
nameWithType: "Message.setTo(String deviceId)"
|
|
parameters:
|
|
- name: "deviceId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setTo(String deviceId)"
|
|
- uid: "com.microsoft.azure.sdk.iot.service.Message.setUserId(java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.service.Message.setUserId(String userId)"
|
|
name: "setUserId(String userId)"
|
|
nameWithType: "Message.setUserId(String userId)"
|
|
parameters:
|
|
- name: "userId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void setUserId(String userId)"
|
|
type: "class"
|
|
desc: "IotHub specific message container"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.service"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-service-client:1.30.0
|