DeflateCookieTransform.xml

<Type Name="DeflateCookieTransform" FullName="System.IdentityModel.DeflateCookieTransform">
  <TypeSignature Language="C#" Value="public sealed class DeflateCookieTransform : System.IdentityModel.CookieTransform" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit DeflateCookieTransform extends System.IdentityModel.CookieTransform" />
  <TypeSignature Language="DocId" Value="T:System.IdentityModel.DeflateCookieTransform" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class DeflateCookieTransform&#xA;Inherits CookieTransform" />
  <TypeSignature Language="F#" Value="type DeflateCookieTransform = class&#xA;    inherit CookieTransform" />
  <TypeSignature Language="C++ CLI" Value="public ref class DeflateCookieTransform sealed : System::IdentityModel::CookieTransform" />
  <AssemblyInfo>
    <AssemblyName>System.IdentityModel</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.IdentityModel.CookieTransform</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Provides cookie compression using <see cref="T:System.IO.Compression.DeflateStream" />.</summary>
    <remarks>To be added.</remarks>
    <altmember cref="T:System.IdentityModel.Tokens.SessionSecurityTokenHandler" />
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public DeflateCookieTransform ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.IdentityModel.DeflateCookieTransform.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; DeflateCookieTransform();" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>Initializes a new instance of the <see cref="T:System.IdentityModel.DeflateCookieTransform" /> class.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Decode">
      <MemberSignature Language="C#" Value="public override byte[] Decode (byte[] encoded);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance unsigned int8[] Decode(unsigned int8[] encoded) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.IdentityModel.DeflateCookieTransform.Decode(System.Byte[])" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function Decode (encoded As Byte()) As Byte()" />
      <MemberSignature Language="F#" Value="override this.Decode : byte[] -&gt; byte[]" Usage="deflateCookieTransform.Decode encoded" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; override cli::array &lt;System::Byte&gt; ^ Decode(cli::array &lt;System::Byte&gt; ^ encoded);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Byte[]</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="encoded" Type="System.Byte[]" />
      </Parameters>
      <Docs>
        <param name="encoded">Data previously returned from <see cref="M:System.IdentityModel.DeflateCookieTransform.Encode(System.Byte[])" />.</param>
        <summary>Inflates data.</summary>
        <returns>The decoded data.</returns>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="value" /> is <see langword="null" />.</exception>
        <exception cref="T:System.ArgumentException">
          <paramref name="value" /> contains zero bytes.</exception>
        <exception cref="T:System.IdentityModel.Tokens.SecurityTokenException">The decompressed length is larger than the maximum length specified by the <see cref="P:System.IdentityModel.DeflateCookieTransform.MaxDecompressedSize" /> property.</exception>
      </Docs>
    </Member>
    <Member MemberName="Encode">
      <MemberSignature Language="C#" Value="public override byte[] Encode (byte[] value);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance unsigned int8[] Encode(unsigned int8[] value) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.IdentityModel.DeflateCookieTransform.Encode(System.Byte[])" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function Encode (value As Byte()) As Byte()" />
      <MemberSignature Language="F#" Value="override this.Encode : byte[] -&gt; byte[]" Usage="deflateCookieTransform.Encode value" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; override cli::array &lt;System::Byte&gt; ^ Encode(cli::array &lt;System::Byte&gt; ^ value);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Byte[]</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="System.Byte[]" />
      </Parameters>
      <Docs>
        <param name="value">The data to be compressed.</param>
        <summary>Deflates data.</summary>
        <returns>The compressed data.</returns>
        <remarks>To be added.</remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="value" /> is <see langword="null" />.</exception>
        <exception cref="T:System.ArgumentException">
          <paramref name="value" /> contains zero bytes.</exception>
      </Docs>
    </Member>
    <Member MemberName="MaxDecompressedSize">
      <MemberSignature Language="C#" Value="public int MaxDecompressedSize { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 MaxDecompressedSize" />
      <MemberSignature Language="DocId" Value="P:System.IdentityModel.DeflateCookieTransform.MaxDecompressedSize" />
      <MemberSignature Language="VB.NET" Value="Public Property MaxDecompressedSize As Integer" />
      <MemberSignature Language="F#" Value="member this.MaxDecompressedSize : int with get, set" Usage="System.IdentityModel.DeflateCookieTransform.MaxDecompressedSize" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property int MaxDecompressedSize { int get(); void set(int value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the maximum size, in bytes, of a decompressed cookie.</summary>
        <value>The maximum size, in bytes, of a decompressed cookie.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>