Class StatusMessage

Represents a status message.

Inheritance
System.Object
StatusMessage
Inherited Members
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 StatusMessage
Remarks

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

Constructors

StatusMessage()

Initializes a new instance of the StatusMessage class.

Declaration
public StatusMessage()

StatusMessage(String)

Initializes a new instance of the StatusMessage class.

Declaration
public StatusMessage(string message)
Parameters
Type Name Description
System.String message

The status message.

StatusMessage(XmlElement)

Initializes a new instance of the StatusMessage class from XML.

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

The status message XML.
Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML deserialization fails.

Properties

Message

Gets or sets the status message.

Declaration
public string Message { get; set; }
Property Value
Type Description
System.String

The status message.

Methods

IsValid(XmlElement)

Indicates whether the XML is a status message.

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 status message; otherwise false.

ToString()

Returns the status message.

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

The status message
Overrides
System.Object.ToString()

ToXml(XmlDocument)

Serializes the status message 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 status message as XML.
Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML serialization fails.