Show / Hide Table of Contents

Class LogoutResponse

Represents a logout response.

Inheritance
System.Object
StatusResponseType
LogoutResponse
Inherited Members
StatusResponseType.GetIssuer(XmlElement)
StatusResponseType.GetIssuerName(XmlElement)
StatusResponseType.ID
StatusResponseType.InResponseTo
StatusResponseType.Version
StatusResponseType.IssueInstant
StatusResponseType.Destination
StatusResponseType.Consent
StatusResponseType.Issuer
StatusResponseType.Signature
StatusResponseType.Extensions
StatusResponseType.Status
StatusResponseType.IsSuccess()
StatusResponseType.ToXml(XmlElement)
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: ComponentSpace.SAML2.Protocols
Assembly: ComponentSpace.Saml2.dll
Syntax
public class LogoutResponse : StatusResponseType
Remarks

Refer to the Assertions and Protocol for the OASIS Security Assertion Markup Language (SAML) V2.0 specification for further details.

Constructors

LogoutResponse()

Initializes a new instance of the LogoutResponse class.

Declaration
public LogoutResponse()

LogoutResponse(XmlElement)

Initializes a new instance of the LogoutResponse class from XML.

Declaration
public LogoutResponse(XmlElement xmlElement)
Parameters
Type Name Description
System.Xml.XmlElement xmlElement

The logout response XML.

Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML deserialization fails.

Methods

IsValid(XmlElement)

Indicates whether the XML is a logout response.

Declaration
public static bool IsValid(XmlElement xmlElement)
Parameters
Type Name Description
System.Xml.XmlElement xmlElement

The XML to test.

Returns
Type Description
System.Boolean

true if the XML is a logout response; otherwise false.

ToString()

Converts the logout response to a string.

Declaration
public override string ToString()
Returns
Type Description
System.String

The logout response as a string.

Overrides
System.Object.ToString()

ToXml()

Serializes the logout response to XML.

Declaration
public XmlElement ToXml()
Returns
Type Description
System.Xml.XmlElement

The logout response as XML.

Remarks

An XML document is created.

Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML serialization fails.

ToXml(XmlDocument)

Serializes the logout response to XML.

Declaration
public XmlElement ToXml(XmlDocument xmlDocument)
Parameters
Type Name Description
System.Xml.XmlDocument xmlDocument

The owning XML document.

Returns
Type Description
System.Xml.XmlElement

The logout response as XML.

Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML serialization fails.

In This Article
Back to top Copyright © ComponentSpace Pty Ltd 2004-2022. All rights reserved.