Constructor
new ScriptSettings()
- Description:
For storing cache data for very long periods of time.
- Source:
Methods
delete(key)
- Description:
Delete a specific key in script properties.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
key |
String |
expire(deleteAll)
- Description:
Removes script settings that have expired.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
deleteAll |
Boolean | true - removes ALL script settings regardless of expiry time. |
get(propertyKey) → {any}
- Description:
Get script property using key. If not found, returns null.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
propertyKey |
String |
Returns:
- Type
- any
put(propertyKey, propertyData, daysToHold)
- Description:
Put data into our PROPERTY cache, which can be held for long periods of time.
- Source:
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
propertyKey |
String | key to finding property data. |
|
propertyData |
any | value. Any object can be saved.. |
|
daysToHold |
Number |
1
|
number of days to hold before item is expired. |
putAll(propertyDataObject, daysToHold)
- Source:
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
propertyDataObject |
Object | ||
daysToHold |
Number |
1
|