Class GlobalProperties
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
A singleton object that provides access to all Global Custom Properties.
|
| Method Attributes | Method Name and Description |
|---|---|
|
set(listName, propertyName, newValue)
Sets the value of the specified Global Custom Property.
|
|
|
setUsingPath(propertyPath, newValue)
Sets the value of the specified Global Custom Property.
|
|
|
value(listName, propertyName, suppressIncrement)
Returns the value of the specified Global Custom Property.
|
|
|
valueUsingPath(propertyPath, suppressIncrement)
Returns the value of the specified Global Custom Property.
|
Accessible through the $globalprop constant.
- Parameters:
- {String} listName
The name of the Global Custom Property List. If the value is null, the name "Default" is used.
- {String} propertyName
The name of the individual Global Custom Property within the list.
- {String} newValue
The new value for the property. It can be null. (The "undefined" value is treated as null.) The value will be converted to a string
- Parameters:
- {String} propertyPath
Specifies which property is to be accessed.
It can be as simple as only a property name, in which case the property will be taken from the default Global Custom Property List (named "Default"), or it can be a "path" that specifies a Global Custom Property List and a property.
A "path" to a property is given by using the name of the Global Custom Property List, a slash, and then the name of the Global Custom Property in that list. For example, the following path:
My list/Some property
Refers to the property named "Some property" in the Global Custom Property List named "My list".
The following paths are equivalent:
Default/Property 6
Property 6
Both of the above paths refer to the property named "Property 6" in the default Global Custom Property List.
- {String} newValue
The new value for the property. It can be null. (The "undefined" value is treated as null.) The value will be converted to a string
- Parameters:
- {String} listName
The name of the Global Custom Property List. If the value is null, the name "Default" is used.
- {String} propertyName
The name of the individual Global Custom Property within the list.
- {boolean} suppressIncrement Optional, Default: false
If the property is a counter, it may be incremented before the value is returned, unless this parameter is true. ("Message-level" counters are incremented only when accessed from within a Message, and then only on the first access within that Message.)
If this parameter is omitted, false is assumed.
- Parameters:
- {String} propertyPath
Specifies which property is to be accessed.
It can be as simple as only a property name, in which case the property will be taken from the default Global Custom Property List (named "Default"), or it can be a "path" that specifies a Global Custom Property List and a property.
A "path" to a property is given by using the name of the Global Custom Property List, a slash, and then the name of the Global Custom Property in that list. For example, the following path:
My list/Some property
Refers to the property named "Some property" in the Global Custom Property List named "My list".
The following paths are equivalent:
Default/Property 6
Property 6
Both of the above paths refer to the property named "Property 6" in the default Global Custom Property List.
- {[boolean=false]} suppressIncrement
If the property is a counter, it may be incremented before the value is returned, unless this parameter is true. ("Message-level" counters are incremented only when accessed from within a Message, and then only on the first access within that Message.)
If this parameter is omitted, false is assumed.