websocket-sharp/websocket-sharp/doc/mdoc/WebSocketSharp/MessageEventArgs.xml

75 lines
2.9 KiB
XML

<Type Name="MessageEventArgs" FullName="WebSocketSharp.MessageEventArgs">
<TypeSignature Language="C#" Value="public class MessageEventArgs : EventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MessageEventArgs extends System.EventArgs" />
<AssemblyInfo>
<AssemblyName>websocket-sharp</AssemblyName>
</AssemblyInfo>
<Base>
<BaseTypeName>System.EventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Contains the event data associated with a <see cref="E:WebSocketSharp.WebSocket.OnMessage" /> event.
</summary>
<remarks>
The <see cref="E:WebSocketSharp.WebSocket.OnMessage" /> event occurs when the WebSocket receives a text or binary data frame.
If you want to get the received data, you should access the <see cref="P:WebSocketSharp.MessageEventArgs.Data" /> or
<see cref="P:WebSocketSharp.MessageEventArgs.RawData" /> properties.
</remarks>
</Docs>
<Members>
<Member MemberName="Data">
<MemberSignature Language="C#" Value="public string Data { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Data" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the received data as a <see cref="T:System.String" />.
</summary>
<value>
A <see cref="T:System.String" /> that contains the received data.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RawData">
<MemberSignature Language="C#" Value="public byte[] RawData { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int8[] RawData" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the received data as an array of <see cref="T:System.Byte" />.
</summary>
<value>
An array of <see cref="T:System.Byte" /> that contains the received data.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public WebSocketSharp.Opcode Type { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype WebSocketSharp.Opcode Type" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>WebSocketSharp.Opcode</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the type of the received data.
</summary>
<value>
One of the <see cref="T:WebSocketSharp.Opcode" /> values that indicates the type of the received data.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>