-
Notifications
You must be signed in to change notification settings - Fork 264
/
ConnectionStatusInfo.xml
120 lines (120 loc) · 6.45 KB
/
ConnectionStatusInfo.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
<Type Name="ConnectionStatusInfo" FullName="Microsoft.Azure.Devices.Client.ConnectionStatusInfo">
<TypeSignature Language="C#" Value="public class ConnectionStatusInfo" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ConnectionStatusInfo extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Devices.Client.ConnectionStatusInfo" />
<TypeSignature Language="VB.NET" Value="Public Class ConnectionStatusInfo" />
<TypeSignature Language="F#" Value="type ConnectionStatusInfo = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The connection status information since the last status change.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="ChangeReason">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.Client.ConnectionStatusChangeReason ChangeReason { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Devices.Client.ConnectionStatusChangeReason ChangeReason" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.ConnectionStatusInfo.ChangeReason" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ChangeReason As ConnectionStatusChangeReason" />
<MemberSignature Language="F#" Value="member this.ChangeReason : Microsoft.Azure.Devices.Client.ConnectionStatusChangeReason" Usage="Microsoft.Azure.Devices.Client.ConnectionStatusInfo.ChangeReason" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.Client.ConnectionStatusChangeReason</ReturnType>
</ReturnValue>
<Docs>
<summary>
The reason for the current connection status change.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remark>
Defaults to <see cref="F:Microsoft.Azure.Devices.Client.ConnectionStatusChangeReason.ClientClosed" />.
</remark>
</Docs>
</Member>
<Member MemberName="RecommendedAction">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.Client.RecommendedAction RecommendedAction { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Devices.Client.RecommendedAction RecommendedAction" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.ConnectionStatusInfo.RecommendedAction" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property RecommendedAction As RecommendedAction" />
<MemberSignature Language="F#" Value="member this.RecommendedAction : Microsoft.Azure.Devices.Client.RecommendedAction" Usage="Microsoft.Azure.Devices.Client.ConnectionStatusInfo.RecommendedAction" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.Client.RecommendedAction</ReturnType>
</ReturnValue>
<Docs>
<summary>
Recommended actions for users to take upon different ConnectionStatus and ConnectionStatusChangeReason.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remark>
Defaults to <see cref="F:Microsoft.Azure.Devices.Client.RecommendedAction.OpenConnection" />.
</remark>
</Docs>
</Member>
<Member MemberName="Status">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Devices.Client.ConnectionStatus Status { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Devices.Client.ConnectionStatus Status" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.ConnectionStatusInfo.Status" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Status As ConnectionStatus" />
<MemberSignature Language="F#" Value="member this.Status : Microsoft.Azure.Devices.Client.ConnectionStatus" Usage="Microsoft.Azure.Devices.Client.ConnectionStatusInfo.Status" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Devices.Client.ConnectionStatus</ReturnType>
</ReturnValue>
<Docs>
<summary>
The current connection status of the device or module.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remark>
Defaults to <see cref="F:Microsoft.Azure.Devices.Client.ConnectionStatus.Disconnected" />.
</remark>
</Docs>
</Member>
<Member MemberName="StatusLastChangedOnUtc">
<MemberSignature Language="C#" Value="public DateTimeOffset StatusLastChangedOnUtc { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTimeOffset StatusLastChangedOnUtc" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Devices.Client.ConnectionStatusInfo.StatusLastChangedOnUtc" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StatusLastChangedOnUtc As DateTimeOffset" />
<MemberSignature Language="F#" Value="member this.StatusLastChangedOnUtc : DateTimeOffset" Usage="Microsoft.Azure.Devices.Client.ConnectionStatusInfo.StatusLastChangedOnUtc" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Devices.Client</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTimeOffset</ReturnType>
</ReturnValue>
<Docs>
<summary>
Timestamp in UTC when the last connection status was changed.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>