281 строка
19 KiB
YAML
281 строка
19 KiB
YAML
### YamlMime:JavaType
|
|
constructors:
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.IotHubTransportMessage(byte[] data, MessageType messageType)
|
|
name: IotHubTransportMessage(byte[] data, MessageType messageType)
|
|
nameWithType: IotHubTransportMessage.IotHubTransportMessage(byte[] data, MessageType messageType)
|
|
parameters:
|
|
- description: <p>The byte array of the message. </p>
|
|
name: data
|
|
type: <xref href="byte+%5B%5D?alt=byte+%5B%5D&text=byte+%5B%5D" data-throw-if-not-resolved="False"/>
|
|
- description: <p>The messageType of the message. </p>
|
|
name: messageType
|
|
type: <xref href="com.microsoft.azure.sdk.iot.device.MessageType?alt=com.microsoft.azure.sdk.iot.device.MessageType&text=MessageType" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Constructor with binary data and message type </p>
|
|
syntax: public IotHubTransportMessage(byte[] data, MessageType messageType)
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.IotHubTransportMessage(byte [],MessageType)
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.IotHubTransportMessage(byte[] data, MessageType messageType, String messageId, String correlationId, MessageProperty[] messageProperties)
|
|
name: IotHubTransportMessage(byte[] data, MessageType messageType, String messageId, String correlationId, MessageProperty[] messageProperties)
|
|
nameWithType: IotHubTransportMessage.IotHubTransportMessage(byte[] data, MessageType messageType, String messageId, String correlationId, MessageProperty[] messageProperties)
|
|
parameters:
|
|
- name: data
|
|
type: <xref href="byte+%5B%5D?alt=byte+%5B%5D&text=byte+%5B%5D" data-throw-if-not-resolved="False"/>
|
|
- name: messageType
|
|
type: <xref href="com.microsoft.azure.sdk.iot.device.MessageType?alt=com.microsoft.azure.sdk.iot.device.MessageType&text=MessageType" data-throw-if-not-resolved="False"/>
|
|
- name: messageId
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
- name: correlationId
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
- name: messageProperties
|
|
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"/> []
|
|
syntax: public IotHubTransportMessage(byte[] data, MessageType messageType, String messageId, String correlationId, MessageProperty[] messageProperties)
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.IotHubTransportMessage(byte [],MessageType,String,String,MessageProperty [])
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.IotHubTransportMessage(String body)
|
|
name: IotHubTransportMessage(String body)
|
|
nameWithType: IotHubTransportMessage.IotHubTransportMessage(String body)
|
|
parameters:
|
|
- description: <p>The body of the new Message instance. It is internally serialized to a byte array using UTF-8 encoding. </p>
|
|
name: body
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Constructor. </p>
|
|
syntax: public IotHubTransportMessage(String body)
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.IotHubTransportMessage(String)
|
|
inheritances:
|
|
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
|
|
- <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"/>
|
|
inheritedMembers:
|
|
- com.microsoft.azure.sdk.iot.device.Message.DEFAULT_IOTHUB_MESSAGE_CHARSET
|
|
- com.microsoft.azure.sdk.iot.device.Message.getBodyStream()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getBytes()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getConnectionDeviceId()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getConnectionModuleId()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getContentEncoding()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getContentType()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getCorrelatingMessageCallback()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getCorrelatingMessageCallbackContext()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getCorrelationId()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getCreationTimeUTC()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getCreationTimeUTCString()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getDeliveryAcknowledgement()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getInputName()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getIotHubConnectionString()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getMessageId()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getMessageType()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getOutputName()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getProperties()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getProperty(String)
|
|
- com.microsoft.azure.sdk.iot.device.Message.getTo()
|
|
- com.microsoft.azure.sdk.iot.device.Message.getUserId()
|
|
- com.microsoft.azure.sdk.iot.device.Message.isExpired()
|
|
- com.microsoft.azure.sdk.iot.device.Message.isSecurityMessage()
|
|
- com.microsoft.azure.sdk.iot.device.Message.Message()
|
|
- com.microsoft.azure.sdk.iot.device.Message.Message(byte [])
|
|
- com.microsoft.azure.sdk.iot.device.Message.Message(String)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setAbsoluteExpiryTime(long)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setAsSecurityMessage()
|
|
- com.microsoft.azure.sdk.iot.device.Message.setConnectionDeviceId(String)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setConnectionModuleId(String)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setContentEncoding(String)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setContentType(String)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setCorrelatingMessageCallback(CorrelatingMessageCallback)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setCorrelatingMessageCallbackContext(Object)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setCorrelationId(String)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setCreationTimeUTC(Date)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setExpiryTime(long)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setInputName(String)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setIotHubConnectionString(IotHubConnectionString)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setMessageId(String)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setMessageType(MessageType)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setOutputName(String)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setProperty(String,String)
|
|
- com.microsoft.azure.sdk.iot.device.Message.setUserId(String)
|
|
methods:
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getDeviceOperationType()
|
|
name: getDeviceOperationType()
|
|
nameWithType: IotHubTransportMessage.getDeviceOperationType()
|
|
returns:
|
|
description: <p>the DeviceOperations eum value with the current operation type. </p>
|
|
type: <xref href="com.microsoft.azure.sdk.iot.device.twin.DeviceOperations?alt=com.microsoft.azure.sdk.iot.device.twin.DeviceOperations&text=DeviceOperations" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Getter for the device operation type </p>
|
|
syntax: public DeviceOperations getDeviceOperationType()
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getDeviceOperationType()
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getIotHubMethod()
|
|
name: getIotHubMethod()
|
|
nameWithType: IotHubTransportMessage.getIotHubMethod()
|
|
returns:
|
|
description: <p>the IoT Hub method (POST, GET). </p>
|
|
type: <xref href="com.microsoft.azure.sdk.iot.device.transport.https.HttpsMethod?alt=com.microsoft.azure.sdk.iot.device.transport.https.HttpsMethod&text=HttpsMethod" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Getter for the HTTPS method </p>
|
|
syntax: public HttpsMethod getIotHubMethod()
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getIotHubMethod()
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getMessageCallback()
|
|
name: getMessageCallback()
|
|
nameWithType: IotHubTransportMessage.getMessageCallback()
|
|
returns:
|
|
type: <xref href="com.microsoft.azure.sdk.iot.device.MessageCallback?alt=com.microsoft.azure.sdk.iot.device.MessageCallback&text=MessageCallback" data-throw-if-not-resolved="False"/>
|
|
syntax: public MessageCallback getMessageCallback()
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getMessageCallback()
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getMessageCallbackContext()
|
|
name: getMessageCallbackContext()
|
|
nameWithType: IotHubTransportMessage.getMessageCallbackContext()
|
|
returns:
|
|
type: <xref href="Object?alt=Object&text=Object" data-throw-if-not-resolved="False"/>
|
|
syntax: public Object getMessageCallbackContext()
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getMessageCallbackContext()
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getMethodName()
|
|
name: getMethodName()
|
|
nameWithType: IotHubTransportMessage.getMethodName()
|
|
returns:
|
|
description: <p>the methodName of device method operation. </p>
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Getter for the method name of device method operation </p>
|
|
syntax: public String getMethodName()
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getMethodName()
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getRequestId()
|
|
name: getRequestId()
|
|
nameWithType: IotHubTransportMessage.getRequestId()
|
|
returns:
|
|
description: <p>the String containing the request id. </p>
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Getter for the request id </p>
|
|
syntax: public String getRequestId()
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getRequestId()
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getStatus()
|
|
name: getStatus()
|
|
nameWithType: IotHubTransportMessage.getStatus()
|
|
returns:
|
|
description: <p>the String containing the request status. </p>
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Getter for the request status </p>
|
|
syntax: public String getStatus()
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getStatus()
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getUriPath()
|
|
name: getUriPath()
|
|
nameWithType: IotHubTransportMessage.getUriPath()
|
|
returns:
|
|
description: <p>the string with the URI path. </p>
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Getter for the URI path </p>
|
|
syntax: public String getUriPath()
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getUriPath()
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getVersion()
|
|
name: getVersion()
|
|
nameWithType: IotHubTransportMessage.getVersion()
|
|
returns:
|
|
description: <p>the String containing the version. </p>
|
|
type: <xref href="int?alt=int&text=int" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Getter for the message version </p>
|
|
syntax: public int getVersion()
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.getVersion()
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.isMessageAckNeeded(IotHubClientProtocol protocol)
|
|
name: isMessageAckNeeded(IotHubClientProtocol protocol)
|
|
nameWithType: IotHubTransportMessage.isMessageAckNeeded(IotHubClientProtocol protocol)
|
|
parameters:
|
|
- name: protocol
|
|
type: <xref href="com.microsoft.azure.sdk.iot.device.IotHubClientProtocol?alt=com.microsoft.azure.sdk.iot.device.IotHubClientProtocol&text=IotHubClientProtocol" data-throw-if-not-resolved="False"/>
|
|
returns:
|
|
type: <xref href="boolean?alt=boolean&text=boolean" data-throw-if-not-resolved="False"/>
|
|
syntax: public boolean isMessageAckNeeded(IotHubClientProtocol protocol)
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.isMessageAckNeeded(IotHubClientProtocol)
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setDeviceOperationType(DeviceOperations deviceOperationType)
|
|
name: setDeviceOperationType(DeviceOperations deviceOperationType)
|
|
nameWithType: IotHubTransportMessage.setDeviceOperationType(DeviceOperations deviceOperationType)
|
|
parameters:
|
|
- description: <p>The DeviceOperations enum value. </p>
|
|
name: deviceOperationType
|
|
type: <xref href="com.microsoft.azure.sdk.iot.device.twin.DeviceOperations?alt=com.microsoft.azure.sdk.iot.device.twin.DeviceOperations&text=DeviceOperations" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Setter for the device operation type </p>
|
|
syntax: public void setDeviceOperationType(DeviceOperations deviceOperationType)
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setDeviceOperationType(DeviceOperations)
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setIotHubMethod(HttpsMethod iotHubMethod)
|
|
name: setIotHubMethod(HttpsMethod iotHubMethod)
|
|
nameWithType: IotHubTransportMessage.setIotHubMethod(HttpsMethod iotHubMethod)
|
|
parameters:
|
|
- description: <p>The HTTPS method. </p>
|
|
name: iotHubMethod
|
|
type: <xref href="com.microsoft.azure.sdk.iot.device.transport.https.HttpsMethod?alt=com.microsoft.azure.sdk.iot.device.transport.https.HttpsMethod&text=HttpsMethod" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Setter for the IoT Hub method </p>
|
|
syntax: public void setIotHubMethod(HttpsMethod iotHubMethod)
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setIotHubMethod(HttpsMethod)
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setMessageCallback(MessageCallback messageCallback)
|
|
name: setMessageCallback(MessageCallback messageCallback)
|
|
nameWithType: IotHubTransportMessage.setMessageCallback(MessageCallback messageCallback)
|
|
parameters:
|
|
- name: messageCallback
|
|
type: <xref href="com.microsoft.azure.sdk.iot.device.MessageCallback?alt=com.microsoft.azure.sdk.iot.device.MessageCallback&text=MessageCallback" data-throw-if-not-resolved="False"/>
|
|
syntax: public void setMessageCallback(MessageCallback messageCallback)
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setMessageCallback(MessageCallback)
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setMessageCallbackContext(Object messageCallbackContext)
|
|
name: setMessageCallbackContext(Object messageCallbackContext)
|
|
nameWithType: IotHubTransportMessage.setMessageCallbackContext(Object messageCallbackContext)
|
|
parameters:
|
|
- name: messageCallbackContext
|
|
type: <xref href="Object?alt=Object&text=Object" data-throw-if-not-resolved="False"/>
|
|
syntax: public void setMessageCallbackContext(Object messageCallbackContext)
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setMessageCallbackContext(Object)
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setMethodName(String methodName)
|
|
name: setMethodName(String methodName)
|
|
nameWithType: IotHubTransportMessage.setMethodName(String methodName)
|
|
parameters:
|
|
- description: <p>The String containing the method name of device method operation. </p>
|
|
name: methodName
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Setter for the method name of device method operation </p>
|
|
syntax: public void setMethodName(String methodName)
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setMethodName(String)
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setRequestId(String id)
|
|
name: setRequestId(String id)
|
|
nameWithType: IotHubTransportMessage.setRequestId(String id)
|
|
parameters:
|
|
- description: <p>The String containing the id. </p>
|
|
name: id
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Setter for the message id </p>
|
|
syntax: public void setRequestId(String id)
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setRequestId(String)
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setStatus(String status)
|
|
name: setStatus(String status)
|
|
nameWithType: IotHubTransportMessage.setStatus(String status)
|
|
parameters:
|
|
- description: <p>The String containing the status. </p>
|
|
name: status
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Setter for the status </p>
|
|
syntax: public void setStatus(String status)
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setStatus(String)
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setUriPath(String uriPath)
|
|
name: setUriPath(String uriPath)
|
|
nameWithType: IotHubTransportMessage.setUriPath(String uriPath)
|
|
parameters:
|
|
- description: <p>The string with the URI path. </p>
|
|
name: uriPath
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Setter for the URI path </p>
|
|
syntax: public void setUriPath(String uriPath)
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setUriPath(String)
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setVersion(int version)
|
|
name: setVersion(int version)
|
|
nameWithType: IotHubTransportMessage.setVersion(int version)
|
|
parameters:
|
|
- description: <p>The String containing the version. </p>
|
|
name: version
|
|
type: <xref href="int?alt=int&text=int" data-throw-if-not-resolved="False"/>
|
|
summary: <p>Setter for the message version </p>
|
|
syntax: public void setVersion(int version)
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.setVersion(int)
|
|
- fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.toString()
|
|
name: toString()
|
|
nameWithType: IotHubTransportMessage.toString()
|
|
returns:
|
|
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
|
|
syntax: public String toString()
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage.toString()
|
|
nameWithType: IotHubTransportMessage
|
|
syntax: public class IotHubTransportMessage extends Message
|
|
type: class
|
|
uid: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage
|
|
fullName: com.microsoft.azure.sdk.iot.device.transport.IotHubTransportMessage
|
|
name: IotHubTransportMessage
|
|
package: com.microsoft.azure.sdk.iot.device.transport
|
|
summary: <p>Extends Message, adding transport artifacts. </p>
|
|
metadata: {}
|