-
Notifications
You must be signed in to change notification settings - Fork 264
/
IotHubServiceException.xml
201 lines (201 loc) · 12.7 KB
/
IotHubServiceException.xml
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<Type Name="IotHubServiceException" FullName="Microsoft.Azure.Devices.IotHubServiceException">
<TypeSignature Language="C#" Value="public class IotHubServiceException : Exception" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit IotHubServiceException extends System.Exception" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.IotHubServiceException" />
<TypeSignature Language="VB.NET" Value="Public Class IotHubServiceException
Inherits Exception" />
<TypeSignature Language="F#" Value="type IotHubServiceException = class
 inherit Exception" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Exception</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Serializable]</AttributeName>
<AttributeName Language="F#">[<System.Serializable>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
The exception thrown when the client receives an error while communicating with IoT hub service.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IotHubServiceException (string message, Exception innerException = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string message, class System.Exception innerException) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.IotHubServiceException.#ctor(System.String,System.Exception)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (message As String, Optional innerException As Exception = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.IotHubServiceException : string * Exception -> Microsoft.Azure.Devices.IotHubServiceException" Usage="new Microsoft.Azure.Devices.IotHubServiceException (message, innerException)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="message" Type="System.String" />
<Parameter Name="innerException" Type="System.Exception" />
</Parameters>
<Docs>
<param name="message">The message that describes the error.</param>
<param name="innerException">An inner exception, if any.</param>
<summary>
Creates an instance of this class with the specified error message and optional inner exception.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IotHubServiceException (string message, System.Net.HttpStatusCode statusCode, Microsoft.Azure.Devices.IotHubServiceErrorCode errorCode, string trackingId = default, Exception innerException = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string message, valuetype System.Net.HttpStatusCode statusCode, valuetype Microsoft.Azure.Devices.IotHubServiceErrorCode errorCode, string trackingId, class System.Exception innerException) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.IotHubServiceException.#ctor(System.String,System.Net.HttpStatusCode,Microsoft.Azure.Devices.IotHubServiceErrorCode,System.String,System.Exception)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (message As String, statusCode As HttpStatusCode, errorCode As IotHubServiceErrorCode, Optional trackingId As String = Nothing, Optional innerException As Exception = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Devices.IotHubServiceException : string * System.Net.HttpStatusCode * Microsoft.Azure.Devices.IotHubServiceErrorCode * string * Exception -> Microsoft.Azure.Devices.IotHubServiceException" Usage="new Microsoft.Azure.Devices.IotHubServiceException (message, statusCode, errorCode, trackingId, innerException)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="message" Type="System.String" />
<Parameter Name="statusCode" Type="System.Net.HttpStatusCode" />
<Parameter Name="errorCode" Type="Microsoft.Azure.Devices.IotHubServiceErrorCode" />
<Parameter Name="trackingId" Type="System.String" />
<Parameter Name="innerException" Type="System.Exception" />
</Parameters>
<Docs>
<param name="message">The message that describes the error.</param>
<param name="statusCode">The 3-digit status code returned back in the hub service response.</param>
<param name="errorCode">The 6-digit error code representing a more specific error in details.</param>
<param name="trackingId">The service returned tracking Id associated with this particular error.</param>
<param name="innerException">The exception that is the cause of the current exception.</param>
<summary>
Creates an instance of this class with <see cref="T:System.Net.HttpStatusCode" />, <see cref="T:Microsoft.Azure.Devices.IotHubServiceErrorCode" />,
error message, a flag indicating if the error was transient, an optional tracking id and an optional reference
to the inner exception that caused this exception.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ErrorCode">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.IotHubServiceErrorCode ErrorCode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Devices.IotHubServiceErrorCode ErrorCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.IotHubServiceException.ErrorCode" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ErrorCode As IotHubServiceErrorCode" />
<MemberSignature Language="F#" Value="member this.ErrorCode : Microsoft.Azure.Devices.IotHubServiceErrorCode" Usage="Microsoft.Azure.Devices.IotHubServiceException.ErrorCode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.IotHubServiceErrorCode</ReturnType>
</ReturnValue>
<Docs>
<summary>
The specific error code in the IoT hub service response, if available.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetObjectData">
<MemberSignature Language="C#" Value="public override void GetObjectData (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void GetObjectData(class System.Runtime.Serialization.SerializationInfo info, valuetype System.Runtime.Serialization.StreamingContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Devices.IotHubServiceException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub GetObjectData (info As SerializationInfo, context As StreamingContext)" />
<MemberSignature Language="F#" Value="override this.GetObjectData : System.Runtime.Serialization.SerializationInfo * System.Runtime.Serialization.StreamingContext -> unit" Usage="iotHubServiceException.GetObjectData (info, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="info" Type="System.Runtime.Serialization.SerializationInfo" />
<Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
</Parameters>
<Docs>
<param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
<param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
<summary>
Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo" /> with information about the exception.
Use this to set <see cref="P:Microsoft.Azure.Devices.IotHubServiceException.IsTransient" /> and <see cref="P:Microsoft.Azure.Devices.IotHubServiceException.TrackingId" /> to the serialized object data.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsTransient">
<MemberSignature Language="C#" Value="public bool IsTransient { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsTransient" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.IotHubServiceException.IsTransient" />
<MemberSignature Language="VB.NET" Value="Public Property IsTransient As Boolean" />
<MemberSignature Language="F#" Value="member this.IsTransient : bool with get, set" Usage="Microsoft.Azure.Devices.IotHubServiceException.IsTransient" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Indicates if the error is transient and should be retried.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StatusCode">
<MemberSignature Language="C#" Value="public System.Net.HttpStatusCode StatusCode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Net.HttpStatusCode StatusCode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.IotHubServiceException.StatusCode" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StatusCode As HttpStatusCode" />
<MemberSignature Language="F#" Value="member this.StatusCode : System.Net.HttpStatusCode" Usage="Microsoft.Azure.Devices.IotHubServiceException.StatusCode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Net.HttpStatusCode</ReturnType>
</ReturnValue>
<Docs>
<summary>
The status code returned back in the IoT hub service response.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TrackingId">
<MemberSignature Language="C#" Value="public string TrackingId { get; protected internal set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TrackingId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.IotHubServiceException.TrackingId" />
<MemberSignature Language="VB.NET" Value="Public Property TrackingId As String" />
<MemberSignature Language="F#" Value="member this.TrackingId : string with get, set" Usage="Microsoft.Azure.Devices.IotHubServiceException.TrackingId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The service returned tracking Id associated with this particular error.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>