You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
511 lines
20 KiB
XML
511 lines
20 KiB
XML
<Type Name="Cookie" FullName="WebSocketSharp.Net.Cookie">
|
|
<TypeSignature Language="C#" Value="public sealed class Cookie" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable sealed beforefieldinit Cookie extends System.Object" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>websocket-sharp</AssemblyName>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<summary>
|
|
Provides a set of properties and methods to use to manage the HTTP Cookie.
|
|
</summary>
|
|
<remarks>
|
|
The Cookie class cannot be inherited.
|
|
</remarks>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Cookie ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie" /> class.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Cookie (string name, string value);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, string value) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="name" Type="System.String" />
|
|
<Parameter Name="value" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="name">
|
|
A <see cref="T:System.String" /> that contains the Name of the cookie.
|
|
</param>
|
|
<param name="value">
|
|
A <see cref="T:System.String" /> that contains the Value of the cookie.
|
|
</param>
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie" /> class
|
|
with the specified <paramref name="name" /> and <paramref name="value" />.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:WebSocketSharp.Net.CookieException">
|
|
<para>
|
|
<paramref name="name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.
|
|
</para>
|
|
<para>
|
|
- or -
|
|
</para>
|
|
<para>
|
|
<paramref name="name" /> contains an invalid character.
|
|
</para>
|
|
<para>
|
|
- or -
|
|
</para>
|
|
<para>
|
|
<paramref name="value" /> is <see langword="null" />.
|
|
</para>
|
|
<para>
|
|
- or -
|
|
</para>
|
|
<para>
|
|
<paramref name="value" /> contains a string not enclosed in double quotes
|
|
that contains an invalid character.
|
|
</para>
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Cookie (string name, string value, string path);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, string value, string path) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="name" Type="System.String" />
|
|
<Parameter Name="value" Type="System.String" />
|
|
<Parameter Name="path" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="name">
|
|
A <see cref="T:System.String" /> that contains the Name of the cookie.
|
|
</param>
|
|
<param name="value">
|
|
A <see cref="T:System.String" /> that contains the Value of the cookie.
|
|
</param>
|
|
<param name="path">
|
|
A <see cref="T:System.String" /> that contains the value of the Path attribute of the cookie.
|
|
</param>
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie" /> class
|
|
with the specified <paramref name="name" />, <paramref name="value" /> and <paramref name="path" />.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:WebSocketSharp.Net.CookieException">
|
|
<para>
|
|
<paramref name="name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.
|
|
</para>
|
|
<para>
|
|
- or -
|
|
</para>
|
|
<para>
|
|
<paramref name="name" /> contains an invalid character.
|
|
</para>
|
|
<para>
|
|
- or -
|
|
</para>
|
|
<para>
|
|
<paramref name="value" /> is <see langword="null" />.
|
|
</para>
|
|
<para>
|
|
- or -
|
|
</para>
|
|
<para>
|
|
<paramref name="value" /> contains a string not enclosed in double quotes
|
|
that contains an invalid character.
|
|
</para>
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Cookie (string name, string value, string path, string domain);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, string value, string path, string domain) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="name" Type="System.String" />
|
|
<Parameter Name="value" Type="System.String" />
|
|
<Parameter Name="path" Type="System.String" />
|
|
<Parameter Name="domain" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="name">
|
|
A <see cref="T:System.String" /> that contains the Name of the cookie.
|
|
</param>
|
|
<param name="value">
|
|
A <see cref="T:System.String" /> that contains the Value of the cookie.
|
|
</param>
|
|
<param name="path">
|
|
A <see cref="T:System.String" /> that contains the value of the Path attribute of the cookie.
|
|
</param>
|
|
<param name="domain">
|
|
A <see cref="T:System.String" /> that contains the value of the Domain attribute of the cookie.
|
|
</param>
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:WebSocketSharp.Net.Cookie" /> class
|
|
with the specified <paramref name="name" />, <paramref name="value" />,
|
|
<paramref name="path" /> and <paramref name="domain" />.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:WebSocketSharp.Net.CookieException">
|
|
<para>
|
|
<paramref name="name" /> is <see langword="null" /> or <see cref="F:System.String.Empty" />.
|
|
</para>
|
|
<para>
|
|
- or -
|
|
</para>
|
|
<para>
|
|
<paramref name="name" /> contains an invalid character.
|
|
</para>
|
|
<para>
|
|
- or -
|
|
</para>
|
|
<para>
|
|
<paramref name="value" /> is <see langword="null" />.
|
|
</para>
|
|
<para>
|
|
- or -
|
|
</para>
|
|
<para>
|
|
<paramref name="value" /> contains a string not enclosed in double quotes
|
|
that contains an invalid character.
|
|
</para>
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Comment">
|
|
<MemberSignature Language="C#" Value="public string Comment { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Comment" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets or sets the value of the Comment attribute of the cookie.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.String" /> that contains a comment to document intended use of the cookie.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="CommentUri">
|
|
<MemberSignature Language="C#" Value="public Uri CommentUri { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri CommentUri" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Uri</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets or sets the value of the CommentURL attribute of the cookie.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.Uri" /> that contains a URI that provides the comment
|
|
to document intended use of the cookie.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Discard">
|
|
<MemberSignature Language="C#" Value="public bool Discard { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool Discard" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets or sets a value indicating whether the client discards the cookie unconditionally
|
|
when the client terminates.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the client discards the cookie unconditionally when the client terminates;
|
|
otherwise, <c>false</c>. The default is <c>false</c>.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Domain">
|
|
<MemberSignature Language="C#" Value="public string Domain { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Domain" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets or sets the value of the Domain attribute of the cookie.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.String" /> that contains a URI for which the cookie is valid.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Equals">
|
|
<MemberSignature Language="C#" Value="public override bool Equals (object comparand);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object comparand) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="comparand" Type="System.Object" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="comparand">
|
|
An <see cref="T:System.Object" /> to compare with the current <see cref="T:WebSocketSharp.Net.Cookie" />.
|
|
</param>
|
|
<summary>
|
|
Determines whether the specified <see cref="T:System.Object" /> is equal to the current <see cref="T:WebSocketSharp.Net.Cookie" />.
|
|
</summary>
|
|
<returns>
|
|
<c>true</c> if the specified <see cref="T:System.Object" /> is equal to the current <see cref="T:WebSocketSharp.Net.Cookie" />;
|
|
otherwise, <c>false</c>.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Expired">
|
|
<MemberSignature Language="C#" Value="public bool Expired { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool Expired" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets or sets a value indicating whether the cookie has expired.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the cookie has expired; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Expires">
|
|
<MemberSignature Language="C#" Value="public DateTime Expires { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime Expires" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.DateTime</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets or sets the value of the Expires attribute of the cookie.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.DateTime" /> that contains the date and time at which the cookie expires.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetHashCode">
|
|
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Serves as a hash function for a <see cref="T:WebSocketSharp.Net.Cookie" /> object.
|
|
</summary>
|
|
<returns>
|
|
An <see cref="T:System.Int32" /> that contains a hash code for this instance.
|
|
</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="HttpOnly">
|
|
<MemberSignature Language="C#" Value="public bool HttpOnly { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool HttpOnly" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets or sets a value indicating non-HTTP APIs can access the cookie.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if non-HTTP APIs can not access the cookie; otherwise, <c>false</c>.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Name">
|
|
<MemberSignature Language="C#" Value="public string Name { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets or sets the Name of the cookie.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.String" /> that contains the Name of the cookie.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:WebSocketSharp.Net.CookieException">
|
|
<para>
|
|
The value specified for a set operation is <see langword="null" /> or <see cref="F:System.String.Empty" />.
|
|
</para>
|
|
<para>
|
|
- or -
|
|
</para>
|
|
<para>
|
|
The value specified for a set operation contains an invalid character.
|
|
</para>
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Path">
|
|
<MemberSignature Language="C#" Value="public string Path { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Path" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets or sets the value of the Path attribute of the cookie.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.String" /> that contains a subset of URI on the origin server
|
|
to which the cookie applies.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Port">
|
|
<MemberSignature Language="C#" Value="public string Port { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Port" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets or sets the value of the Port attribute of the cookie.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.String" /> that contains a list of the TCP ports to which the cookie applies.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:WebSocketSharp.Net.CookieException">
|
|
The value specified for a set operation could not be parsed or is not enclosed in double quotes.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Secure">
|
|
<MemberSignature Language="C#" Value="public bool Secure { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance bool Secure" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets or sets a value indicating whether the security level of the cookie is secure.
|
|
</summary>
|
|
<value>
|
|
<c>true</c> if the security level of the cookie is secure; otherwise, <c>false</c>.
|
|
The default is <c>false</c>.
|
|
</value>
|
|
<remarks>
|
|
When this property is <c>true</c>, the cookie may be included in the HTTP request
|
|
only if the request is transmitted over the HTTPS.
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="TimeStamp">
|
|
<MemberSignature Language="C#" Value="public DateTime TimeStamp { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime TimeStamp" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.DateTime</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets the time when the cookie was issued.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.DateTime" /> that contains the time when the cookie was issued.
|
|
</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" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Returns a <see cref="T:System.String" /> that represents the current <see cref="T:WebSocketSharp.Net.Cookie" />.
|
|
</summary>
|
|
<returns>
|
|
A <see cref="T:System.String" /> that represents the current <see cref="T:WebSocketSharp.Net.Cookie" />.
|
|
</returns>
|
|
<remarks>
|
|
This method returns a <see cref="T:System.String" /> to use to send an HTTP Cookie to an origin server.
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Value">
|
|
<MemberSignature Language="C#" Value="public string Value { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string Value" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets or sets the Value of the cookie.
|
|
</summary>
|
|
<value>
|
|
A <see cref="T:System.String" /> that contains the Value of the cookie.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Version">
|
|
<MemberSignature Language="C#" Value="public int Version { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 Version" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
Gets or sets the value of the Version attribute of the cookie.
|
|
</summary>
|
|
<value>
|
|
An <see cref="T:System.Int32" /> that contains the version of the HTTP state management
|
|
to which the cookie conforms.
|
|
</value>
|
|
<remarks>To be added.</remarks>
|
|
<exception cref="T:System.ArgumentOutOfRangeException">
|
|
The value specified for a set operation is less than zero.
|
|
</exception>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|