ICookieSpec.xml

<Type Name="ICookieSpec" FullName="Org.Apache.Http.Cookies.ICookieSpec">
  <TypeSignature Language="C#" Value="public interface ICookieSpec : Android.Runtime.IJavaObject, IDisposable, Java.Interop.IJavaPeerable" />
  <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit ICookieSpec implements class Android.Runtime.IJavaObject, class Java.Interop.IJavaPeerable, class System.IDisposable" />
  <TypeSignature Language="DocId" Value="T:Org.Apache.Http.Cookies.ICookieSpec" />
  <TypeSignature Language="F#" Value="type ICookieSpec = interface&#xA;    interface IJavaObject&#xA;    interface IDisposable&#xA;    interface IJavaPeerable" />
  <AssemblyInfo>
    <AssemblyName>Mono.Android</AssemblyName>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Interfaces>
    <Interface>
      <InterfaceName>Android.Runtime.IJavaObject</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>Java.Interop.IJavaPeerable</InterfaceName>
    </Interface>
    <Interface>
      <InterfaceName>System.IDisposable</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[Android.Runtime.Register("org/apache/http/cookie/CookieSpec", "", "Org.Apache.Http.Cookies.ICookieSpecInvoker")]</AttributeName>
      <AttributeName Language="F#">[&lt;Android.Runtime.Register("org/apache/http/cookie/CookieSpec", "", "Org.Apache.Http.Cookies.ICookieSpecInvoker")&gt;]</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName Language="C#">[System.Runtime.Versioning.ObsoletedOSPlatform("android22.0", "This class is obsoleted in this android platform")]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Runtime.Versioning.ObsoletedOSPlatform("android22.0", "This class is obsoleted in this android platform")&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs since="1">
    <summary>Defines the cookie management specification.</summary>
    <remarks>
      <para>
        <format type="text/html">
          <a href="https://developer.android.com/reference/org/apache/http/cookie/CookieSpec" title="Reference documentation">Android platform documentation</a>
        </format>
      </para>
      <para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
    </remarks>
    <since version="Added in API level 1" />
  </Docs>
  <Members>
    <Member MemberName="FormatCookies">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;Org.Apache.Http.IHeader&gt;? FormatCookies (System.Collections.Generic.IList&lt;Org.Apache.Http.Cookies.ICookie&gt;? cookies);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IList`1&lt;class Org.Apache.Http.IHeader&gt; FormatCookies(class System.Collections.Generic.IList`1&lt;class Org.Apache.Http.Cookies.ICookie&gt; cookies) cil managed" />
      <MemberSignature Language="DocId" Value="M:Org.Apache.Http.Cookies.ICookieSpec.FormatCookies(System.Collections.Generic.IList{Org.Apache.Http.Cookies.ICookie})" />
      <MemberSignature Language="F#" Value="abstract member FormatCookies : System.Collections.Generic.IList&lt;Org.Apache.Http.Cookies.ICookie&gt; -&gt; System.Collections.Generic.IList&lt;Org.Apache.Http.IHeader&gt;" Usage="iCookieSpec.FormatCookies cookies" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register("formatCookies", "(Ljava/util/List;)Ljava/util/List;", "GetFormatCookies_Ljava_util_List_Handler:Org.Apache.Http.Cookies.ICookieSpecInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register("formatCookies", "(Ljava/util/List;)Ljava/util/List;", "GetFormatCookies_Ljava_util_List_Handler:Org.Apache.Http.Cookies.ICookieSpecInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;Org.Apache.Http.IHeader&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="cookies" Type="System.Collections.Generic.IList&lt;Org.Apache.Http.Cookies.ICookie&gt;" />
      </Parameters>
      <Docs>
        <param name="cookies">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>
          <para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Match">
      <MemberSignature Language="C#" Value="public bool Match (Org.Apache.Http.Cookies.ICookie? cookie, Org.Apache.Http.Cookies.CookieOrigin? origin);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Match(class Org.Apache.Http.Cookies.ICookie cookie, class Org.Apache.Http.Cookies.CookieOrigin origin) cil managed" />
      <MemberSignature Language="DocId" Value="M:Org.Apache.Http.Cookies.ICookieSpec.Match(Org.Apache.Http.Cookies.ICookie,Org.Apache.Http.Cookies.CookieOrigin)" />
      <MemberSignature Language="F#" Value="abstract member Match : Org.Apache.Http.Cookies.ICookie * Org.Apache.Http.Cookies.CookieOrigin -&gt; bool" Usage="iCookieSpec.Match (cookie, origin)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register("match", "(Lorg/apache/http/cookie/Cookie;Lorg/apache/http/cookie/CookieOrigin;)Z", "GetMatch_Lorg_apache_http_cookie_Cookie_Lorg_apache_http_cookie_CookieOrigin_Handler:Org.Apache.Http.Cookies.ICookieSpecInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register("match", "(Lorg/apache/http/cookie/Cookie;Lorg/apache/http/cookie/CookieOrigin;)Z", "GetMatch_Lorg_apache_http_cookie_Cookie_Lorg_apache_http_cookie_CookieOrigin_Handler:Org.Apache.Http.Cookies.ICookieSpecInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="cookie" Type="Org.Apache.Http.Cookies.ICookie" />
        <Parameter Name="origin" Type="Org.Apache.Http.Cookies.CookieOrigin" />
      </Parameters>
      <Docs>
        <param name="cookie">the Cookie to be matched</param>
        <param name="origin">the target to test against</param>
        <summary>Determines if a Cookie matches the target location.</summary>
        <returns>To be added.</returns>
        <remarks>
          <para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
        <since version="Added in API level 1" />
      </Docs>
    </Member>
    <Member MemberName="Parse">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;Org.Apache.Http.Cookies.ICookie&gt;? Parse (Org.Apache.Http.IHeader? header, Org.Apache.Http.Cookies.CookieOrigin? origin);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Generic.IList`1&lt;class Org.Apache.Http.Cookies.ICookie&gt; Parse(class Org.Apache.Http.IHeader header, class Org.Apache.Http.Cookies.CookieOrigin origin) cil managed" />
      <MemberSignature Language="DocId" Value="M:Org.Apache.Http.Cookies.ICookieSpec.Parse(Org.Apache.Http.IHeader,Org.Apache.Http.Cookies.CookieOrigin)" />
      <MemberSignature Language="F#" Value="abstract member Parse : Org.Apache.Http.IHeader * Org.Apache.Http.Cookies.CookieOrigin -&gt; System.Collections.Generic.IList&lt;Org.Apache.Http.Cookies.ICookie&gt;" Usage="iCookieSpec.Parse (header, origin)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register("parse", "(Lorg/apache/http/Header;Lorg/apache/http/cookie/CookieOrigin;)Ljava/util/List;", "GetParse_Lorg_apache_http_Header_Lorg_apache_http_cookie_CookieOrigin_Handler:Org.Apache.Http.Cookies.ICookieSpecInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register("parse", "(Lorg/apache/http/Header;Lorg/apache/http/cookie/CookieOrigin;)Ljava/util/List;", "GetParse_Lorg_apache_http_Header_Lorg_apache_http_cookie_CookieOrigin_Handler:Org.Apache.Http.Cookies.ICookieSpecInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;Org.Apache.Http.Cookies.ICookie&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="header" Type="Org.Apache.Http.IHeader" />
        <Parameter Name="origin" Type="Org.Apache.Http.Cookies.CookieOrigin" />
      </Parameters>
      <Docs>
        <param name="header">the <c>Set-Cookie</c> received from the server</param>
        <param name="origin">details of the cookie origin</param>
        <summary>Parse the <c>"Set-Cookie"</c> Header into an array of Cookies.</summary>
        <returns>To be added.</returns>
        <remarks>
          <para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
        <since version="Added in API level 1" />
        <exception cref="T:Org.Apache.Http.Cookies.MalformedCookieException">if an exception occurs during parsing
</exception>
        <altmember cref="M:Org.Apache.Http.Cookies.ICookieSpec.Validate(Org.Apache.Http.Cookies.ICookie, Org.Apache.Http.Cookies.CookieOrigin)" />
      </Docs>
    </Member>
    <Member MemberName="Validate">
      <MemberSignature Language="C#" Value="public void Validate (Org.Apache.Http.Cookies.ICookie? cookie, Org.Apache.Http.Cookies.CookieOrigin? origin);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate(class Org.Apache.Http.Cookies.ICookie cookie, class Org.Apache.Http.Cookies.CookieOrigin origin) cil managed" />
      <MemberSignature Language="DocId" Value="M:Org.Apache.Http.Cookies.ICookieSpec.Validate(Org.Apache.Http.Cookies.ICookie,Org.Apache.Http.Cookies.CookieOrigin)" />
      <MemberSignature Language="F#" Value="abstract member Validate : Org.Apache.Http.Cookies.ICookie * Org.Apache.Http.Cookies.CookieOrigin -&gt; unit" Usage="iCookieSpec.Validate (cookie, origin)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[Android.Runtime.Register("validate", "(Lorg/apache/http/cookie/Cookie;Lorg/apache/http/cookie/CookieOrigin;)V", "GetValidate_Lorg_apache_http_cookie_Cookie_Lorg_apache_http_cookie_CookieOrigin_Handler:Org.Apache.Http.Cookies.ICookieSpecInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
          <AttributeName Language="F#">[&lt;Android.Runtime.Register("validate", "(Lorg/apache/http/cookie/Cookie;Lorg/apache/http/cookie/CookieOrigin;)V", "GetValidate_Lorg_apache_http_cookie_Cookie_Lorg_apache_http_cookie_CookieOrigin_Handler:Org.Apache.Http.Cookies.ICookieSpecInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="cookie" Type="Org.Apache.Http.Cookies.ICookie" />
        <Parameter Name="origin" Type="Org.Apache.Http.Cookies.CookieOrigin" />
      </Parameters>
      <Docs>
        <param name="cookie">the Cookie to validate</param>
        <param name="origin">details of the cookie origin</param>
        <summary>Validate the cookie according to validation rules defined by the 
  cookie specification.</summary>
        <remarks>
          <para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
        <since version="Added in API level 1" />
        <exception cref="T:Org.Apache.Http.Cookies.MalformedCookieException">if the cookie is invalid
</exception>
      </Docs>
    </Member>
    <Member MemberName="Version">
      <MemberSignature Language="C#" Value="public int Version { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 Version" />
      <MemberSignature Language="DocId" Value="P:Org.Apache.Http.Cookies.ICookieSpec.Version" />
      <MemberSignature Language="F#" Value="member this.Version : int" Usage="Org.Apache.Http.Cookies.ICookieSpec.Version" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[get: Android.Runtime.Register("getVersion", "()I", "GetGetVersionHandler:Org.Apache.Http.Cookies.ICookieSpecInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: Android.Runtime.Register("getVersion", "()I", "GetGetVersionHandler:Org.Apache.Http.Cookies.ICookieSpecInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Returns version of the state management this cookie specification
 conforms to.</summary>
        <value>To be added.</value>
        <remarks>
          <para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
        <since version="Added in API level 1" />
      </Docs>
    </Member>
    <Member MemberName="VersionHeader">
      <MemberSignature Language="C#" Value="public Org.Apache.Http.IHeader? VersionHeader { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Org.Apache.Http.IHeader VersionHeader" />
      <MemberSignature Language="DocId" Value="P:Org.Apache.Http.Cookies.ICookieSpec.VersionHeader" />
      <MemberSignature Language="F#" Value="member this.VersionHeader : Org.Apache.Http.IHeader" Usage="Org.Apache.Http.Cookies.ICookieSpec.VersionHeader" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Mono.Android</AssemblyName>
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[get: Android.Runtime.Register("getVersionHeader", "()Lorg/apache/http/Header;", "GetGetVersionHeaderHandler:Org.Apache.Http.Cookies.ICookieSpecInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: Android.Runtime.Register("getVersionHeader", "()Lorg/apache/http/Header;", "GetGetVersionHeaderHandler:Org.Apache.Http.Cookies.ICookieSpecInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Org.Apache.Http.IHeader</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Returns a request header identifying what version of the state management 
 specification is understood.</summary>
        <value>To be added.</value>
        <remarks>
          <para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
        </remarks>
        <since version="Added in API level 1" />
      </Docs>
    </Member>
  </Members>
</Type>