Class SourceCodeInfo
Class representing a code (i.e. a "source code") that has been applied to a customer's session. Source codes can qualify customers for different campaigns, promotions, and other site experiences from those that the typical customer sees. Codes are organized into source code groups.
Typically, a code is applied to a customer's session automatically by
Commerce Cloud Digital when a customer accesses a Digital URL with a well
known request parameter in the querystring. A code may also be explicitly
applied to a customer session using the SetSourceCode
pipelet.
| Constant | Description |
|---|---|
| STATUS_ACTIVE: Number = 2 | The literal source-code is found and currently active. |
| STATUS_INACTIVE: Number = 1 | The literal source-code is found but not active. |
| STATUS_INVALID: Number = 0 | The literal source-code is not found in the system. |
| Property | Description |
|---|---|
code: String (read-only) | The literal source-code. |
group: SourceCodeGroup (read-only) | The associated source-code group. |
redirect: URLRedirect (read-only) | Retrieves the redirect information from the last processed SourceCodeGroup (active or inactive). |
status: Number (read-only) | The status of the source-code. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| getCode() | The literal source-code. |
| getGroup() | The associated source-code group. |
| getRedirect() | Retrieves the redirect information from the last processed SourceCodeGroup (active or inactive). |
| getStatus() | The status of the source-code. |
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
- STATUS_ACTIVE: Number = 2
The literal source-code is found and currently active.
- STATUS_INACTIVE: Number = 1
The literal source-code is found but not active.
- STATUS_INVALID: Number = 0
The literal source-code is not found in the system.
- code: String
(read-only) The literal source-code.
- group: SourceCodeGroup
(read-only) The associated source-code group.
- redirect: URLRedirect
(read-only) Retrieves the redirect information from the last processed SourceCodeGroup (active or inactive). If none exists, then the redirect information is retrieved from the source-code preferences, based on the active/inactive status of the SourceCodeGroup. The redirect information is then resolved to the output URL. If the redirect information cannot be resolved to a URL, or there is an error retrieving the preferences, then null is returned.
- status: Number
(read-only) The status of the source-code. One of the following: STATUS_INVALID - The source code is not found in the system. STATUS_INACTIVE - The source code is found but not active. STATUS_INACTIVE - The source code is found and active.
- getCode(): String
The literal source-code.
Returns:
- the source-code.
- getGroup(): SourceCodeGroup
The associated source-code group.
Returns:
- the source-code group.
- getRedirect(): URLRedirect
Retrieves the redirect information from the last processed SourceCodeGroup (active or inactive). If none exists, then the redirect information is retrieved from the source-code preferences, based on the active/inactive status of the SourceCodeGroup. The redirect information is then resolved to the output URL. If the redirect information cannot be resolved to a URL, or there is an error retrieving the preferences, then null is returned.
Returns:
- URLRedirect containing the location and status code, null in case of no redirect was found
- getStatus(): Number
The status of the source-code. One of the following: STATUS_INVALID - The source code is not found in the system. STATUS_INACTIVE - The source code is found but not active. STATUS_INACTIVE - The source code is found and active.
Returns:
- the status.