Represents a session in B2C Commerce. The session has some well-defined attributes like the current authenticated customer or the click stream, but also supports storing custom values in the session.
The Digital session handling works in the following way:
Certain rules apply for what and how much data can be stored in a session:
| Property | Description |
|---|---|
clickStream: ClickStream (read-only) | Returns the current click stream if this is an HTTP session, null otherwise. |
| currency: Currency | Get the currency associated with the current session. |
custom: CustomAttributes (read-only) | Returns the session’s custom attributes. |
customer: Customer (read-only) | Returns the customer associated with this storefront session. |
customerAuthenticated: Boolean (read-only) | Identifies whether the customer associated with this session is authenticated. |
customerExternallyAuthenticated: Boolean (read-only) | Identifies whether the customer associated with this session is externally authenticated. |
forms: Forms (read-only) | Returns the forms object that provides access to all current forms of a customer in the session. |
lastReceivedSourceCodeInfo: SourceCodeInfo (read-only) | Returns information on the last source code handled by the session. |
privacy: CustomAttributes (read-only) | Returns the session’s custom privacy attributes. |
sessionID: String (read-only) | Returns the unique session id. |
sourceCodeInfo: SourceCodeInfo (read-only) | Returns information on the session’s active source-code. |
| trackingAllowed: Boolean | Returns whether the tracking allowed flag is set in the session. |
userAuthenticated: Boolean (read-only) | Identifies whether the agent user associated with this session is authenticated. |
userName: String (read-only) | Returns the current agent user name associated with this session. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| generateGuestSessionSignature() | Generates a new guest session signature. |
| generateRegisteredSessionSignature() | Generates a new registered session signature. |
| getClickStream() | Returns the current click stream if this is an HTTP session, null otherwise. |
| getCurrency() | Get the currency associated with the current session. |
| getCustom() | Returns the session’s custom attributes. |
| getCustomer() | Returns the customer associated with this storefront session. |
| getForms() | Returns the forms object that provides access to all current forms of a customer in the session. |
| getLastReceivedSourceCodeInfo() | Returns information on the last source code handled by the session. |
| getPrivacy() | Returns the session’s custom privacy attributes. |
| getSessionID() | Returns the unique session id. |
| getSourceCodeInfo() | Returns information on the session’s active source-code. |
| getUserName() | Returns the current agent user name associated with this session. |
| isCustomerAuthenticated() | Identifies whether the customer associated with this session is authenticated. |
| isCustomerExternallyAuthenticated() | Identifies whether the customer associated with this session is externally authenticated. |
| isTrackingAllowed() | Returns whether the tracking allowed flag is set in the session. |
| isUserAuthenticated() | Identifies whether the agent user associated with this session is authenticated. |
| setCurrency(Currency) | Sets the session currency. |
| setSourceCode(String) | Applies the specified source code to the current session and basket. |
| setTrackingAllowed(Boolean) | Sets the tracking allowed flag for the session. |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
(read-only)Returns the current click stream if this is an HTTP session, null otherwise.
Get the currency associated with the current session. The session currency is established at session construction time and is typically equal to the site default currency. In the case of a multi-currency site, the session currency may be different than the site default currency.
(read-only)Returns the session's custom attributes. The attributes are stored for the lifetime of the session and are not cleared when the customer logs out.
(read-only)Returns the customer associated with this storefront session. The method
always returns null if called for a non-storefront session
(e.g., within a job or within Business Manager). For a storefront
session, the method always returns a customer. The returned customer
may be anonymous if the customer could not be identified via the
customer cookie.
(read-only)Identifies whether the customer associated with this session is authenticated. This call is equivalent to customer.isAuthenticated().
(read-only)Identifies whether the customer associated with this session is externally authenticated.
(read-only)Returns the forms object that provides access to all current forms of a customer in the session.
(read-only)Returns information on the last source code handled by the session. This may or may not be the session's active source code, e.g., the last received source code was inactive and therefore was not set as the session's active source code.
(read-only)Returns the session's custom privacy attributes. The attributes are stored for the lifetime of the session and are automatically cleared when the customer logs out.
(read-only)Returns the unique session id. This can safely be used as an identifier against external systems.
(read-only)Returns information on the session's active source-code.
Returns whether the tracking allowed flag is set in the session. The value for newly created sessions defaults to the Site Preference "TrackingAllowed" unless a cookie named "dw_dnt" is found in which case the cookie value takes precedence.
(read-only)Identifies whether the agent user associated with this session is authenticated.
(read-only)Returns the current agent user name associated with this session.
Note: this class allows access to sensitive security-related data. Pay special attention to PCI DSS v3 requirements 2, 4, and 12.
Generates a new guest session signature.
This is intended for guest authentication with the Shopper Login and API Access Service (SLAS).
Returns:
Generates a new registered session signature.
This is intended for use with registered session-bridge call of Shopper Login and API Access Service (SLAS).
Returns:
Returns the current click stream if this is an HTTP session, null otherwise.
Returns:
Get the currency associated with the current session. The session currency is established at session construction time and is typically equal to the site default currency. In the case of a multi-currency site, the session currency may be different than the site default currency.
Returns:
Returns the session's custom attributes. The attributes are stored for the lifetime of the session and are not cleared when the customer logs out.
Returns:
Returns the customer associated with this storefront session. The method
always returns null if called for a non-storefront session
(e.g., within a job or within Business Manager). For a storefront
session, the method always returns a customer. The returned customer
may be anonymous if the customer could not be identified via the
customer cookie.
Returns:
Returns the forms object that provides access to all current forms of a customer in the session.
Returns:
Returns information on the last source code handled by the session. This may or may not be the session's active source code, e.g., the last received source code was inactive and therefore was not set as the session's active source code.
Returns:
Returns the session's custom privacy attributes. The attributes are stored for the lifetime of the session and are automatically cleared when the customer logs out.
Returns:
Returns the unique session id. This can safely be used as an identifier against external systems.
Returns:
Returns information on the session's active source-code.
Returns:
Returns the current agent user name associated with this session.
Note: this class allows access to sensitive security-related data. Pay special attention to PCI DSS v3 requirements 2, 4, and 12.
Returns:
Identifies whether the customer associated with this session is authenticated. This call is equivalent to customer.isAuthenticated().
Returns:
Identifies whether the customer associated with this session is externally authenticated.
Returns:
Returns whether the tracking allowed flag is set in the session. The value for newly created sessions defaults to the Site Preference "TrackingAllowed" unless a cookie named "dw_dnt" is found in which case the cookie value takes precedence.
Returns:
Identifies whether the agent user associated with this session is authenticated.
Returns:
Sets the session currency.
Parameters:
Applies the specified source code to the current session and basket. This API processes the source code exactly as if it were supplied on the URL query string, with the additional benefit of returning error information. If no input parameter is passed, then the active source code in the session and basket is removed. If a basket exists, and the modification fails, then the session is not written to either. This method may open and commit a transaction, if none is currently active.
Parameters:
Returns:
Sets the tracking allowed flag for the session. If tracking is not allowed, multiple services depending on tracking will be restricted or disabled: Predictive Intelligence recommendations, Active Data, Analytics of the customer behavior in the storefront. Additionally, collected clicks in the session click stream will be cleared. Setting this property to either value also results in setting a session-scoped cookie named "dw_dnt" (1=DoNotTrack; 0=Track)
Parameters:
j