Design Pattern Framework 3.5
LoginResponse Class
Patterns-In-Action! Application ► ActionService.Messages ► LoginResponse
Represents a login response message to the client.
Declaration Syntax| C# | Visual Basic |
public class LoginResponse : ResponseBase
Public Class LoginResponse _ Inherits ResponseBase
Members| All Members | Constructors | Methods | Fields | ||
|
|
|
|
|||
| Icon | Member | Description |
|---|---|---|
|
LoginResponse()()() |
Initializes a new instance of the LoginResponse class
|
|
Acknowledge |
A flag indicating success or failure of the web service response back to the
client. Default is success. Ebay.com uses this model.
(Inherited from ResponseBase.) |
|
|
Build |
Build number of currently executing web service. Used as an indicator
to client whether certain code fixes are included or not.
Ebay.com uses this in their API.
(Inherited from ResponseBase.) |
|
|
CorrelationId |
CorrelationId mostly returns the RequestId back to client.
(Inherited from ResponseBase.) |
|
|
Equals(Object) | (Inherited from Object.) |
|
Finalize()()() |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
|
|
GetHashCode()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) |
|
|
GetType()()() |
Gets the Type of the current instance.
(Inherited from Object.) |
|
|
MemberwiseClone()()() |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
|
|
Message |
Message back to client. Mostly used when a web service failure occurs.
(Inherited from ResponseBase.) |
|
|
ReservationExpires |
Date when reservation number expires.
(Inherited from ResponseBase.) |
|
|
ReservationId |
Reservation number issued by the web service. Used in long running requests.
Also sometimes referred to as Correlation Id. This number is a way for both the client
and web service to keep track of long running requests (for example, a request
to make a reservation for a airplane flight).
(Inherited from ResponseBase.) |
|
|
RowsAffected |
Number of rows affected by "Create", "Update", or "Delete" action.
(Inherited from ResponseBase.) |
|
|
SessionId |
Session identifier. Useful when sessions are maintained using
SOAP headers (rather than cookies). Not used in this sample application.
SalesForce.com uses this in their SOAP header model.
|
|
|
ToString()()() | (Inherited from Object.) |
|
|
Uri |
Uri to which client should redirect following successful login.
This would be necessary if authentication is handled centrally
and other services are distributed accross multiple servers.
Not used in this sample application.
SalesForce.com uses this in their API.
|
|
|
Version |
Version number (in major.minor format) of currently executing web service.
Used to offer a level of understanding (related to compatibility issues) between
the client and the web service as the web services evolve over time.
Ebay.com uses this in their API.
(Inherited from ResponseBase.) |
Inheritance Hierarchy| Object | ||
|
ResponseBase | |
|
|
LoginResponse | |