Session ClassA Sandcastle Documented Class Library

A session where information is exchanged with an eSales service.

Use the notification methods to notify the eSales service about client-side activities. These notification will be used to improve results from eSales with the use of machine learning algorithms, and for statistical reports.
A tutorial section describing the procedure for notifying client-side activities can be found in the tutorial section Notifying Customer Actions on Apptus Zone (http://zone.apptus.com).

Use the Panel(String) method to get a panel object, from which you may retrieve content from the eSales service.

You may (but need not) call the End method once the session is over. This will allow the eSales service to include the information in statistical reports. If you don't call End the session will end automatically on the eSales server after two hours.

Inheritance Hierarchy

SystemObject
  Apptus.Util.CollectionLRUK, TNodeString
    Apptus.ESales.ConnectorSession

Namespace:  Apptus.ESales.Connector
Assembly:  Apptus.Esales.ConnectorApi (in Apptus.Esales.ConnectorApi.dll) Version: 4.0.0
Syntax

C#
public class Session : LRUK, TNode<string>

The Session type exposes the following members.

Properties

  NameDescription
Public propertyCustomerKey
Returns the session's customer_key, or null if no customer_key has been set.
Public propertyKey
The key of this session.
(Overrides LRUString, SessionKey.)
Public propertyMarket
Returns the session's market, or null if no market has been set.
Protected propertyTimestamp
The timestamp reported in future notifications and panel requests to the eSales server. This is -1 by default, meaning no time is specified (and hence, the current time on the eSales server will be used as timestamp).
Top
Methods

  NameDescription
Public methodDynamicPage
Creates a dynamic page with the specified name.
Public methodEnd
End the session
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodNotifyAddingToCart
Sends a notification to the eSales service, about a product being added to the shopping cart by a user in the session.
Public methodNotifyClick
Sends a notification to the eSales service, about a click being made by the user in a session.
Public methodNotifyFavoriteAddition
Sends a notification to the eSales service, about a product being added to favorites.
Public methodNotifyFavoriteRemoval
Sends a notification to the eSales service, about a product being removed from favorites.
Public methodNotifyNonEsalesAddingToCart
Sends a notification to the eSales service, about a non-eSales product add to cart being made by the user in a session. This method should only be used on non-eSales rendered products where no ticket is available.
Public methodNotifyNonEsalesClick
Sends a notification to the eSales service, about a non-eSales product click being made by the user in a session. This method should only be used on non-eSales rendered products where no ticket is available.
Public methodNotifyPayment(String) Obsolete.
Sends a notification to the eSales service, about products being paid by a user in the session.
Public methodNotifyPayment(String) Obsolete.
Sends a notification to the eSales service, about products being paid by a user in the session.
Public methodNotifyPayment(Order)
Sends a notification to the eSales service, about products and variants being paid by a user in the session.
Public methodNotifyPayment(SKUList) Obsolete.
Sends a notification to the eSales service, about products and variants being paid by a user in the session.
Public methodNotifyPayment(Double, SKUList) Obsolete.
Sends a notification to the eSales service, about products and variants being paid by a user in the session.
Public methodNotifyPayment(Double, String) Obsolete.
Sends a notification to the eSales service, about products being paid by a user in the session.
Public methodNotifyPayment(Double, String) Obsolete.
Sends a notification to the eSales service, about products being paid by a user in the session.
Public methodNotifyProperty
Sends a notification to the eSales service, about a session property being set. If the property name is market or customer_key, then the market or customer_key for this session object will be changed accordingly.
Public methodNotifyRating
Sends a notification to the eSales service, about a product being rated.
Public methodPanel
Returns a panel with the specified path.
Public methodRelease
Release this session. This implementation does nothing by default, override to change behaviour.
(Overrides LRUString, SessionRelease.)
Public methodToString (Inherited from Object.)
Top
See Also

Reference