SignOutRequestMessage Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a WS-Federation sign-out message. This message is created when the received message has the action parameter (wa) set to "wsignout1.0".
public ref class SignOutRequestMessage : System::IdentityModel::Services::WSFederationMessagepublic class SignOutRequestMessage : System.IdentityModel.Services.WSFederationMessagetype SignOutRequestMessage = class
inherit WSFederationMessagePublic Class SignOutRequestMessage
Inherits WSFederationMessage- Inheritance
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 SignOutRequestMessage message is created by the static methods of the WSFederationMessage class, for example the CreateFromUri method, when the wa parameter is set to "wsignout1.0".
For more information about the message that this class represents, see section 13 of the following specification: Web Services Federation Language (WS-Federation) Version 1.2.
Constructors
| SignOutRequestMessage(Uri, String) |
Initializes a new instance of the SignOutRequestMessage class with the specified base URL and wreply parameter. |
| SignOutRequestMessage(Uri) |
Initializes a new instance of the SignOutRequestMessage class with the specified base URL. |
Properties
| Action |
Gets or sets the wa parameter of the message. (Inherited from WSFederationMessage) |
| BaseUri |
Gets or sets the base URL to which the message applies. (Inherited from FederationMessage) |
| Context |
Gets or sets the wctx parameter of the message. (Inherited from WSFederationMessage) |
| Encoding |
Gets or sets the wencoding parameter of the message. (Inherited from WSFederationMessage) |
| Parameters |
Gets the message parameters as a dictionary. (Inherited from FederationMessage) |
| Reply |
Gets or sets the wreply parameter of the message. |
Methods
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetParameter(String) |
Returns the specified parameter value from the parameters dictionary. (Inherited from FederationMessage) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| RemoveParameter(String) |
Removes a parameter from the parameters dictionary. (Inherited from FederationMessage) |
| SetParameter(String, String) |
Sets the value of a parameter in the parameters dictionary. (Inherited from FederationMessage) |
| SetUriParameter(String, String) |
Sets the value of a parameter in the parameters dictionary. The value must be an absolute URI. (Inherited from FederationMessage) |
| ToString() |
Returns a string that represents the current object. (Inherited from Object) |
| Validate() |
Validates the current instance. |
| Write(TextWriter) |
Writes the message in query string form to the specified text writer. |
| WriteFormPost() |
Serializes the message as a form post and returns the resulting Form together with its Javascript as a string. (Inherited from FederationMessage) |
| WriteQueryString() |
Returns a string representation of the message in query-string format. (Inherited from FederationMessage) |
