225 строки
14 KiB
YAML
225 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage"
|
|
name: "HttpsSingleMessage"
|
|
nameWithType: "HttpsSingleMessage"
|
|
summary: "A single HTTPS message."
|
|
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 **HttpsSingleMessage**</br> implements <xref href=\"com.microsoft.azure.sdk.iot.device.transport.https.HttpsMessage?alt=com.microsoft.azure.sdk.iot.device.transport.https.HttpsMessage&text=HttpsMessage\" data-throw-if-not-resolved=\"False\" />"
|
|
fields:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.CONTENT_ENCODING_KEY"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.CONTENT_ENCODING_KEY"
|
|
name: "CONTENT_ENCODING_KEY"
|
|
nameWithType: "HttpsSingleMessage.CONTENT_ENCODING_KEY"
|
|
modifiers:
|
|
- "protected"
|
|
- "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: "protected static final String CONTENT_ENCODING_KEY"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.CONTENT_TYPE_KEY"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.CONTENT_TYPE_KEY"
|
|
name: "CONTENT_TYPE_KEY"
|
|
nameWithType: "HttpsSingleMessage.CONTENT_TYPE_KEY"
|
|
modifiers:
|
|
- "protected"
|
|
- "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: "protected static final String CONTENT_TYPE_KEY"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.CORRELATION_ID_KEY"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.CORRELATION_ID_KEY"
|
|
name: "CORRELATION_ID_KEY"
|
|
nameWithType: "HttpsSingleMessage.CORRELATION_ID_KEY"
|
|
summary: "The property names as they are saved in the system properties of this object"
|
|
modifiers:
|
|
- "protected"
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "iothub-correlationid"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected static final String CORRELATION_ID_KEY"
|
|
desc: "The property names as they are saved in the system properties of this object"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.MESSAGE_ID_KEY"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.MESSAGE_ID_KEY"
|
|
name: "MESSAGE_ID_KEY"
|
|
nameWithType: "HttpsSingleMessage.MESSAGE_ID_KEY"
|
|
modifiers:
|
|
- "protected"
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "iothub-messageid"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected static final String MESSAGE_ID_KEY"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.TO_KEY"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.TO_KEY"
|
|
name: "TO_KEY"
|
|
nameWithType: "HttpsSingleMessage.TO_KEY"
|
|
modifiers:
|
|
- "protected"
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "iothub-to"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected static final String TO_KEY"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.USER_ID_KEY"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.USER_ID_KEY"
|
|
name: "USER_ID_KEY"
|
|
nameWithType: "HttpsSingleMessage.USER_ID_KEY"
|
|
modifiers:
|
|
- "protected"
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "iothub-userid"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected static final String USER_ID_KEY"
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.getBody()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.getBody()"
|
|
name: "getBody()"
|
|
nameWithType: "HttpsSingleMessage.getBody()"
|
|
summary: "Returns a copy of the message body."
|
|
syntax: "public byte[] getBody()"
|
|
desc: "Returns a copy of the message body."
|
|
returns:
|
|
description: "a copy of the message body."
|
|
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.getBodyAsString()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.getBodyAsString()"
|
|
name: "getBodyAsString()"
|
|
nameWithType: "HttpsSingleMessage.getBodyAsString()"
|
|
summary: "Returns the message body as a string."
|
|
syntax: "public String getBodyAsString()"
|
|
desc: "Returns the message body as a string. The body is encoded using charset UTF-8."
|
|
returns:
|
|
description: "the message body as a string."
|
|
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.transport.https.HttpsSingleMessage.getContentType()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.getContentType()"
|
|
name: "getContentType()"
|
|
nameWithType: "HttpsSingleMessage.getContentType()"
|
|
summary: "Returns the message content-type."
|
|
syntax: "public String getContentType()"
|
|
desc: "Returns the message content-type."
|
|
returns:
|
|
description: "the message content-type."
|
|
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.transport.https.HttpsSingleMessage.getProperties()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.getProperties()"
|
|
name: "getProperties()"
|
|
nameWithType: "HttpsSingleMessage.getProperties()"
|
|
summary: "Returns a copy of the message properties."
|
|
syntax: "public MessageProperty[] getProperties()"
|
|
desc: "Returns a copy of the message properties."
|
|
returns:
|
|
description: "a copy of the message properties."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.MessageProperty?alt=com.microsoft.azure.sdk.iot.device.MessageProperty&text=MessageProperty\" data-throw-if-not-resolved=\"False\" />[]"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.getSystemProperties()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.getSystemProperties()"
|
|
name: "getSystemProperties()"
|
|
nameWithType: "HttpsSingleMessage.getSystemProperties()"
|
|
summary: "Returns a copy of the message system properties."
|
|
syntax: "public Map<String,String> getSystemProperties()"
|
|
desc: "Returns a copy of the message system properties."
|
|
returns:
|
|
description: "a copy of the message system 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\" />>"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.isBase64Encoded()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.isBase64Encoded()"
|
|
name: "isBase64Encoded()"
|
|
nameWithType: "HttpsSingleMessage.isBase64Encoded()"
|
|
summary: "Returns whether the message is Base64-encoded."
|
|
syntax: "public boolean isBase64Encoded()"
|
|
desc: "Returns whether the message is Base64-encoded."
|
|
returns:
|
|
description: "whether the message is Base64-encoded."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.parseHttpsJsonMessage(com.microsoft.azure.sdk.iot.device.Message)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.parseHttpsJsonMessage(Message message)"
|
|
name: "parseHttpsJsonMessage(Message message)"
|
|
nameWithType: "HttpsSingleMessage.parseHttpsJsonMessage(Message message)"
|
|
summary: "Returns the HTTPS message represented by the service-bound message for application json format."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "the service-bound message to be mapped to its HTTPS message\n equivalent."
|
|
name: "message"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.Message?alt=com.microsoft.azure.sdk.iot.device.Message&text=Message\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static HttpsSingleMessage parseHttpsJsonMessage(Message message)"
|
|
desc: "Returns the HTTPS message represented by the service-bound message for application json format. Content type \"application/json;charset=utf-8\""
|
|
returns:
|
|
description: "the HTTPS message represented by the service-bound message."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage?alt=com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage&text=HttpsSingleMessage\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.parseHttpsMessage(com.microsoft.azure.sdk.iot.device.Message)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.parseHttpsMessage(Message message)"
|
|
name: "parseHttpsMessage(Message message)"
|
|
nameWithType: "HttpsSingleMessage.parseHttpsMessage(Message message)"
|
|
summary: "Returns the HTTPS message represented by the service-bound message for binary octets."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "the service-bound message to be mapped to its HTTPS message\n equivalent."
|
|
name: "message"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.Message?alt=com.microsoft.azure.sdk.iot.device.Message&text=Message\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static HttpsSingleMessage parseHttpsMessage(Message message)"
|
|
desc: "Returns the HTTPS message represented by the service-bound message for binary octets. Content type \"binary/octet-stream\""
|
|
returns:
|
|
description: "the HTTPS message represented by the service-bound message."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage?alt=com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage&text=HttpsSingleMessage\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.parseHttpsMessage(com.microsoft.azure.sdk.iot.device.transport.https.HttpsResponse)"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.parseHttpsMessage(HttpsResponse response)"
|
|
name: "parseHttpsMessage(HttpsResponse response)"
|
|
nameWithType: "HttpsSingleMessage.parseHttpsMessage(HttpsResponse response)"
|
|
summary: "Returns the HTTPS message represented by the HTTPS response."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "the HTTPS response."
|
|
name: "response"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.transport.https.HttpsResponse?alt=com.microsoft.azure.sdk.iot.device.transport.https.HttpsResponse&text=HttpsResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static HttpsSingleMessage parseHttpsMessage(HttpsResponse response)"
|
|
desc: "Returns the HTTPS message represented by the HTTPS response."
|
|
returns:
|
|
description: "the HTTPS message represented by the HTTPS response."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage?alt=com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage&text=HttpsSingleMessage\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.toMessage()"
|
|
fullName: "com.microsoft.azure.sdk.iot.device.transport.https.HttpsSingleMessage.toMessage()"
|
|
name: "toMessage()"
|
|
nameWithType: "HttpsSingleMessage.toMessage()"
|
|
summary: "Returns the Iot Hub message represented by the HTTPS message."
|
|
syntax: "public Message toMessage()"
|
|
desc: "Returns the Iot Hub message represented by the HTTPS message."
|
|
returns:
|
|
description: "the IoT Hub message represented by the HTTPS message."
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.Message?alt=com.microsoft.azure.sdk.iot.device.Message&text=Message\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A single HTTPS message."
|
|
implements:
|
|
- "<xref href=\"com.microsoft.azure.sdk.iot.device.transport.https.HttpsMessage?alt=com.microsoft.azure.sdk.iot.device.transport.https.HttpsMessage&text=HttpsMessage\" data-throw-if-not-resolved=\"False\" />"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.device.transport.https"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-device-client:1.30.1
|