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