2022.2

Key Methods
Name Description
"AddKey" on the
next page
Adds key KeyName to group GroupName. KeyName must not already exist in the specified group. Note that this method only adds a key
name to the group, not a key value. See "AddValue" on page152 for information on how to set a value for a key.
"ListKeys" on
page156
Retrieves the list of all Key names and data types in Group GroupName, stored in a JSONStringObject. You should use JSON.Parse() to
convert the string into an actual JavaScript object. You can then use the for…in construct to list the different properties for that object (i.e.
the keys in the group).
"RemoveKey" on
page157
Removes existing key KeyName from group GroupName. The key to remove must exist in the group, otherwise an error is raised. All val-
ues for the key, in all keysets for the group, are removed. Note that when the Group contains a large number of KeySets, this operation may
take a while.
"RenameKey"
on page160
Renames key oldName to newName in group GroupName. While this operation has no impact on the data stored in that Group, it
does require any plugin and/or script that uses oldName to be modified to refer to newName.
Value Methods
Name Description
"AddValue" on
page152
Creates a new KeySet by assigning Value to the key KeyName in Group GroupName. Note that KeyName must exist in GroupName,
otherwise an error is raised. See "AddKey" on the next page for information on adding a key to a group. Upon successful completion, the
method returns the ID of the newly created KeySet.
"GetValue" on
page154
Performs a lookup in group GroupName and retrieves the first value for key KeyName that matches Condition. The condition is specified
using basic SQL WHERE syntax. The Condition may be left empty in which case the very first value found for the specified KeyName is
returned.
"SetValue" on
page160
Updates multiple keysets in group GroupName by setting the key KeyName to Value for all keysets that match Condition. The condition
is specified using basic SQL WHERE syntax. The Condition may be left empty in which case all keysets in GroupName are updated. Note
that KeyName must exist in GroupName, otherwise an error is raised. The method returns an array of the keyset ID's that were updated (
[1,2] ), or an empty array ([] ) if no keysets were updated.
"SetValueByID"
on page161
Updates KeyName with Value in group GroupName, where the keyset's ID matches the ID parameter. KeyName must exist in
GroupName, otherwise an error is raised. The method returns the ID of the keyset that was updated or -1 if the keyset was not
updated.
Note that this method is functionally equivalent to using "SetValue" on page160 with its Condition parameter set to "ID=ID".
KeySet methods
Name Description
"AddKeySets" on
page151
Inserts a new keyset inside GroupName and assigns values to keys as specified in KeyValues. Every key specified in KeyValues
must exist otherwise an error is raised. However, it is not required to specify all available keys in KeyValues. Only the keys spe-
cified are updated in GroupName while unspecified keys are set to an empty string.
"GetKeySets" on
page153
Retrieves Keys values in GroupName for keysets that match Condition. When an asterisk * is passed as the Keys parameter, all
keys are retrieved. When Condition is left empty, all keysets are retrieved.
"RemoveKeySets" on
page158
Deletes all keysets in GroupName that match Condition. The condition is specified using basic SQL WHERE syntax. Condition
may be left empty, in which case all keysets in GroupName are deleted. The method returns the number of keysets that were
deleted.
"RemoveKeySetByID"
on page158
Deletes the keyset whose ID equals ID from GroupName. Returns 1 if successful, 0 otherwise.
Note that this method is functionally equivalent to using "RemoveKeySets" on page158 with its Condition parameter set to
"ID=ID".
Page 149