Class SessionIndex

Represents a session index.

Inheritance
object
SessionIndex
Inherited Members
Namespace: ComponentSpace.SAML2.Protocols
Assembly: ComponentSpace.Saml2.dll
Syntax
public class SessionIndex
Remarks

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

Constructors

SessionIndex()

Initializes a new instance of the SessionIndex class.

Declaration
public SessionIndex()

SessionIndex(string)

Initializes a new instance of the SessionIndex class.

Declaration
public SessionIndex(string index)
Parameters
Type Name Description
string index

The session index.

SessionIndex(XmlElement)

Initializes a new instance of the SessionIndex class from XML.

Declaration
public SessionIndex(XmlElement xmlElement)
Parameters
Type Name Description
XmlElement xmlElement

The session index XML.
Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML deserialization fails.

Properties

Index

Gets or sets the session index.

Declaration
public string Index { get; set; }
Property Value
Type Description
string

The session index.

Methods

IsValid(XmlElement)

Indicates whether the XML is a session index.

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 a session index; otherwise false.

ToString()

Returns the session index.

Declaration
public override string ToString()
Returns
Type Description
string

The session index
Overrides

ToXml(XmlDocument)

Serializes the session index to XML.

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

The owning XML document.
Returns
Type Description
XmlElement

The session index as XML.
Exceptions
Type Condition
SAMLSerializationException

Thrown when the XML serialization fails.