string[] portal.activeDeliveryMethods
Returns a string-array with all the delivery methods, that are currently active
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var activeDeliveryMethods = portal.activeDeliveryMethods;
... |
string[] portal.activePaymentMethods
Returns a string-array with all the payment methods, that are currently active
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var activePaymentMethods = portal.activePaymentMethods;
... |
string portal.backendPassword
Returns the backend password of the portal
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var backendPW = portal.backendPassword;
... |
string portal.backendType
Returns the backend type of the portal
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var backendType = portal.backendType;
... |
string portal.backendUrl
Returns the backend url of the portal
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var backendUrl = portal.backendUrl;
... |
string portal.backendUser
Returns the backend user of the portal
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var backendUser= portal.backendUser;
... |
bool portal.ibsActive
Returns whether IBS is enabled for the portal
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
portal.ibsActive # => true / false
... |
string portal.ibsBaseURL
Returns the IBS base URL setting of the portal.
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var url = portal.ibsBaseURL; # => 'https://...'
... |
string portal.ibsUser
Returns the IBS user setting of the portal.
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var userName = portal.ibsUser; # => 'IBS-Username'
... |
string portal.ibsPassword
Returns the IBS password setting of the portal.
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var password = portal.ibsPassword; # => 'IBS-password'
... |
portal portal.clone(name)
Clones the portal and returns the copy as a JSMA portal.
| Info |
|---|
|
This entity is slice aware, which means that to use this facility: - there must be a logged in user in the context of the execution
- this user must be currently within a slice
- this user must have the necessary privileges to edit the entity (IFE → System → Benutzer → Roles → Content-Management)
|
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var clonedPortal = portal.clone() // => portal
... |
Parameter name: (optional)
string portal.cacheKey
Returns a string that you can use in the fragment cache. This string will change whenever the portal or one of its product associations is changed.
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
portal.cacheKey # => "12589387317632578294"
... |
portal.flexAttributes
Returns the flex attributes of the portal
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var portalFlexAttributes = portal.flexAttributes;
... |
string portal.get(key)
Returns the value of key as string or null if no value is set under the key.
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
portal.get(key)
... |
Parameter key:string (required)
The key to be looked up in the flexAttributes of the order.
boolean portal.has(key)
Returns a boolean value depending on whether key is present for a given portal
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
if (portal.has("description") === true)
{
...
}
... |
Parameter key:string (required)
The key to be checked in the flexAttributes of the order.
string portal.host
Returns the host for a given portal
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var host = portal.host;
... |
int portal.id
Returns the id of a given portal
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var portalId = portal.id;
... |
portal.increment(key)
Increments the vale of a given key by one.
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
portal.increment(key)
... |
Parameter key:string (required)
The key to be incremented in the flexAttributes of the portal.
string portal.name
Returns the name of the portal
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var portalName = portal.name;
... |
string portal.path
Returns the path of the portal
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var portalName = portal.path;
... |
object portal.regions
Returns the regions of the portal
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var portalRegions = portal.regions;
... |
portal.remove(key)
Removes the key from the flexAttributes of the portal
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
portal.remove(key);
... |
Parameter key:string (required)
The key to be removed from the flexAttributes of the portal
portal.set(key, value, [options])
Sets the value of a specified key for a given portal
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
portal.set(key, value, [options]);
... |
Parameter key:string (required)
The key to be set in the flexAttributes of the portal.
Parameter value:string (required)
The value to be set for the key
Parameter options:object (optional)
May have a key 'broadcastEvent':bool which determines whether the log message shows up in the websocket log view.
float portal.vat
Returns the vat
Example
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
|
...
var vat = portal.vat;
... |