| Session Class |
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 HierarchyNamespace: Apptus.ESales.Connector
Assembly: Apptus.Esales.ConnectorApi (in Apptus.Esales.ConnectorApi.dll) Version: 4.5.0
Syntaxpublic class Session : LRUK, TNode<string>
The Session type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CustomerKey |
Returns the session's customer_key, or null if no customer_key has been set.
|
| Key |
The key of this session.
(Overrides LRUString, SessionKey.) |
| Market |
Returns the session's market, or null if no market has been set.
|
 | Timestamp |
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).
|
Methods| Name | Description | |
|---|---|---|
 | DynamicPage |
Creates a dynamic page with the specified name.
|
| End |
End the session
|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| NotifyAddingToCart |
Sends a notification to the eSales service, about a product being
added to the shopping cart by a user in the session.
|
| NotifyClick |
Sends a notification to the eSales service, about a click being made by the user in a session.
|
| NotifyFavoriteAddition |
Sends a notification to the eSales service, about a product being added to favorites.
|
| NotifyFavoriteRemoval |
Sends a notification to the eSales service, about a product being removed from favorites.
|
| NotifyNonEsalesAddingToCart |
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.
|
| NotifyNonEsalesClick |
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.
|
| NotifyPayment(String) | Obsolete.
Sends a notification to the eSales service, about products being
paid by a user in the session.
|
| NotifyPayment(String) | Obsolete.
Sends a notification to the eSales service, about products being
paid by a user in the session.
|
| NotifyPayment(Order) |
Sends a notification to the eSales service, about products and
variants being paid by a user in the session.
|
| NotifyPayment(SKUList) | Obsolete.
Sends a notification to the eSales service, about products and variants being
paid by a user in the session.
|
| NotifyPayment(Double, SKUList) | Obsolete.
Sends a notification to the eSales service, about products and variants being
paid by a user in the session.
|
| NotifyPayment(Double, String) | Obsolete.
Sends a notification to the eSales service, about products being
paid by a user in the session.
|
| NotifyPayment(Double, String) | Obsolete.
Sends a notification to the eSales service, about products being
paid by a user in the session.
|
| NotifyProperty |
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.
|
| NotifyRating |
Sends a notification to the eSales service, about a product being rated.
|
| Panel |
Returns a panel with the specified path.
|
| Release |
Release this session. This implementation does nothing by default, override to change behaviour.
(Overrides LRUString, SessionRelease.) |
| ToString | (Inherited from Object.) |
See Also