Class SessionIndex
Represents a session index.
Inheritance
System.Object
SessionIndex
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
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 |
---|---|---|
System.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 |
---|---|---|
System.Xml.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 |
---|---|
System.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 |
---|---|---|
System.Xml.XmlElement | xmlElement | The XML to test. |
Returns
Type | Description |
---|---|
System.Boolean |
|
ToXml(XmlDocument)
Serializes the session index 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 session index as XML. |
Exceptions
Type | Condition |
---|---|
SamlSerializationException | Thrown when the XML serialization fails. |