FederationMessage Class

.NET Framework (current version)
 

Defines the base class from which all federation message classes derive.

Namespace:   System.IdentityModel.Services
Assembly:  System.IdentityModel.Services (in System.IdentityModel.Services.dll)

System::Object
  System.IdentityModel.Services::FederationMessage
    System.IdentityModel.Services::WSFederationMessage

public ref class FederationMessage abstract 

NameDescription
System_CAPS_protmethodFederationMessage(Uri^)

Called from constructors in derived classes to initialize the FederationMessage class.

NameDescription
System_CAPS_pubpropertyBaseUri

Gets or sets the base URL to which the message applies.

System_CAPS_pubpropertyParameters

Gets the message parameters as a dictionary.

NameDescription
System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticGetBaseUrl(Uri^)

Helper method that extracts the base URL from the specified URI.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetParameter(String^)

Returns the specified parameter value from the parameters dictionary.

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticParseQueryString(Uri^)

Helper method that parses the query string in the specified URI into a NameValueCollection.

System_CAPS_pubmethodRemoveParameter(String^)

Removes a parameter from the parameters dictionary.

System_CAPS_pubmethodSetParameter(String^, String^)

Sets the value of a parameter in the parameters dictionary.

System_CAPS_pubmethodSetUriParameter(String^, String^)

Sets the value of a parameter in the parameters dictionary. The value must be an absolute URI.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_protmethodValidate()

Validates the message.

System_CAPS_pubmethodWrite(TextWriter^)

When overridden in a derived class, writes the message to the output stream.

System_CAPS_pubmethodWriteFormPost()

Serializes the message as a form post and returns the resulting Form together with its Javascript as a string.

System_CAPS_pubmethodWriteQueryString()

Returns a string representation of the message in query-string format.

Notes to Inheritors:

At a minimum, you must override the P:System.IdentityModel.Services.FederationMessage.ProviderIdentifier property and the Write method in derived classes.

.NET Framework
Available since 4.5

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: