Class Status

Represents a status.

Inheritance

object

Status

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: ComponentSpace.Saml2.Protocols

Assembly: ComponentSpace.Saml2.dll

Syntax

public class Status

Remarks

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

Constructors

Status()

Initializes a new instance of the Status class.

Declaration

public Status()

Status(string, string)

Initializes a new instance of the Status class.

Declaration

public Status(string statusCode, string statusMessage)

Parameters

Type	Name	Description
string	statusCode	The status code.
string	statusMessage	The status message or null if none.

Status(string, string, string)

Initializes a new instance of the Status class.

Declaration

public Status(string statusCode, string subordinateStatusCode, string statusMessage)

Parameters

Type	Name	Description
string	statusCode	The status code.
string	subordinateStatusCode	The subordinate status code or null if none.
string	statusMessage	The status message or null if none.

Status(XmlElement)

Initializes a new instance of the Status class from XML.

Declaration

public Status(XmlElement xmlElement)

Parameters

Type	Name	Description
XmlElement	xmlElement	The status XML.

Exceptions

Type	Condition
SamlSerializationException	Thrown when the XML deserialization fails.

Properties

StatusCode

Gets or sets the status code.

Declaration

public StatusCode StatusCode { get; set; }

Property Value

Type	Description
StatusCode	The status code.

StatusDetail

Gets or sets the status detail.

Declaration

public StatusDetail StatusDetail { get; set; }

Property Value

Type	Description
StatusDetail	The status detail.

StatusMessage

Gets or sets the status message.

Declaration

public StatusMessage StatusMessage { get; set; }

Property Value

Type	Description
StatusMessage	The status message.

Methods

IsValid(XmlElement)

Indicates whether the XML is a status.

Declaration

public static bool IsValid(XmlElement xmlElement)

Parameters

Type	Name	Description
XmlElement	xmlElement	The XML to test.

Returns

Type	Description
bool	true if the XML is status; otherwise false.

ToString()

Returns the status.

Declaration

public override string ToString()

Returns

Type	Description
string	The status

Overrides

object.ToString()

ToXml(XmlDocument)

Serializes the status to XML.

Declaration

public XmlElement ToXml(XmlDocument xmlDocument)

Parameters

Type	Name	Description
XmlDocument	xmlDocument	The owning XML document.

Returns

Type	Description
XmlElement	The status as XML.

Exceptions

Type	Condition
SamlSerializationException	Thrown when the XML serialization fails.