Class AdviceListItem

Namespace

ComponentSpace.Saml2.Assertions

Assembly

ComponentSpace.Saml2.dll

Represents an advice list item.

public class AdviceListItem

Inheritance

object

AdviceListItem

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

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

Constructors

AdviceListItem()

Initializes a new instance of the AdviceListItem class.

public AdviceListItem()

AdviceListItem(XmlElement)

Initializes a new instance of the AdviceListItem class from XML.

public AdviceListItem(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The advice list item XML.

Exceptions

SamlSerializationException

Thrown when the XML deserialization fails.

Properties

AssertionIDRef

Gets or sets the assertion ID reference.

public AssertionIDRef AssertionIDRef { get; set; }

Property Value

AssertionIDRef

The assertion ID reference.

AssertionUriRef

Gets or sets the assertion URI reference.

public AssertionUriRef AssertionUriRef { get; set; }

Property Value

AssertionUriRef

The assertion URI reference.

CustomAdvice

Gets or sets the custom advice.

public XmlElement CustomAdvice { get; set; }

Property Value

XmlElement

The custom advice.

EncryptedAssertion

Gets or sets the encrypted assertion.

public EncryptedAssertion EncryptedAssertion { get; set; }

Property Value

EncryptedAssertion

The encrypted assertion.

SamlAssertion

Gets or sets the SAML assertion.

public SamlAssertion SamlAssertion { get; set; }

Property Value

SamlAssertion

The SAML assertion.

Methods

IsValid(XmlElement)

Indicates whether the XML is an advice list item.

public static bool IsValid(XmlElement xmlElement)

Parameters

xmlElement XmlElement

The XML to test.

Returns

bool

true if the XML is an advice list item; otherwise false.

ToXml(XmlDocument)

Serializes the advice list item to XML.

public XmlElement ToXml(XmlDocument xmlDocument)

Parameters

xmlDocument XmlDocument

The owning XML document.

Returns

XmlElement

The advice list item as XML.

Exceptions

SamlSerializationException

Thrown when the XML serialization fails.