-
Notifications
You must be signed in to change notification settings - Fork 256
/
ConnectionMessage.xml
210 lines (210 loc) · 10.6 KB
/
ConnectionMessage.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
202
203
204
205
206
207
208
209
210
<Type Name="ConnectionMessage" FullName="Microsoft.CognitiveServices.Speech.ConnectionMessage">
<TypeSignature Language="C#" Value="public class ConnectionMessage" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ConnectionMessage extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.CognitiveServices.Speech.ConnectionMessage" />
<TypeSignature Language="VB.NET" Value="Public Class ConnectionMessage" />
<TypeSignature Language="F#" Value="type ConnectionMessage = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.16.0.28</AssemblyVersion>
<AssemblyVersion>1.17.0.28</AssemblyVersion>
<AssemblyVersion>1.18.0.28</AssemblyVersion>
<AssemblyVersion>1.19.0.28</AssemblyVersion>
<AssemblyVersion>1.20.0.28</AssemblyVersion>
<AssemblyVersion>1.21.0.28</AssemblyVersion>
<AssemblyVersion>1.22.0.28</AssemblyVersion>
<AssemblyVersion>1.23.0.28</AssemblyVersion>
<AssemblyVersion>1.24.0.28</AssemblyVersion>
<AssemblyVersion>1.24.1.28</AssemblyVersion>
<AssemblyVersion>1.25.1.26</AssemblyVersion>
<AssemblyVersion>1.27.0.28</AssemblyVersion>
<AssemblyVersion>1.28.0.28</AssemblyVersion>
<AssemblyVersion>1.30.0.28</AssemblyVersion>
<AssemblyVersion>1.31.0.28</AssemblyVersion>
<AssemblyVersion>1.32.1.28</AssemblyVersion>
<AssemblyVersion>1.34.0.28</AssemblyVersion>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents implementation-specific messages sent to and received from
the speech service. For debugging only. Added in 1.10.0
</summary>
<remarks>
These messages are provided for debugging purposes and should not
be used for production use cases with the Azure Cognitive Services Speech Service.
Messages sent to and received from the Speech Service are subject to change without
notice. This includes message contents, headers, payloads, ordering, etc.
</remarks>
</Docs>
<Members>
<Member MemberName="GetBinaryMessage">
<MemberSignature Language="C#" Value="public byte[] GetBinaryMessage ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int8[] GetBinaryMessage() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.ConnectionMessage.GetBinaryMessage" />
<MemberSignature Language="VB.NET" Value="Public Function GetBinaryMessage () As Byte()" />
<MemberSignature Language="F#" Value="member this.GetBinaryMessage : unit -> byte[]" Usage="connectionMessage.GetBinaryMessage " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Gets the binary message payload.
</summary>
<returns>An array of bytes containing the binary message.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetTextMessage">
<MemberSignature Language="C#" Value="public string GetTextMessage ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetTextMessage() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.ConnectionMessage.GetTextMessage" />
<MemberSignature Language="VB.NET" Value="Public Function GetTextMessage () As String" />
<MemberSignature Language="F#" Value="member this.GetTextMessage : unit -> string" Usage="connectionMessage.GetTextMessage " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Gets the text message payload. Typically the text message content-type is
application/json. To determine other content-types use
Properties.GetProperty("Content-Type").
</summary>
<returns>A string containing the text message.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsBinaryMessage">
<MemberSignature Language="C#" Value="public bool IsBinaryMessage ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsBinaryMessage() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.ConnectionMessage.IsBinaryMessage" />
<MemberSignature Language="VB.NET" Value="Public Function IsBinaryMessage () As Boolean" />
<MemberSignature Language="F#" Value="member this.IsBinaryMessage : unit -> bool" Usage="connectionMessage.IsBinaryMessage " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Checks to see if the ConnectionMessage is a binary message.
See also GetBinaryMessage().
</summary>
<returns>A bool indicating if the message payload is binary.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsTextMessage">
<MemberSignature Language="C#" Value="public bool IsTextMessage ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool IsTextMessage() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.ConnectionMessage.IsTextMessage" />
<MemberSignature Language="VB.NET" Value="Public Function IsTextMessage () As Boolean" />
<MemberSignature Language="F#" Value="member this.IsTextMessage : unit -> bool" Usage="connectionMessage.IsTextMessage " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Checks to see if the ConnectionMessage is a text message.
See also IsBinaryMessage().
</summary>
<returns>A bool indicating if the message payload is text.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Path">
<MemberSignature Language="C#" Value="public string Path { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Path" />
<MemberSignature Language="DocId" Value="P:Microsoft.CognitiveServices.Speech.ConnectionMessage.Path" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Path As String" />
<MemberSignature Language="F#" Value="member this.Path : string" Usage="Microsoft.CognitiveServices.Speech.ConnectionMessage.Path" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
A string that specifies the message type.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="public Microsoft.CognitiveServices.Speech.PropertyCollection Properties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.CognitiveServices.Speech.PropertyCollection Properties" />
<MemberSignature Language="DocId" Value="P:Microsoft.CognitiveServices.Speech.ConnectionMessage.Properties" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Properties As PropertyCollection" />
<MemberSignature Language="F#" Value="member this.Properties : Microsoft.CognitiveServices.Speech.PropertyCollection" Usage="Microsoft.CognitiveServices.Speech.ConnectionMessage.Properties" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.CognitiveServices.Speech.PropertyCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>
A collection of properties and their values defined for this <see cref="T:Microsoft.CognitiveServices.Speech.ConnectionMessage" />.
Message headers can be accessed via this collection (e.g. "Content-Type").
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.ConnectionMessage.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="connectionMessage.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns a string that represents the connection message.
</summary>
<returns>A string that represents the connection message.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>