Class AdviceListItem

Represents an advice list item.

Inheritance

System.Object

AdviceListItem

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.Assertions

Assembly: ComponentSpace.Saml2.dll

Syntax

public class AdviceListItem

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.

Declaration

public AdviceListItem()

AdviceListItem(XmlElement)

Initializes a new instance of the AdviceListItem class from XML.

Declaration

public AdviceListItem(XmlElement xmlElement)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlElement	The advice list item XML.

Exceptions

Type	Condition
SamlSerializationException	Thrown when the XML deserialization fails.

Properties

AssertionIDRef

Gets or sets the assertion ID reference.

Declaration

public AssertionIDRef AssertionIDRef { get; set; }

Property Value

Type	Description
AssertionIDRef	The assertion ID reference.

AssertionUriRef

Gets or sets the assertion URI reference.

Declaration

public AssertionUriRef AssertionUriRef { get; set; }

Property Value

Type	Description
AssertionUriRef	The assertion URI reference.

CustomAdvice

Gets or sets the custom advice.

Declaration

public XmlElement CustomAdvice { get; set; }

Property Value

Type	Description
System.Xml.XmlElement	The custom advice.

EncryptedAssertion

Gets or sets the encrypted assertion.

Declaration

public EncryptedAssertion EncryptedAssertion { get; set; }

Property Value

Type	Description
EncryptedAssertion	The encrypted assertion.

SamlAssertion

Gets or sets the SAML assertion.

Declaration

public SamlAssertion SamlAssertion { get; set; }

Property Value

Type	Description
SamlAssertion	The SAML assertion.

Methods

IsValid(XmlElement)

Indicates whether the XML is an advice list item.

Declaration

public static bool IsValid(XmlElement xmlElement)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlElement	The XML to test.

Returns

Type	Description
System.Boolean	true if the XML is an advice list item; otherwise false.

ToXml(XmlDocument)

Serializes the advice list item 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 advice list item as XML.

Exceptions

Type	Condition
SamlSerializationException	Thrown when the XML serialization fails.