/
com.microsoft.azure.sdk.iot.device.ResponseMessage.yml
99 lines (99 loc) · 13.3 KB
/
com.microsoft.azure.sdk.iot.device.ResponseMessage.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
### YamlMime:JavaType
uid: "com.microsoft.azure.sdk.iot.device.ResponseMessage"
fullName: "com.microsoft.azure.sdk.iot.device.ResponseMessage"
name: "ResponseMessage"
nameWithType: "ResponseMessage"
summary: "Extend Message to support status response"
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 final class **ResponseMessage**</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.ResponseMessage.ResponseMessage(byte[],com.microsoft.azure.sdk.iot.device.IotHubStatusCode)"
fullName: "com.microsoft.azure.sdk.iot.device.ResponseMessage.ResponseMessage(byte[] body, IotHubStatusCode status)"
name: "ResponseMessage(byte[] body, IotHubStatusCode status)"
nameWithType: "ResponseMessage.ResponseMessage(byte[] body, IotHubStatusCode status)"
summary: "CONSTRUCTOR"
parameters:
- description: "is the byte array with the response message payload"
name: "body"
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
- description: "is the response status"
name: "status"
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.IotHubStatusCode?alt=com.microsoft.azure.sdk.iot.device.IotHubStatusCode&text=IotHubStatusCode\" data-throw-if-not-resolved=\"False\" />"
syntax: "public ResponseMessage(byte[] body, IotHubStatusCode status)"
desc: "CONSTRUCTOR"
methods:
- uid: "com.microsoft.azure.sdk.iot.device.ResponseMessage.getStatus()"
fullName: "com.microsoft.azure.sdk.iot.device.ResponseMessage.getStatus()"
name: "getStatus()"
nameWithType: "ResponseMessage.getStatus()"
summary: "Getter for the status"
syntax: "public IotHubStatusCode getStatus()"
desc: "Getter for the status"
returns:
description: "the status code"
type: "<xref href=\"com.microsoft.azure.sdk.iot.device.IotHubStatusCode?alt=com.microsoft.azure.sdk.iot.device.IotHubStatusCode&text=IotHubStatusCode\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Extend Message to support status response"
metadata: {}
package: "com.microsoft.azure.sdk.iot.device"
artifact: com.microsoft.azure.sdk.iot:iot-device-client:1.30.1