Class StatusMessage

Namespace

ComponentSpace.Saml2.Protocols

Assembly

ComponentSpace.Saml2.dll

Represents a status message.

public class StatusMessage

Inheritance

object

StatusMessage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

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.

public StatusMessage()

StatusMessage(string)

Initializes a new instance of the StatusMessage class.

public StatusMessage(string message)

Parameters

message string

The status message.

StatusMessage(XmlElement)

Initializes a new instance of the StatusMessage class from XML.

public StatusMessage(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The status message XML.

Exceptions

SamlSerializationException

Thrown when the XML deserialization fails.

Properties

Message

Gets or sets the status message.

public string Message { get; set; }

Property Value

string

The status message.

Methods

IsValid(XmlElement)

Indicates whether the XML is a status message.

public static bool IsValid(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The XML to test.

Returns

bool

true if the XML is a status message; otherwise false.

ToString()

Returns the status message.

public override string ToString()

Returns

string

The status message.

ToXml(XmlDocument)

Serializes the status message to XML.

public XmlElement ToXml(XmlDocument xmlDocument)

Parameters

xmlDocument XmlDocument

The owning XML document.

Returns

XmlElement

The status message as XML.

Exceptions

SamlSerializationException

Thrown when the XML serialization fails.