Global Properties ($globalprop) - CloudLink

Global Properties ($globalprop)

by

Community Manager

on - last edited on

Provides access to all Global Custom Properties.
Global Property Methods The global property methods return the value of the specified Global Custom Property.
value Method The `value`method returns a value using the following parameters: The "`listName`" parameter specifies the name of the Global Custom Property List. If the value is null, the name "`Default`" is used. The "`propertyName`" parameter specifies the name of the individual Global Custom Property within the list. If the property is a counter, it may be incremented before the value is returned, unless the "`suppressIncrement`" 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 the "`suppressIncrement`" parameter is omitted, "`false`" is assumed.	`string value(string listName, string propertyName, boolean suppressIncrement)`
valueUsingPath Method The `valueUsingPath` method gets the value of the specified Global Custom Property.	`string valueUsingPath(string propertyPath, boolean suppressIncrement)`
The "`propertyPath`" parameter 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.
Using Paths 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 refers to the property named "`Some property`" in the Global Custom Property List named "`My list`".	`My list/Some property`
The following paths are equivalent. Both refer to the property named "`Property 6`" in the default Global Custom Property List.	`Default/Property 6 Property 6`
Using Counters If the property is a counter, it may be incremented before the value is returned, unless the "`suppressIncrement`" 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 the "`suppressIncrement`" parameter is omitted, "`false`" is assumed.
set Method The `set` method puts a new value into the specified Global Custom Property.	`string set(string listName, string propertyName, var newValue)`
The "`listName`" parameter specifies the name of the Global Custom Property List. If the value is null, the name "`Default`" is used. The "`propertyName`" parameter specifies the name of the individual Global Custom Property within the list. The "`newValue`" parameter is 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.
setUsingPath Method The `setUsingPath` method puts a new value into the specified Global Custom Property path.	`string setUsingPath(string propertyPath, var newValue)`
The "`propertyPath`" parameter 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. See Using Paths above. The "`newValue`" parameter is 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.