This document is provided on an "AS IS" basis without warranties of any kind. Smartsite iXperion class libraries may change in future releases.

Syntax

C# Copy imageCopy Code
                                  public abstract class CmsClient
Visual Basic (Declaration) Copy imageCopy Code
                                  Public MustInherit Class CmsClient

The type exposes the following members.

Protected Constructors

  Name Description
Protected method CmsClient
Initializes a new instance of the CmsClient class.

Public Methods

  Name Description
Public method ClearSession
Clears the session data.
Public method ContainsState Overloaded.
Public method Equals (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetState Overloaded.
Public method GetType (Inherited from Object.)
Public method IsExpired
Determines whether the current session is expired.
Public method IsNewSession
Determines whether the session is initiated from the current request.
Public method RemoveState Overloaded.
Public method SetState Overloaded.
Public method ToString Overloaded.

Protected Methods

  Name Description
Protected method Finalize (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method ValidateState
Validates whether the state request is valid in the current request.

Public Fields

  Name Description
Public field Static member ClientScriptEnabledCookieName
Client scripting enabled cookie. Set by javascript in Scf lib.

Public Properties

  Name Description
Public property Address
Gets the address of the client.
Public property FriendlyUserAgentString
Gets the friendly user agent string.
Public property IsLocal
Returns true if this client is from the localhost.
Public property IsReferrerCms
Returns true if the referrer is the Cms.
Public property MajorVersion
Gets the major version.
Public property MinorVersion
Gets the minor version.
Public property RawUserAgentString
Gets the raw user agent string.
Public property Referrer
Referrer of the current request
Public property Static member SessionCookieExpirationTime
Gets the session cookie expiration time.
Public property Static member SessionCookieName
Gets the session cookie name.
Public property SessionId
Gets the session id.
Public property SupportsSessions
Returns true if sessions are supported.
Public property Type
Gets the user agent type.
Public property VisitorId
Gets the visitor id.

Public Events

  Name Description
Public event ClearClientState
Occurs when the client wants to remove state.
Public event RequestClientState
Occurs when the client requests state data such as cookies and session.
Public event WriteClientState
Occurs when the client wants to write state data such as session and cookies.

See Also

Advanced