SignOutRequestMessage.xml

<Type Name="SignOutRequestMessage" FullName="System.IdentityModel.Services.SignOutRequestMessage">
  <TypeSignature Language="C#" Value="public class SignOutRequestMessage : System.IdentityModel.Services.WSFederationMessage" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SignOutRequestMessage extends System.IdentityModel.Services.WSFederationMessage" />
  <TypeSignature Language="DocId" Value="T:System.IdentityModel.Services.SignOutRequestMessage" />
  <TypeSignature Language="VB.NET" Value="Public Class SignOutRequestMessage&#xA;Inherits WSFederationMessage" />
  <TypeSignature Language="F#" Value="type SignOutRequestMessage = class&#xA;    inherit WSFederationMessage" />
  <TypeSignature Language="C++ CLI" Value="public ref class SignOutRequestMessage : System::IdentityModel::Services::WSFederationMessage" />
  <AssemblyInfo>
    <AssemblyName>System.IdentityModel.Services</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.IdentityModel.Services.WSFederationMessage</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Represents a WS-Federation sign-out message. This message is created when the received message has the action parameter (wa) set to "wsignout1.0".</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 A WS-Federation sign-out message is sent by a relying party (RP) to a security token service (STS) to sign out of the current session with that STS. The wa parameter must be set to "wsignout1.0" and an optional wreply parameter may be set to indicate the URL to which the client should be redirected by the STS after sign-out completes.  
  
 A <xref:System.IdentityModel.Services.SignOutRequestMessage> message is created by the static methods of the <xref:System.IdentityModel.Services.WSFederationMessage> class, for example the <xref:System.IdentityModel.Services.WSFederationMessage.CreateFromUri%2A> method, when the wa parameter is set to "wsignout1.0".  
  
 [!INCLUDE[wif_wsfed_ref](~/includes/wif-wsfed-ref-md.md)]  
  
 ]]></format>
    </remarks>
    <altmember cref="T:System.IdentityModel.Services.SignOutCleanupRequestMessage" />
  </Docs>
  <Members>
    <MemberGroup MemberName=".ctor">
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel.Services</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Docs>
        <summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Services.SignOutRequestMessage" /> class.</summary>
      </Docs>
    </MemberGroup>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public SignOutRequestMessage (Uri baseUrl);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri baseUrl) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.IdentityModel.Services.SignOutRequestMessage.#ctor(System.Uri)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (baseUrl As Uri)" />
      <MemberSignature Language="F#" Value="new System.IdentityModel.Services.SignOutRequestMessage : Uri -&gt; System.IdentityModel.Services.SignOutRequestMessage" Usage="new System.IdentityModel.Services.SignOutRequestMessage baseUrl" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; SignOutRequestMessage(Uri ^ baseUrl);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel.Services</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="baseUrl" Type="System.Uri" />
      </Parameters>
      <Docs>
        <param name="baseUrl">The base URL to which this message applies.</param>
        <summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Services.SignOutRequestMessage" /> class with the specified base URL.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The wa message parameter (the <xref:System.IdentityModel.Services.WSFederationMessage.Action%2A> property) is initialized to "wsignout1.0".  
  
 ]]></format>
        </remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="baseUrl" /> is <see langword="null" />.</exception>
        <exception cref="T:System.IdentityModel.Services.WSFederationMessageException">
          <paramref name="baseUrl" /> is not a valid, absolute URI.</exception>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public SignOutRequestMessage (Uri baseUrl, string reply);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri baseUrl, string reply) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.IdentityModel.Services.SignOutRequestMessage.#ctor(System.Uri,System.String)" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (baseUrl As Uri, reply As String)" />
      <MemberSignature Language="F#" Value="new System.IdentityModel.Services.SignOutRequestMessage : Uri * string -&gt; System.IdentityModel.Services.SignOutRequestMessage" Usage="new System.IdentityModel.Services.SignOutRequestMessage (baseUrl, reply)" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; SignOutRequestMessage(Uri ^ baseUrl, System::String ^ reply);" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel.Services</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="baseUrl" Type="System.Uri" />
        <Parameter Name="reply" Type="System.String" />
      </Parameters>
      <Docs>
        <param name="baseUrl">The base URL to which this message applies.</param>
        <param name="reply">The value of the wreply parameter. The URL to which the reply should be sent.</param>
        <summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Services.SignOutRequestMessage" /> class with the specified base URL and wreply parameter.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The wa message parameter (the <xref:System.IdentityModel.Services.WSFederationMessage.Action%2A> property) is initialized to "wsignout1.0".  
  
 ]]></format>
        </remarks>
        <exception cref="T:System.ArgumentException">
          <paramref name="reply" /> is either empty or <see langword="null" />.  
  
 -or-  
  
 <paramref name="reply" /> is not a valid, absolute URI.</exception>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="baseUrl" /> is <see langword="null" />.</exception>
        <exception cref="T:System.IdentityModel.Services.WSFederationMessageException">
          <paramref name="baseUrl" /> is not a valid, absolute URI.</exception>
      </Docs>
    </Member>
    <Member MemberName="Reply">
      <MemberSignature Language="C#" Value="public string Reply { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Reply" />
      <MemberSignature Language="DocId" Value="P:System.IdentityModel.Services.SignOutRequestMessage.Reply" />
      <MemberSignature Language="VB.NET" Value="Public Property Reply As String" />
      <MemberSignature Language="F#" Value="member this.Reply : string with get, set" Usage="System.IdentityModel.Services.SignOutRequestMessage.Reply" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Reply { System::String ^ get(); void set(System::String ^ value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel.Services</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the wreply parameter of the message.</summary>
        <value>The value of the wreply parameter. This is the URL to which the browser should be redirected.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The wreply parameter specifies the URL to which the browser should be redirected after sign-out has been completed. The wreply parameter is optional. Set the <xref:System.IdentityModel.Services.SignOutRequestMessage> property to `null` or an empty string to remove the wreply parameter from the message.  
  
 ]]></format>
        </remarks>
        <exception cref="T:System.ArgumentException">An attempt to set a value that is not a valid, absolute URI occurs.</exception>
      </Docs>
    </Member>
    <Member MemberName="Validate">
      <MemberSignature Language="C#" Value="protected override void Validate ();" />
      <MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Validate() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.IdentityModel.Services.SignOutRequestMessage.Validate" />
      <MemberSignature Language="VB.NET" Value="Protected Overrides Sub Validate ()" />
      <MemberSignature Language="F#" Value="override this.Validate : unit -&gt; unit" Usage="signOutRequestMessage.Validate " />
      <MemberSignature Language="C++ CLI" Value="protected:&#xA; override void Validate();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel.Services</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Validates the current instance.</summary>
        <remarks>To be added.</remarks>
        <exception cref="T:System.InvalidOperationException">The wa parameter (the <see cref="P:System.IdentityModel.Services.WSFederationMessage.Action" /> property) is not set to "wsignout1.0".</exception>
      </Docs>
    </Member>
    <Member MemberName="Write">
      <MemberSignature Language="C#" Value="public override void Write (System.IO.TextWriter writer);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Write(class System.IO.TextWriter writer) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.IdentityModel.Services.SignOutRequestMessage.Write(System.IO.TextWriter)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Sub Write (writer As TextWriter)" />
      <MemberSignature Language="F#" Value="override this.Write : System.IO.TextWriter -&gt; unit" Usage="signOutRequestMessage.Write writer" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; override void Write(System::IO::TextWriter ^ writer);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.IdentityModel.Services</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="writer" Type="System.IO.TextWriter" />
      </Parameters>
      <Docs>
        <param name="writer">The writer to which to write the message.</param>
        <summary>Writes the message in query string form to the specified text writer.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 This method calls the <xref:System.IdentityModel.Services.SignOutRequestMessage.Validate%2A> method before writing the message.  
  
 ]]></format>
        </remarks>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="writer" /> is <see langword="null" />.</exception>
      </Docs>
    </Member>
  </Members>
</Type>